From b03b54ec3cdeb4f0e2894e10adfe17ce4183b50c Mon Sep 17 00:00:00 2001 From: Mainak Kundu Date: Tue, 19 Apr 2022 17:38:28 +0530 Subject: [PATCH] Remove the named-object style access from TUI API --- codegen/tuigen.py | 41 +- src/ansys/fluent/core/meshing/tui.py | 3179 +- src/ansys/fluent/core/meta.py | 113 - .../fluent/core/services/datamodel_tui.py | 140 +- src/ansys/fluent/core/solver/tui.py | 68269 +++++++--------- 5 files changed, 29776 insertions(+), 41966 deletions(-) diff --git a/codegen/tuigen.py b/codegen/tuigen.py index abaf5585c8e9..0fd0afa19cf5 100644 --- a/codegen/tuigen.py +++ b/codegen/tuigen.py @@ -89,12 +89,6 @@ def get_child_names(self) -> Iterable[str]: def get_doc_string(self) -> str: return self._menu.get_doc_string(True) - def is_extended_tui(self) -> bool: - return self._menu.is_extended_tui(True) - - def is_container(self) -> bool: - return self._menu.is_container(True) - class _TUIMenu: """Class representing Fluent's TUI menu.""" @@ -109,8 +103,6 @@ def __init__(self, path: str): del _XML_HELPSTRINGS[tui_path] self.children = {} self.is_command = False - self.is_extended_tui = False - self.is_container = False def get_command_path(self, command: str) -> str: return convert_path_to_grpc_path(self.path + [(command, None)]) @@ -136,8 +128,6 @@ def _populate_menu(self, menu: _TUIMenu): menugen = _TUIMenuGenerator(menu.path, self._service) if not menu.doc: menu.doc = menugen.get_doc_string() - menu.is_extended_tui = menugen.is_extended_tui() - menu.is_container = menugen.is_container() child_names = menugen.get_child_names() if child_names: for child_name in child_names: @@ -145,7 +135,7 @@ def _populate_menu(self, menu: _TUIMenu): child_menu = _TUIMenu(menu.path + [(child_name, None)]) menu.children[child_menu.name] = child_menu self._populate_menu(child_menu) - elif not menu.is_extended_tui: + else: menu.is_command = True def _write_code_to_tui_file(self, code: str, indent: int = 0): @@ -153,23 +143,13 @@ def _write_code_to_tui_file(self, code: str, indent: int = 0): def _write_menu_to_tui_file(self, menu: _TUIMenu, indent: int = 0): self._write_code_to_tui_file("\n") - if menu.is_container: - self._write_code_to_tui_file( - f"class {menu.name}(metaclass=PyNamedObjectMeta):\n", - indent, - ) - else: - self._write_code_to_tui_file( - f"class {menu.name}(metaclass=PyMenuMeta):\n", indent - ) + self._write_code_to_tui_file(f"class {menu.name}(TUIMenu):\n", indent) indent += 1 self._write_code_to_tui_file('"""\n', indent) doc_lines = menu.doc.splitlines() for line in doc_lines: self._write_code_to_tui_file(f"{line}\n", indent) self._write_code_to_tui_file('"""\n', indent) - if menu.is_extended_tui: - self._write_code_to_tui_file("is_extended_tui = True\n", indent) self._write_code_to_tui_file( "def __init__(self, path, service):\n", indent ) @@ -177,20 +157,15 @@ def _write_menu_to_tui_file(self, menu: _TUIMenu, indent: int = 0): self._write_code_to_tui_file("self.path = path\n", indent) self._write_code_to_tui_file("self.service = service\n", indent) for k, v in menu.children.items(): - if v.is_command: - continue - elif v.is_container: - self._write_code_to_tui_file( - f"self.{k} = self.__class__.{k}" - f'(path + [("{v.tui_name}", None)], None, service)\n', - indent, - ) - else: + if not v.is_command: self._write_code_to_tui_file( f"self.{k} = self.__class__.{k}" f'(path + [("{v.tui_name}", None)], service)\n', indent, ) + self._write_code_to_tui_file( + "super().__init__(path, service)\n", indent + ) indent -= 1 command_names = [ @@ -236,10 +211,8 @@ def generate(self) -> None: "# This is an auto-generated file. DO NOT EDIT!\n" "#\n" "# pylint: disable=line-too-long\n\n" - "from ansys.fluent.core.meta " - "import PyMenuMeta, PyNamedObjectMeta\n" "from ansys.fluent.core.services.datamodel_tui " - "import PyMenu\n\n\n" + "import PyMenu, TUIMenu\n\n\n" ) self._main_menu.name = "main_menu" self._write_menu_to_tui_file(self._main_menu) diff --git a/src/ansys/fluent/core/meshing/tui.py b/src/ansys/fluent/core/meshing/tui.py index 702451771605..dec039dc2f38 100644 --- a/src/ansys/fluent/core/meshing/tui.py +++ b/src/ansys/fluent/core/meshing/tui.py @@ -4,11 +4,11 @@ # # pylint: disable=line-too-long -from ansys.fluent.core.meta import PyMenuMeta, PyNamedObjectMeta -from ansys.fluent.core.services.datamodel_tui import PyMenu +from ansys.fluent.core.services.datamodel_tui import PyMenu, TUIMenu -class main_menu(metaclass=PyMenuMeta): + +class main_menu(TUIMenu): """ Fluent meshing main menu. """ @@ -30,6 +30,7 @@ def __init__(self, path, service): self.parallel = self.__class__.parallel(path + [("parallel", None)], service) self.openmp_controls = self.__class__.openmp_controls(path + [("openmp_controls", None)], service) self.reference_frames = self.__class__.reference_frames(path + [("reference_frames", None)], service) + super().__init__(path, service) def beta_feature_access(self, *args, **kwargs): """ Enable access to beta features in the interface. @@ -56,7 +57,7 @@ def print_license_usage(self, *args, **kwargs): """ return PyMenu(self.service, "/print_license_usage").execute(*args, **kwargs) - class file(metaclass=PyMenuMeta): + class file(TUIMenu): """ Enter the file menu. """ @@ -67,6 +68,7 @@ def __init__(self, path, service): self.import_ = self.__class__.import_(path + [("import", None)], service) self.checkpoint = self.__class__.checkpoint(path + [("checkpoint", None)], service) self.project = self.__class__.project(path + [("project[beta]", None)], service) + super().__init__(path, service) def append_mesh(self, *args, **kwargs): """ Enables you to append the mesh files. This command is available only after a mesh file has been read in. @@ -245,13 +247,14 @@ def set_tui_version(self, *args, **kwargs): """ return PyMenu(self.service, "/file/set_tui_version").execute(*args, **kwargs) - class export(metaclass=PyMenuMeta): + class export(TUIMenu): """ Exports case and data information. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def ansys(self, *args, **kwargs): """ Write a Ansys mesh file. @@ -278,7 +281,7 @@ def stl(self, *args, **kwargs): """ return PyMenu(self.service, "/file/export/stl").execute(*args, **kwargs) - class import_(metaclass=PyMenuMeta): + class import_(TUIMenu): """ Enables you to import mesh information generated by some CAD packages (Ansys, I-deas, NASTRAN, PATRAN, and HYPERMESH), as well as mesh information in the CGNS (CFD general notation system) format. """ @@ -286,6 +289,7 @@ def __init__(self, path, service): self.path = path self.service = service self.cad_options = self.__class__.cad_options(path + [("cad_options", None)], service) + super().__init__(path, service) def ansys_surf_mesh(self, *args, **kwargs): """ Enables you to read a Ansys surface mesh file. @@ -402,13 +406,14 @@ def reimport_last_with_cfd_surface_mesh(self, *args, **kwargs): """ return PyMenu(self.service, "/file/import/reimport_last_with_cfd_surface_mesh").execute(*args, **kwargs) - class cad_options(metaclass=PyMenuMeta): + class cad_options(TUIMenu): """ Contains additional options for importing CAD files. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def read_all_cad_in_subdirectories(self, *args, **kwargs): """ When enabled, all files in the specified directory as well as in its subdirectories will be imported. This option is disabled by default. @@ -581,13 +586,14 @@ def create_label_per_body_during_cad_faceting(self, *args, **kwargs): """ return PyMenu(self.service, "/file/import/cad_options/create_label_per_body_during_cad_faceting").execute(*args, **kwargs) - class checkpoint(metaclass=PyMenuMeta): + class checkpoint(TUIMenu): """ Checkpoint stores the mesh in the memory instead of writing it to a file. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def write_checkpoint(self, *args, **kwargs): """ Write checkpoint. @@ -609,13 +615,14 @@ def delete_checkpoint(self, *args, **kwargs): """ return PyMenu(self.service, "/file/checkpoint/delete_checkpoint").execute(*args, **kwargs) - class project(metaclass=PyMenuMeta): + class project(TUIMenu): """ Enter to create new project, open project, save and archive project. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def new(self, *args, **kwargs): """ Create New Project. @@ -647,7 +654,7 @@ def archive(self, *args, **kwargs): """ return PyMenu(self.service, "/file/project[beta]/archive").execute(*args, **kwargs) - class boundary(metaclass=PyMenuMeta): + class boundary(TUIMenu): """ Enter the boundary menu. """ @@ -663,6 +670,7 @@ def __init__(self, path, service): self.manage = self.__class__.manage(path + [("manage", None)], service) self.shell_boundary_layer = self.__class__.shell_boundary_layer(path + [("shell_boundary_layer", None)], service) self.boundary_conditions = self.__class__.boundary_conditions(path + [("boundary_conditions", None)], service) + super().__init__(path, service) def auto_slit_faces(self, *args, **kwargs): """ Slits all boundary faces with cells on both sides (these cells must be in the same cell zone). A displacement can be specified to provide thickness to the boundary. @@ -925,13 +933,14 @@ def fix_mconnected_edges(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/fix_mconnected_edges").execute(*args, **kwargs) - class feature(metaclass=PyMenuMeta): + class feature(TUIMenu): """ Enables you to create and modify features. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def copy_edge_zones(self, *args, **kwargs): """ Copies the specified edge zone(s) to new edge zone(s). @@ -1023,7 +1032,7 @@ def separate_delete_small_edges(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/feature/separate_delete_small_edges").execute(*args, **kwargs) - class modify(metaclass=PyMenuMeta): + class modify(TUIMenu): """ Contains commands used to modify the boundary mesh. """ @@ -1031,6 +1040,7 @@ def __init__(self, path, service): self.path = path self.service = service self.patch_options = self.__class__.patch_options(path + [("patch_options", None)], service) + super().__init__(path, service) def analyze_bnd_connectvty(self, *args, **kwargs): """ Finds and marks free edges and nodes and multiply-connected edges and nodes. This process is necessary if the boundary mesh has been changed with Scheme functions. @@ -1192,13 +1202,14 @@ def select_visible_entities(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/modify/select_visible_entities").execute(*args, **kwargs) - class patch_options(metaclass=PyMenuMeta): + class patch_options(TUIMenu): """ Settings for Patching zone(s) by filling holes. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def remesh(self, *args, **kwargs): """ Remeshes newly added patches. @@ -1210,7 +1221,7 @@ def separate(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/modify/patch_options/separate").execute(*args, **kwargs) - class refine(metaclass=PyMenuMeta): + class refine(TUIMenu): """ Discusses the commands used to refine the boundary mesh. """ @@ -1218,6 +1229,7 @@ def __init__(self, path, service): self.path = path self.service = service self.local_regions = self.__class__.local_regions(path + [("local_regions", None)], service) + super().__init__(path, service) def auto_refine(self, *args, **kwargs): """ Automatically refines a face zone based on proximity. The original face zone is treated as a background mesh. Faces are refined by multiple face splitting passes, so that no face is in close proximity to any face in the current domain. @@ -1249,13 +1261,14 @@ def refine(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/refine/refine").execute(*args, **kwargs) - class local_regions(metaclass=PyMenuMeta): + class local_regions(TUIMenu): """ Enters the local refinement menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def define(self, *args, **kwargs): """ Defines the refinement region according to the specified parameters. @@ -1277,7 +1290,7 @@ def list_all_regions(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/refine/local_regions/list_all_regions").execute(*args, **kwargs) - class remesh(metaclass=PyMenuMeta): + class remesh(TUIMenu): """ Has a set of commands for remeshing the face zones. """ @@ -1286,6 +1299,7 @@ def __init__(self, path, service): self.service = service self.controls = self.__class__.controls(path + [("controls", None)], service) self.size_functions = self.__class__.size_functions(path + [("size_functions", None)], service) + super().__init__(path, service) def create_edge_loops(self, *args, **kwargs): """ Creates edge loops for a specified face zone, based on feature angle. @@ -1455,7 +1469,7 @@ def stitch_with_preserve_boundary(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/remesh/stitch_with_preserve_boundary").execute(*args, **kwargs) - class controls(metaclass=PyMenuMeta): + class controls(TUIMenu): """ Enters the edge loop tools text menu. """ @@ -1463,6 +1477,7 @@ def __init__(self, path, service): self.path = path self.service = service self.intersect = self.__class__.intersect(path + [("intersect", None)], service) + super().__init__(path, service) def remesh_method(self, *args, **kwargs): """ Specifies the method to be used for the node distribution on the edge loop. @@ -1504,13 +1519,14 @@ def proximity_local_search(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/remesh/controls/proximity_local_search").execute(*args, **kwargs) - class intersect(metaclass=PyMenuMeta): + class intersect(TUIMenu): """ Enters the intersect control menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def within_tolerance(self, *args, **kwargs): """ Performs the intersection operation only within the specified tolerance value. It is useful only for the Intersect option. @@ -1577,7 +1593,7 @@ def remesh_post_intersection(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/remesh/controls/intersect/remesh_post_intersection").execute(*args, **kwargs) - class size_functions(metaclass=PyMenuMeta): + class size_functions(TUIMenu): """ Enters the size functions menu where you can define size functions for controlling mesh size distribution. """ @@ -1586,6 +1602,7 @@ def __init__(self, path, service): self.service = service self.contours = self.__class__.contours(path + [("contours", None)], service) self.controls = self.__class__.controls(path + [("controls", None)], service) + super().__init__(path, service) def create(self, *args, **kwargs): """ Defines the size function based on the specified parameters. @@ -1662,7 +1679,7 @@ def use_cad_imported_curvature(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/remesh/size_functions/use_cad_imported_curvature").execute(*args, **kwargs) - class contours(metaclass=PyMenuMeta): + class contours(TUIMenu): """ Contains options for displaying contours of size functions. """ @@ -1670,32 +1687,35 @@ def __init__(self, path, service): self.path = path self.service = service self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) def draw(self, *args, **kwargs): """ Displays contours in the graphics window. Compute the size field using /size-functions/compute or read in a size field file prior to displaying the contours of size. """ return PyMenu(self.service, "/boundary/remesh/size_functions/contours/draw").execute(*args, **kwargs) - class set(metaclass=PyMenuMeta): + class set(TUIMenu): """ Set contour options. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def refine_facets(self, *args, **kwargs): """ Enables you to specify smaller facets if the original are too large. Default is no. """ return PyMenu(self.service, "/boundary/remesh/size_functions/contours/set/refine_facets").execute(*args, **kwargs) - class controls(metaclass=PyMenuMeta): + class controls(TUIMenu): """ Menu to control different behavior of sf. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def meshed_sf_behavior(self, *args, **kwargs): """ Set meshed size function processing to hard. @@ -1707,13 +1727,14 @@ def curvature_method(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/remesh/size_functions/controls/curvature_method").execute(*args, **kwargs) - class improve(metaclass=PyMenuMeta): + class improve(TUIMenu): """ Enables you to improve boundary surfaces. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def collapse_bad_faces(self, *args, **kwargs): """ Enables you to collapse the short edge of faces having a high aspect ratio or skewness in the specified face zone(s). @@ -1740,7 +1761,7 @@ def degree_swap(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/improve/degree_swap").execute(*args, **kwargs) - class separate(metaclass=PyMenuMeta): + class separate(TUIMenu): """ Contains options for separating face zones. """ @@ -1748,6 +1769,7 @@ def __init__(self, path, service): self.path = path self.service = service self.local_regions = self.__class__.local_regions(path + [("local_regions", None)], service) + super().__init__(path, service) def mark_faces_in_region(self, *args, **kwargs): """ Marks the faces that are contained in a specified local refinement region. @@ -1789,13 +1811,14 @@ def sep_face_zone_by_shape(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/separate/sep_face_zone_by_shape").execute(*args, **kwargs) - class local_regions(metaclass=PyMenuMeta): + class local_regions(TUIMenu): """ Enters the local refinement menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def define(self, *args, **kwargs): """ Enables you to define the local region. @@ -1817,7 +1840,7 @@ def list_all_regions(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/separate/local_regions/list_all_regions").execute(*args, **kwargs) - class manage(metaclass=PyMenuMeta): + class manage(TUIMenu): """ Contains options for manipulating the boundary zones. """ @@ -1825,6 +1848,7 @@ def __init__(self, path, service): self.path = path self.service = service self.user_defined_groups = self.__class__.user_defined_groups(path + [("user_defined_groups", None)], service) + super().__init__(path, service) def auto_delete_nodes(self, *args, **kwargs): """ Specifies whether or not unused nodes should be deleted when their face zone is deleted. @@ -1931,13 +1955,14 @@ def type(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/manage/type").execute(*args, **kwargs) - class user_defined_groups(metaclass=PyMenuMeta): + class user_defined_groups(TUIMenu): """ Enables you to manipulate user-defined groups. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def create(self, *args, **kwargs): """ Creates the user-defined group comprising the specified zones. @@ -1964,7 +1989,7 @@ def list(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/manage/user_defined_groups/list").execute(*args, **kwargs) - class shell_boundary_layer(metaclass=PyMenuMeta): + class shell_boundary_layer(TUIMenu): """ Enter the shell boundary layer menu. """ @@ -1972,13 +1997,14 @@ def __init__(self, path, service): self.path = path self.service = service self.controls = self.__class__.controls(path + [("controls", None)], service) + super().__init__(path, service) def create(self, *args, **kwargs): """ Create shell boundary layers from one or more face zones. """ return PyMenu(self.service, "/boundary/shell_boundary_layer/create").execute(*args, **kwargs) - class controls(metaclass=PyMenuMeta): + class controls(TUIMenu): """ Shell Boundary Layer Controls. """ @@ -1986,14 +2012,16 @@ def __init__(self, path, service): self.path = path self.service = service self.zone_specific_growth = self.__class__.zone_specific_growth(path + [("zone_specific_growth", None)], service) + super().__init__(path, service) - class zone_specific_growth(metaclass=PyMenuMeta): + class zone_specific_growth(TUIMenu): """ Shell boundary Layer Growth Controls. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def apply_growth(self, *args, **kwargs): """ Apply shell boundary la growth on individual edge zones. @@ -2005,13 +2033,14 @@ def clear_growth(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/shell_boundary_layer/controls/zone_specific_growth/clear_growth").execute(*args, **kwargs) - class boundary_conditions(metaclass=PyMenuMeta): + class boundary_conditions(TUIMenu): """ Contains options for copying or clearing boundary conditions when a case file is read. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def copy(self, *args, **kwargs): """ Enables you to copy the boundary conditions from the face zone selected to the face zones specified. @@ -2028,7 +2057,7 @@ def clear_all(self, *args, **kwargs): """ return PyMenu(self.service, "/boundary/boundary_conditions/clear_all").execute(*args, **kwargs) - class cad_assemblies(metaclass=PyMenuMeta): + class cad_assemblies(TUIMenu): """ Menu for cad assemblies. """ @@ -2039,6 +2068,7 @@ def __init__(self, path, service): self.manage_state = self.__class__.manage_state(path + [("manage_state", None)], service) self.labels = self.__class__.labels(path + [("labels", None)], service) self.update_options = self.__class__.update_options(path + [("update_options", None)], service) + super().__init__(path, service) def draw(self, *args, **kwargs): """ Displays the selected CAD entities. @@ -2085,13 +2115,14 @@ def delete_cad_assemblies(self, *args, **kwargs): """ return PyMenu(self.service, "/cad_assemblies/delete_cad_assemblies").execute(*args, **kwargs) - class draw_options(metaclass=PyMenuMeta): + class draw_options(TUIMenu): """ Contains additional options for displaying CAD entities. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def add_to_graphics(self, *args, **kwargs): """ Adds the selected entities to the display in the graphics window. @@ -2108,13 +2139,14 @@ def draw_unlabelled_zones(self, *args, **kwargs): """ return PyMenu(self.service, "/cad_assemblies/draw_options/draw_unlabelled_zones").execute(*args, **kwargs) - class manage_state(metaclass=PyMenuMeta): + class manage_state(TUIMenu): """ Contains options for setting the CAD entity state. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def unlock(self, *args, **kwargs): """ Unlocks the selected CAD entities. @@ -2131,13 +2163,14 @@ def unsuppress(self, *args, **kwargs): """ return PyMenu(self.service, "/cad_assemblies/manage_state/unsuppress").execute(*args, **kwargs) - class labels(metaclass=PyMenuMeta): + class labels(TUIMenu): """ Contains options for displaying and managing labels. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def draw(self, *args, **kwargs): """ Displays the selected labels. @@ -2164,13 +2197,14 @@ def rename(self, *args, **kwargs): """ return PyMenu(self.service, "/cad_assemblies/labels/rename").execute(*args, **kwargs) - class update_options(metaclass=PyMenuMeta): + class update_options(TUIMenu): """ Contains options for updating the CAD entities on reimport. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def tessellation(self, *args, **kwargs): """ Enables you to control the tessellation (faceting) during reimport. You can select either cad-faceting or cfd-surface-mesh. CAD faceting enables you to control the tessellation based on the CAD faceting tolerance and maximum facet size specified. CFD Surface Mesh enables you to use a size field file during reimport. If you enter yes, specify the size field file to be read. If you do not want to use a size field file, you can obtain conformal faceting based on the underlying curve and surface curvature (using the minimum and maximum facet sizes, and the facet curvature normal angle specified) and edge proximity (using the cells per gap specified). You can also save the size field in a file (size field is computed based on the specified parameters; that is, Min Size, Max Size, Curvature Normal Angle, Cells Per Gap). @@ -2192,7 +2226,7 @@ def import_edge_zones(self, *args, **kwargs): """ return PyMenu(self.service, "/cad_assemblies/update_options/import_edge_zones").execute(*args, **kwargs) - class preferences(metaclass=PyMenuMeta): + class preferences(TUIMenu): """ Set preferences. """ @@ -2209,8 +2243,9 @@ def __init__(self, path, service): self.prj_app = self.__class__.prj_app(path + [("prj_app", None)], service) self.simulation = self.__class__.simulation(path + [("simulation", None)], service) self.turbo_workflow = self.__class__.turbo_workflow(path + [("turbo_workflow", None)], service) + super().__init__(path, service) - class appearance(metaclass=PyMenuMeta): + class appearance(TUIMenu): """ Enter the menu for preferences covering appearance. """ @@ -2220,6 +2255,7 @@ def __init__(self, path, service): self.ansys_logo = self.__class__.ansys_logo(path + [("ansys_logo", None)], service) self.charts = self.__class__.charts(path + [("charts", None)], service) self.selections = self.__class__.selections(path + [("selections", None)], service) + super().__init__(path, service) def application_font_size(self, *args, **kwargs): """ . @@ -2407,13 +2443,14 @@ def titles_border_offset(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/appearance/titles_border_offset").execute(*args, **kwargs) - class ansys_logo(metaclass=PyMenuMeta): + class ansys_logo(TUIMenu): """ Enter the menu for controlling Ansys logo visibility. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color(self, *args, **kwargs): """ Specify whether the Ansys logo is white or black. @@ -2425,7 +2462,7 @@ def visible(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/appearance/ansys_logo/visible").execute(*args, **kwargs) - class charts(metaclass=PyMenuMeta): + class charts(TUIMenu): """ Enter the menu for controlling the display of 2D charts/plots. """ @@ -2434,6 +2471,7 @@ def __init__(self, path, service): self.service = service self.font = self.__class__.font(path + [("font", None)], service) self.text_color = self.__class__.text_color(path + [("text_color", None)], service) + super().__init__(path, service) def curve_colors(self, *args, **kwargs): """ Specify the initial set of default colors for the rendering of curves. Note that changing this setting requires any plots to be replotted before you see the effect of the new setting. @@ -2486,13 +2524,14 @@ def threshold(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/appearance/charts/threshold").execute(*args, **kwargs) - class font(metaclass=PyMenuMeta): + class font(TUIMenu): """ . """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def axes(self, *args, **kwargs): """ . @@ -2514,13 +2553,14 @@ def title(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/appearance/charts/font/title").execute(*args, **kwargs) - class text_color(metaclass=PyMenuMeta): + class text_color(TUIMenu): """ . """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def axes(self, *args, **kwargs): """ . @@ -2542,13 +2582,14 @@ def title(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/appearance/charts/text_color/title").execute(*args, **kwargs) - class selections(metaclass=PyMenuMeta): + class selections(TUIMenu): """ Enters the menu for controlling selections in the graphics window. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def general_displacement(self, *args, **kwargs): """ . @@ -2605,13 +2646,14 @@ def probe_tooltip_show_delay_timer(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/appearance/selections/probe_tooltip_show_delay_timer").execute(*args, **kwargs) - class general(metaclass=PyMenuMeta): + class general(TUIMenu): """ Enter the menu for general preferences. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def advanced_partition(self, *args, **kwargs): """ . @@ -2668,20 +2710,21 @@ def utlmode(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/general/utlmode").execute(*args, **kwargs) - class gpuapp(metaclass=PyMenuMeta): + class gpuapp(TUIMenu): """ . """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def alpha_features(self, *args, **kwargs): """ . """ return PyMenu(self.service, "/preferences/gpuapp/alpha_features").execute(*args, **kwargs) - class graphics(metaclass=PyMenuMeta): + class graphics(TUIMenu): """ Enter the menu for preferences covering appearance. """ @@ -2701,6 +2744,7 @@ def __init__(self, path, service): self.performance = self.__class__.performance(path + [("performance", None)], service) self.transparency = self.__class__.transparency(path + [("transparency", None)], service) self.vector_settings = self.__class__.vector_settings(path + [("vector_settings", None)], service) + super().__init__(path, service) def animation_option(self, *args, **kwargs): """ Specify whether the entire model or just a wireframe is shown during manipulations in the graphics window. @@ -2837,13 +2881,14 @@ def text_window_line_width(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/graphics/text_window_line_width").execute(*args, **kwargs) - class boundary_markers(metaclass=PyMenuMeta): + class boundary_markers(TUIMenu): """ Enter the boundary markers menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color_option(self, *args, **kwargs): """ Specify whether boundary markers are a fixed color or if they match the color of the surface they are identifying. @@ -2900,13 +2945,14 @@ def show_outlet_markers(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/graphics/boundary_markers/show_outlet_markers").execute(*args, **kwargs) - class colormap_settings(metaclass=PyMenuMeta): + class colormap_settings(TUIMenu): """ Enter the colormap settings menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def alignment(self, *args, **kwargs): """ Specify the default colormap location. @@ -3078,13 +3124,14 @@ def use_no_sub_windows(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/graphics/colormap_settings/use_no_sub_windows").execute(*args, **kwargs) - class embedded_windows(metaclass=PyMenuMeta): + class embedded_windows(TUIMenu): """ . """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def default_embedded_mesh_windows_view(self, *args, **kwargs): """ . @@ -3106,7 +3153,7 @@ def show_border_for_embedded_window(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/graphics/embedded_windows/show_border_for_embedded_window").execute(*args, **kwargs) - class export_video_settings(metaclass=PyMenuMeta): + class export_video_settings(TUIMenu): """ . """ @@ -3114,6 +3161,7 @@ def __init__(self, path, service): self.path = path self.service = service self.advanced_video_quality_options = self.__class__.advanced_video_quality_options(path + [("advanced_video_quality_options", None)], service) + super().__init__(path, service) def video_format(self, *args, **kwargs): """ . @@ -3155,13 +3203,14 @@ def video_use_frame_resolution(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/graphics/export_video_settings/video_use_frame_resolution").execute(*args, **kwargs) - class advanced_video_quality_options(metaclass=PyMenuMeta): + class advanced_video_quality_options(TUIMenu): """ . """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def bit_rate_quality(self, *args, **kwargs): """ . @@ -3188,13 +3237,14 @@ def key_frames(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/graphics/export_video_settings/advanced_video_quality_options/key_frames").execute(*args, **kwargs) - class graphics_effects(metaclass=PyMenuMeta): + class graphics_effects(TUIMenu): """ Enter the graphics effects menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def ambient_occlusion_enabled(self, *args, **kwargs): """ . @@ -3291,13 +3341,14 @@ def update_after_mouse_release(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/graphics/graphics_effects/update_after_mouse_release").execute(*args, **kwargs) - class hardcopy_settings(metaclass=PyMenuMeta): + class hardcopy_settings(TUIMenu): """ Enter the menu for saving picture settings. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def export_edges_for_avz(self, *args, **kwargs): """ . @@ -3339,13 +3390,14 @@ def transparent_embedded_windows(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/graphics/hardcopy_settings/transparent_embedded_windows").execute(*args, **kwargs) - class lighting(metaclass=PyMenuMeta): + class lighting(TUIMenu): """ Enter the lighting menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def ambient_light_intensity(self, *args, **kwargs): """ . @@ -3367,13 +3419,14 @@ def lighting_method(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/graphics/lighting/lighting_method").execute(*args, **kwargs) - class manage_hoops_memory(metaclass=PyMenuMeta): + class manage_hoops_memory(TUIMenu): """ . """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def enabled(self, *args, **kwargs): """ . @@ -3385,13 +3438,14 @@ def hsfimport_limit(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/graphics/manage_hoops_memory/hsfimport_limit").execute(*args, **kwargs) - class material_effects(metaclass=PyMenuMeta): + class material_effects(TUIMenu): """ . """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def decimation_filter(self, *args, **kwargs): """ . @@ -3408,13 +3462,14 @@ def tiling_style(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/graphics/material_effects/tiling_style").execute(*args, **kwargs) - class meshing_mode(metaclass=PyMenuMeta): + class meshing_mode(TUIMenu): """ Enter the menu for meshing-specific graphics settings. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def graphics_window_display_timeout(self, *args, **kwargs): """ Enable/disable graphics window display timeout. @@ -3426,7 +3481,7 @@ def graphics_window_display_timeout_value(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/graphics/meshing_mode/graphics_window_display_timeout_value").execute(*args, **kwargs) - class performance(metaclass=PyMenuMeta): + class performance(TUIMenu): """ Enter the menu for selecting the predefined graphics effects settings. """ @@ -3435,6 +3490,7 @@ def __init__(self, path, service): self.service = service self.fast_display_mode = self.__class__.fast_display_mode(path + [("fast_display_mode", None)], service) self.minimum_frame_rate = self.__class__.minimum_frame_rate(path + [("minimum_frame_rate", None)], service) + super().__init__(path, service) def optimize_for(self, *args, **kwargs): """ Choose a preset selection for how graphics are displayed. @@ -3451,13 +3507,14 @@ def ratio_of_target_frame_rate_to_declassify_heavy_geometry(self, *args, **kwarg """ return PyMenu(self.service, "/preferences/graphics/performance/ratio_of_target_frame_rate_to_declassify_heavy_geometry").execute(*args, **kwargs) - class fast_display_mode(metaclass=PyMenuMeta): + class fast_display_mode(TUIMenu): """ . """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def culling(self, *args, **kwargs): """ . @@ -3499,13 +3556,14 @@ def transparency(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/graphics/performance/fast_display_mode/transparency").execute(*args, **kwargs) - class minimum_frame_rate(metaclass=PyMenuMeta): + class minimum_frame_rate(TUIMenu): """ Enter the menu for minimum frame-rate settings. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def dynamic_adjustment(self, *args, **kwargs): """ Enable/disable dynamic adjustment of quality loss per frame to get to the desired frame rate. @@ -3537,13 +3595,14 @@ def target_fps(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/graphics/performance/minimum_frame_rate/target_fps").execute(*args, **kwargs) - class transparency(metaclass=PyMenuMeta): + class transparency(TUIMenu): """ . """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def algorithm_for_modern_drivers(self, *args, **kwargs): """ . @@ -3570,13 +3629,14 @@ def zsort_options(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/graphics/transparency/zsort_options").execute(*args, **kwargs) - class vector_settings(metaclass=PyMenuMeta): + class vector_settings(TUIMenu): """ . """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def arrow3_dradius1_factor(self, *args, **kwargs): """ . @@ -3598,13 +3658,14 @@ def line_arrow3_dperpendicular_radius(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/graphics/vector_settings/line_arrow3_dperpendicular_radius").execute(*args, **kwargs) - class mat_pro_app(metaclass=PyMenuMeta): + class mat_pro_app(TUIMenu): """ . """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def beta_features(self, *args, **kwargs): """ . @@ -3621,7 +3682,7 @@ def warning(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/mat_pro_app/warning").execute(*args, **kwargs) - class meshing_workflow(metaclass=PyMenuMeta): + class meshing_workflow(TUIMenu): """ Enter the menu for preferences covering the Fluent Meshing workflows. """ @@ -3629,6 +3690,7 @@ def __init__(self, path, service): self.path = path self.service = service self.draw_settings = self.__class__.draw_settings(path + [("draw_settings", None)], service) + super().__init__(path, service) def checkpointing_option(self, *args, **kwargs): """ Specify how Fluent Meshing will save data when you edit a task. @@ -3655,13 +3717,14 @@ def verbosity(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/meshing_workflow/verbosity").execute(*args, **kwargs) - class draw_settings(metaclass=PyMenuMeta): + class draw_settings(TUIMenu): """ Enter the menu for specifying drawing settings. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def auto_draw(self, *args, **kwargs): """ Enable/disable the automatic display of changes in the graphics window based on the current task. @@ -3678,7 +3741,7 @@ def facet_limit(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/meshing_workflow/draw_settings/facet_limit").execute(*args, **kwargs) - class navigation(metaclass=PyMenuMeta): + class navigation(TUIMenu): """ Enter the menu for controlling navigation in ANSYS Fluent. """ @@ -3686,8 +3749,9 @@ def __init__(self, path, service): self.path = path self.service = service self.mouse_mapping = self.__class__.mouse_mapping(path + [("mouse_mapping", None)], service) + super().__init__(path, service) - class mouse_mapping(metaclass=PyMenuMeta): + class mouse_mapping(TUIMenu): """ Enable/disable the printing of additional information and messages in the Console. """ @@ -3696,19 +3760,21 @@ def __init__(self, path, service): self.service = service self.additional = self.__class__.additional(path + [("additional", None)], service) self.basic = self.__class__.basic(path + [("basic", None)], service) + super().__init__(path, service) def mousemaptheme(self, *args, **kwargs): """ . """ return PyMenu(self.service, "/preferences/navigation/mouse_mapping/mousemaptheme").execute(*args, **kwargs) - class additional(metaclass=PyMenuMeta): + class additional(TUIMenu): """ Enter the menu for controlling mouse mappings that include a modifier button such as Ctrl and Shift. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def ctrllmbclick(self, *args, **kwargs): """ Specify the action/behavoir for Ctrl + left-mouse-button + click. @@ -3790,13 +3856,14 @@ def shiftrmbdrag(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/shiftrmbdrag").execute(*args, **kwargs) - class basic(metaclass=PyMenuMeta): + class basic(TUIMenu): """ . """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def lmb(self, *args, **kwargs): """ . @@ -3828,13 +3895,14 @@ def rmbclick(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/navigation/mouse_mapping/basic/rmbclick").execute(*args, **kwargs) - class prj_app(metaclass=PyMenuMeta): + class prj_app(TUIMenu): """ . """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def advanced_flag(self, *args, **kwargs): """ . @@ -3896,7 +3964,7 @@ def use_launcher(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/prj_app/use_launcher").execute(*args, **kwargs) - class simulation(metaclass=PyMenuMeta): + class simulation(TUIMenu): """ . """ @@ -3904,6 +3972,7 @@ def __init__(self, path, service): self.path = path self.service = service self.report_definitions = self.__class__.report_definitions(path + [("report_definitions", None)], service) + super().__init__(path, service) def flow_model(self, *args, **kwargs): """ . @@ -3915,13 +3984,14 @@ def local_residual_scaling(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/simulation/local_residual_scaling").execute(*args, **kwargs) - class report_definitions(metaclass=PyMenuMeta): + class report_definitions(TUIMenu): """ Enter the menu for report definition preferences. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def automatic_plot_file(self, *args, **kwargs): """ New report definitions will automatically create associated report files and plots. @@ -3933,7 +4003,7 @@ def report_plot_history_data_size(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/simulation/report_definitions/report_plot_history_data_size").execute(*args, **kwargs) - class turbo_workflow(metaclass=PyMenuMeta): + class turbo_workflow(TUIMenu): """ . """ @@ -3943,6 +4013,7 @@ def __init__(self, path, service): self.cell_zone_settings = self.__class__.cell_zone_settings(path + [("cell_zone_settings", None)], service) self.face_zone_settings = self.__class__.face_zone_settings(path + [("face_zone_settings", None)], service) self.graphics_settings = self.__class__.graphics_settings(path + [("graphics_settings", None)], service) + super().__init__(path, service) def checkpointing_option(self, *args, **kwargs): """ . @@ -3954,13 +4025,14 @@ def save_checkpoint_files(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/turbo_workflow/save_checkpoint_files").execute(*args, **kwargs) - class cell_zone_settings(metaclass=PyMenuMeta): + class cell_zone_settings(TUIMenu): """ . """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def czsearch_order(self, *args, **kwargs): """ . @@ -3977,13 +4049,14 @@ def stationary(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/turbo_workflow/cell_zone_settings/stationary").execute(*args, **kwargs) - class face_zone_settings(metaclass=PyMenuMeta): + class face_zone_settings(TUIMenu): """ . """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def blade_region(self, *args, **kwargs): """ . @@ -4045,20 +4118,21 @@ def tip2_region(self, *args, **kwargs): """ return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/tip2_region").execute(*args, **kwargs) - class graphics_settings(metaclass=PyMenuMeta): + class graphics_settings(TUIMenu): """ . """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def auto_draw(self, *args, **kwargs): """ . """ return PyMenu(self.service, "/preferences/turbo_workflow/graphics_settings/auto_draw").execute(*args, **kwargs) - class size_functions(metaclass=PyMenuMeta): + class size_functions(TUIMenu): """ Manage advanced size functions. """ @@ -4067,6 +4141,7 @@ def __init__(self, path, service): self.service = service self.contours = self.__class__.contours(path + [("contours", None)], service) self.controls = self.__class__.controls(path + [("controls", None)], service) + super().__init__(path, service) def create(self, *args, **kwargs): """ Defines the size function based on the specified parameters. @@ -4143,7 +4218,7 @@ def use_cad_imported_curvature(self, *args, **kwargs): """ return PyMenu(self.service, "/size_functions/use_cad_imported_curvature").execute(*args, **kwargs) - class contours(metaclass=PyMenuMeta): + class contours(TUIMenu): """ Contains options for managing contours. """ @@ -4151,32 +4226,35 @@ def __init__(self, path, service): self.path = path self.service = service self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) def draw(self, *args, **kwargs): """ Displays contours in the graphics window. Run compute prior to contours/draw. """ return PyMenu(self.service, "/size_functions/contours/draw").execute(*args, **kwargs) - class set(metaclass=PyMenuMeta): + class set(TUIMenu): """ Contains options to manage the contour size. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def refine_facets(self, *args, **kwargs): """ Allows you to specify smaller facets if the original are too large. Default is no. """ return PyMenu(self.service, "/size_functions/contours/set/refine_facets").execute(*args, **kwargs) - class controls(metaclass=PyMenuMeta): + class controls(TUIMenu): """ Menu to control different behavior of sf. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def meshed_sf_behavior(self, *args, **kwargs): """ Set meshed size function processing to hard. @@ -4188,13 +4266,14 @@ def curvature_method(self, *args, **kwargs): """ return PyMenu(self.service, "/size_functions/controls/curvature_method").execute(*args, **kwargs) - class scoped_sizing(metaclass=PyMenuMeta): + class scoped_sizing(TUIMenu): """ Manage scoped sizing. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def create(self, *args, **kwargs): """ Defines the scoped size based on the specified parameters. @@ -4251,7 +4330,7 @@ def validate(self, *args, **kwargs): """ return PyMenu(self.service, "/scoped_sizing/validate").execute(*args, **kwargs) - class objects(metaclass=PyMenuMeta): + class objects(TUIMenu): """ Manage objects. """ @@ -4268,6 +4347,7 @@ def __init__(self, path, service): self.create_new_mesh_object = self.__class__.create_new_mesh_object(path + [("create_new_mesh_object", None)], service) self.labels = self.__class__.labels(path + [("labels", None)], service) self.volumetric_regions = self.__class__.volumetric_regions(path + [("volumetric_regions", None)], service) + super().__init__(path, service) def create(self, *args, **kwargs): """ Creates the object based on the priority, cell zone type, face zone(s), edge zone(s), and object type specified. You can specify the object name or retain the default blank entry to have the object name generated automatically. @@ -4444,13 +4524,14 @@ def change_suffix(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/change_suffix").execute(*args, **kwargs) - class cad_association(metaclass=PyMenuMeta): + class cad_association(TUIMenu): """ Contains options for modifying the selected objects based on the associated CAD entities and attaching/detaching the CAD entities from the objects. This menu is available when the CAD Assemblies tree is created during CAD import. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def attach_cad(self, *args, **kwargs): """ Attaches CAD entities to the selected geometry/mesh objects. Select the geometry/mesh objects and specify the path for the CAD entities to be associated with the objects. The selected geometry/mesh objects will be associated with the CAD entities which will then be locked. @@ -4492,13 +4573,14 @@ def restore_cad(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/cad_association/restore_cad").execute(*args, **kwargs) - class set(metaclass=PyMenuMeta): + class set(TUIMenu): """ Contains options for setting additional object-related settings. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def set_edge_feature_angle(self, *args, **kwargs): """ Sets the edge feature angle to be used for extracting edge zone(s) from the face zone(s) included in the object(s). @@ -4515,20 +4597,21 @@ def show_edge_zones(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/set/show_edge_zones").execute(*args, **kwargs) - class deprecated(metaclass=PyMenuMeta): + class deprecated(TUIMenu): """ Deprecated features. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def create_mesh_object_from_wrap(self, *args, **kwargs): """ Create mesh object from a wrap object. """ return PyMenu(self.service, "/objects/deprecated/create_mesh_object_from_wrap").execute(*args, **kwargs) - class wrap(metaclass=PyMenuMeta): + class wrap(TUIMenu): """ Contains options related to the object wrapping operation. """ @@ -4536,6 +4619,7 @@ def __init__(self, path, service): self.path = path self.service = service self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) def wrap(self, *args, **kwargs): """ Creates the mesh objects based on the geometry objects selected and other object wrapping parameters specified. @@ -4557,13 +4641,14 @@ def debug(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/wrap/debug").execute(*args, **kwargs) - class set(metaclass=PyMenuMeta): + class set(TUIMenu): """ Contains additional options related to the object wrapping operation. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def use_ray_tracing(self, *args, **kwargs): """ Use ray tracing. @@ -4645,13 +4730,14 @@ def list_zones_geometry_recovery_levels(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/wrap/set/list_zones_geometry_recovery_levels").execute(*args, **kwargs) - class remove_gaps(metaclass=PyMenuMeta): + class remove_gaps(TUIMenu): """ Contains options for removing gaps between the mesh objects specified or removing the thickness in the mesh objects specified. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def remove_gaps(self, *args, **kwargs): """ Allows you to remove gaps between the mesh objects specified or remove the thickness in the mesh objects specified. Select the appropriate repair option and specify the other parameters required. @@ -4668,7 +4754,7 @@ def ignore_orientation(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/remove_gaps/ignore_orientation").execute(*args, **kwargs) - class join_intersect(metaclass=PyMenuMeta): + class join_intersect(TUIMenu): """ Contains options for connecting overlapping and intersecting face zones. """ @@ -4676,6 +4762,7 @@ def __init__(self, path, service): self.path = path self.service = service self.controls = self.__class__.controls(path + [("controls", None)], service) + super().__init__(path, service) def create_mesh_object(self, *args, **kwargs): """ Allows you to specify one or more mesh objects to be connected in one mesh object. @@ -4727,20 +4814,21 @@ def list_regions(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/join_intersect/list_regions").execute(*args, **kwargs) - class controls(metaclass=PyMenuMeta): + class controls(TUIMenu): """ Build topology controls. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def remesh_post_intersection(self, *args, **kwargs): """ Used to enable or disable automatic post-remesh operation after join or intersect. """ return PyMenu(self.service, "/objects/join_intersect/controls/remesh_post_intersection").execute(*args, **kwargs) - class fix_holes(metaclass=PyMenuMeta): + class fix_holes(TUIMenu): """ Fix holes in surface mesh using octree. """ @@ -4748,6 +4836,7 @@ def __init__(self, path, service): self.path = path self.service = service self.advanced = self.__class__.advanced(path + [("advanced", None)], service) + super().__init__(path, service) def find_holes(self, *args, **kwargs): """ Find holes in objects using octree. @@ -4784,13 +4873,14 @@ def shrink_wrap(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/fix_holes/shrink_wrap").execute(*args, **kwargs) - class advanced(metaclass=PyMenuMeta): + class advanced(TUIMenu): """ Advanced fix holes options. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def patch_holes_between_material_points(self, *args, **kwargs): """ Patch holes separating the material points. @@ -4827,13 +4917,14 @@ def open_holes_not_connected_to_material_points(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/fix_holes/advanced/open_holes_not_connected_to_material_points").execute(*args, **kwargs) - class create_new_mesh_object(metaclass=PyMenuMeta): + class create_new_mesh_object(TUIMenu): """ Contains options for creating a new mesh object by wrapping or remeshing existing objects. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def wrap(self, *args, **kwargs): """ Creates a new mesh object by wrapping the specified objects individually or collectively. @@ -4845,7 +4936,7 @@ def remesh(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/create_new_mesh_object/remesh").execute(*args, **kwargs) - class labels(metaclass=PyMenuMeta): + class labels(TUIMenu): """ Contains options for creating and managing face zone labels. """ @@ -4853,6 +4944,7 @@ def __init__(self, path, service): self.path = path self.service = service self.cavity = self.__class__.cavity(path + [("cavity", None)], service) + super().__init__(path, service) def create(self, *args, **kwargs): """ Creates a new face zone label for the specified face zones. @@ -4904,13 +4996,14 @@ def create_label_per_zone(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/labels/create_label_per_zone").execute(*args, **kwargs) - class cavity(metaclass=PyMenuMeta): + class cavity(TUIMenu): """ Enter menu to create cavity using labels. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def replace(self, *args, **kwargs): """ Create cavity by replacing labels from another mesh object. @@ -4927,7 +5020,7 @@ def add(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/labels/cavity/add").execute(*args, **kwargs) - class volumetric_regions(metaclass=PyMenuMeta): + class volumetric_regions(TUIMenu): """ Manage volumetric regions of an object. """ @@ -4937,6 +5030,7 @@ def __init__(self, path, service): self.scoped_prism = self.__class__.scoped_prism(path + [("scoped_prism", None)], service) self.tet = self.__class__.tet(path + [("tet", None)], service) self.hexcore = self.__class__.hexcore(path + [("hexcore", None)], service) + super().__init__(path, service) def compute(self, *args, **kwargs): """ Computes the volumetric regions based on the face zone labels. You can choose to use existing material points for computing the regions. When regions are computed, region names and types will be based on the face zone labels of the mesh object selected. If regions are recomputed, all previous region names and types will be over written. @@ -4993,7 +5087,7 @@ def delete_cells(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/volumetric_regions/delete_cells").execute(*args, **kwargs) - class scoped_prism(metaclass=PyMenuMeta): + class scoped_prism(TUIMenu): """ Contains options for setting scoped prism controls. """ @@ -5001,19 +5095,21 @@ def __init__(self, path, service): self.path = path self.service = service self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) def generate(self, *args, **kwargs): """ Grow prism into selected region using scoped prism controls. """ return PyMenu(self.service, "/objects/volumetric_regions/scoped_prism/generate").execute(*args, **kwargs) - class set(metaclass=PyMenuMeta): + class set(TUIMenu): """ Enter scoped prism settings. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def create(self, *args, **kwargs): """ Create new scoped prism. @@ -5065,7 +5161,7 @@ def set_advanced_controls(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/volumetric_regions/scoped_prism/set/set_advanced_controls").execute(*args, **kwargs) - class tet(metaclass=PyMenuMeta): + class tet(TUIMenu): """ Contains options for setting tetrahedral mesh controls. See mesh/ @@ -5074,13 +5170,14 @@ def __init__(self, path, service): self.path = path self.service = service self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) def generate(self, *args, **kwargs): """ Fill empty volume of selected regions with tets. """ return PyMenu(self.service, "/objects/volumetric_regions/tet/generate").execute(*args, **kwargs) - class set(metaclass=PyMenuMeta): + class set(TUIMenu): """ Enter tet settings. """ @@ -5091,6 +5188,7 @@ def __init__(self, path, service): self.adv_front_method = self.__class__.adv_front_method(path + [("adv_front_method", None)], service) self.remove_slivers = self.__class__.remove_slivers(path + [("remove_slivers", None)], service) self.tet_improve = self.__class__.tet_improve(path + [("tet_improve", None)], service) + super().__init__(path, service) def cell_sizing(self, *args, **kwargs): """ Allow cell volume distribution to be determined based on boundary. @@ -5157,13 +5255,14 @@ def skewness_method(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/volumetric_regions/tet/set/skewness_method").execute(*args, **kwargs) - class improve_mesh(metaclass=PyMenuMeta): + class improve_mesh(TUIMenu): """ Improve mesh controls. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def improve(self, *args, **kwargs): """ Automatically improve mesh. @@ -5185,7 +5284,7 @@ def laplace_smooth(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/volumetric_regions/tet/set/improve_mesh/laplace_smooth").execute(*args, **kwargs) - class adv_front_method(metaclass=PyMenuMeta): + class adv_front_method(TUIMenu): """ Advancing front refinement controls. """ @@ -5193,6 +5292,7 @@ def __init__(self, path, service): self.path = path self.service = service self.skew_improve = self.__class__.skew_improve(path + [("skew_improve", None)], service) + super().__init__(path, service) def refine_parameters(self, *args, **kwargs): """ Define refine parameters. @@ -5209,13 +5309,14 @@ def second_improve_params(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/volumetric_regions/tet/set/adv_front_method/second_improve_params").execute(*args, **kwargs) - class skew_improve(metaclass=PyMenuMeta): + class skew_improve(TUIMenu): """ Refine improve controls. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def boundary_sliver_skew(self, *args, **kwargs): """ Refine improve boundary sliver skew. @@ -5252,13 +5353,14 @@ def iterations(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/volumetric_regions/tet/set/adv_front_method/skew_improve/iterations").execute(*args, **kwargs) - class remove_slivers(metaclass=PyMenuMeta): + class remove_slivers(TUIMenu): """ Sliver remove controls. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def remove(self, *args, **kwargs): """ Automatically remove slivers. @@ -5295,13 +5397,14 @@ def method(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/volumetric_regions/tet/set/remove_slivers/method").execute(*args, **kwargs) - class tet_improve(metaclass=PyMenuMeta): + class tet_improve(TUIMenu): """ Improve cells controls. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def skew(self, *args, **kwargs): """ Remove skew. @@ -5323,7 +5426,7 @@ def iterations(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/volumetric_regions/tet/set/tet_improve/iterations").execute(*args, **kwargs) - class hexcore(metaclass=PyMenuMeta): + class hexcore(TUIMenu): """ Contains options for setting hexcore mesh controls. See mesh/ @@ -5332,13 +5435,14 @@ def __init__(self, path, service): self.path = path self.service = service self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) def generate(self, *args, **kwargs): """ Fill empty volume of selected regions with hexcore. """ return PyMenu(self.service, "/objects/volumetric_regions/hexcore/generate").execute(*args, **kwargs) - class set(metaclass=PyMenuMeta): + class set(TUIMenu): """ Enter hexcore settings. """ @@ -5346,6 +5450,7 @@ def __init__(self, path, service): self.path = path self.service = service self.outer_domain_params = self.__class__.outer_domain_params(path + [("outer_domain_params", None)], service) + super().__init__(path, service) def define_hexcore_extents(self, *args, **kwargs): """ Enables sspecificaton of hexcore outer domain parameters. @@ -5417,13 +5522,14 @@ def print_region_based_sizing(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/volumetric_regions/hexcore/set/print_region_based_sizing").execute(*args, **kwargs) - class outer_domain_params(metaclass=PyMenuMeta): + class outer_domain_params(TUIMenu): """ Define outer domain parameters. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def specify_coordinates(self, *args, **kwargs): """ Enables specification of coordinates of hexcore outer box. @@ -5470,7 +5576,7 @@ def list(self, *args, **kwargs): """ return PyMenu(self.service, "/objects/volumetric_regions/hexcore/set/outer_domain_params/list").execute(*args, **kwargs) - class diagnostics(metaclass=PyMenuMeta): + class diagnostics(TUIMenu): """ Diagnostic tools. """ @@ -5479,6 +5585,7 @@ def __init__(self, path, service): self.service = service self.face_connectivity = self.__class__.face_connectivity(path + [("face_connectivity", None)], service) self.quality = self.__class__.quality(path + [("quality", None)], service) + super().__init__(path, service) def perform_summary(self, *args, **kwargs): """ Performs diagnostics check and report in console. @@ -5500,13 +5607,14 @@ def modify_defaults(self, *args, **kwargs): """ return PyMenu(self.service, "/diagnostics/modify_defaults").execute(*args, **kwargs) - class face_connectivity(metaclass=PyMenuMeta): + class face_connectivity(TUIMenu): """ Contains options for fixing problems with face connectivity on the specified object face zones or boundary face zones. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def fix_free_faces(self, *args, **kwargs): """ Removes free faces by the method selected. The methods available are: @@ -5573,13 +5681,14 @@ def remove_label_from_small_islands(self, *args, **kwargs): """ return PyMenu(self.service, "/diagnostics/face_connectivity/remove_label_from_small_islands").execute(*args, **kwargs) - class quality(metaclass=PyMenuMeta): + class quality(TUIMenu): """ Contains options for fixing problems related to surface mesh quality on the specified object face zones or boundary face zones. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def general_improve(self, *args, **kwargs): """ Improves the surface mesh based on aspect ratio, size change, or skewness. Specify the minimum quality value, feature angle, number of iterations, and whether the boundary should be preserved. @@ -5601,13 +5710,14 @@ def delaunay_swap(self, *args, **kwargs): """ return PyMenu(self.service, "/diagnostics/quality/delaunay_swap").execute(*args, **kwargs) - class material_point(metaclass=PyMenuMeta): + class material_point(TUIMenu): """ Manage material points. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def create_material_point(self, *args, **kwargs): """ Enables the definition of a material point. Specify the fluid zone name and the location to define the material point. @@ -5629,7 +5739,7 @@ def list_material_points(self, *args, **kwargs): """ return PyMenu(self.service, "/material_point/list_material_points").execute(*args, **kwargs) - class mesh(metaclass=PyMenuMeta): + class mesh(TUIMenu): """ Enter the grid menu. """ @@ -5654,6 +5764,7 @@ def __init__(self, path, service): self.poly_hexcore = self.__class__.poly_hexcore(path + [("poly_hexcore", None)], service) self.auto_mesh_controls = self.__class__.auto_mesh_controls(path + [("auto_mesh_controls", None)], service) self.scoped_prisms = self.__class__.scoped_prisms(path + [("scoped_prisms", None)], service) + super().__init__(path, service) def activate_lean_datastructures(self, *args, **kwargs): """ Activates Lean data structures to reduce memory. @@ -5760,26 +5871,28 @@ def zone_names_clean_up(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/zone_names_clean_up").execute(*args, **kwargs) - class cartesian(metaclass=PyMenuMeta): + class cartesian(TUIMenu): """ Enter Cartesian mesh menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def mesh(self, *args, **kwargs): """ Generate Cartesian mesh. """ return PyMenu(self.service, "/mesh/cartesian/mesh").execute(*args, **kwargs) - class cavity(metaclass=PyMenuMeta): + class cavity(TUIMenu): """ Enters the cavity menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def replace_zones(self, *args, **kwargs): """ Enables you to create a cavity for removing a set of zones from an existing volume mesh and replacing them with new set of zones. @@ -5821,13 +5934,14 @@ def remesh_hexcore_cavity(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/cavity/remesh_hexcore_cavity").execute(*args, **kwargs) - class domains(metaclass=PyMenuMeta): + class domains(TUIMenu): """ Enters the domain menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def activate(self, *args, **kwargs): """ Activates the specified domain for meshing or reporting operations. @@ -5864,7 +5978,7 @@ def print(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/domains/print").execute(*args, **kwargs) - class hexcore(metaclass=PyMenuMeta): + class hexcore(TUIMenu): """ Enters the hexcore menu. """ @@ -5873,6 +5987,7 @@ def __init__(self, path, service): self.service = service self.controls = self.__class__.controls(path + [("controls", None)], service) self.local_regions = self.__class__.local_regions(path + [("local_regions", None)], service) + super().__init__(path, service) def create(self, *args, **kwargs): """ Enables you to create the hexcore mesh according to the specified parameters. @@ -5884,7 +5999,7 @@ def merge_tets_to_pyramids(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/hexcore/merge_tets_to_pyramids").execute(*args, **kwargs) - class controls(metaclass=PyMenuMeta): + class controls(TUIMenu): """ Enters the hexcore controls menu. """ @@ -5892,6 +6007,7 @@ def __init__(self, path, service): self.path = path self.service = service self.outer_domain_params = self.__class__.outer_domain_params(path + [("outer_domain_params", None)], service) + super().__init__(path, service) def define_hexcore_extents(self, *args, **kwargs): """ Enables you to extend the hexcore mesh to specified domain extents and/or selected planar boundaries. When enabled, the outer-domain-params sub-menu will be available. @@ -5964,13 +6080,14 @@ def print_region_based_sizing(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/hexcore/controls/print_region_based_sizing").execute(*args, **kwargs) - class outer_domain_params(metaclass=PyMenuMeta): + class outer_domain_params(TUIMenu): """ Contains options for defining the outer domain parameters. This sub-menu is available only when define-hexcore-extents? is enabled. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def specify_coordinates(self, *args, **kwargs): """ Enables you to specify the extents of the hexcore outer box using the coordinates command. @@ -6017,13 +6134,14 @@ def list(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/hexcore/controls/outer_domain_params/list").execute(*args, **kwargs) - class local_regions(metaclass=PyMenuMeta): + class local_regions(TUIMenu): """ Enters the hexcore local refinement region sub-menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def activate(self, *args, **kwargs): """ Enables you to activate the specified local regions for refinement. @@ -6065,13 +6183,14 @@ def ideal_quad_area(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/hexcore/local_regions/ideal_quad_area").execute(*args, **kwargs) - class modify(metaclass=PyMenuMeta): + class modify(TUIMenu): """ Enters the mesh modify menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def clear_selections(self, *args, **kwargs): """ Clears all items from the selection list. @@ -6143,7 +6262,7 @@ def auto_improve_warp(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/modify/auto_improve_warp").execute(*args, **kwargs) - class non_conformals(metaclass=PyMenuMeta): + class non_conformals(TUIMenu): """ Enters the non-conformals menu. """ @@ -6151,6 +6270,7 @@ def __init__(self, path, service): self.path = path self.service = service self.controls = self.__class__.controls(path + [("controls", None)], service) + super().__init__(path, service) def create(self, *args, **kwargs): """ Creates the non-conformal interface on the specified face zones using the specified retriangulation method. @@ -6162,13 +6282,14 @@ def separate(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/non_conformals/separate").execute(*args, **kwargs) - class controls(metaclass=PyMenuMeta): + class controls(TUIMenu): """ Enters the non-conformals controls menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def enable(self, *args, **kwargs): """ Toggles the creation of a non-conformal interface. @@ -6180,7 +6301,7 @@ def retri_method(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/non_conformals/controls/retri_method").execute(*args, **kwargs) - class rapid_octree(metaclass=PyMenuMeta): + class rapid_octree(TUIMenu): """ Enters the rapid octree menu, which provides text commands for using the Rapid Octree mesher. """ @@ -6190,6 +6311,7 @@ def __init__(self, path, service): self.refinement_regions = self.__class__.refinement_regions(path + [("refinement_regions", None)], service) self.mesh_sizing = self.__class__.mesh_sizing(path + [("mesh_sizing", None)], service) self.advanced_meshing_options = self.__class__.advanced_meshing_options(path + [("advanced_meshing_options", None)], service) + super().__init__(path, service) def verbosity(self, *args, **kwargs): """ Sets the verbosity of the messages printed by the Rapid Octree mesher. @@ -6271,13 +6393,14 @@ def delete_poor_quality_cells(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/rapid_octree/delete_poor_quality_cells").execute(*args, **kwargs) - class refinement_regions(metaclass=PyMenuMeta): + class refinement_regions(TUIMenu): """ Enters the rapid octree refinement region menu, which allows you to manage the refinement regions. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def add(self, *args, **kwargs): """ Adds a refinement region to the domain. @@ -6294,13 +6417,14 @@ def list(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/rapid_octree/refinement_regions/list").execute(*args, **kwargs) - class mesh_sizing(metaclass=PyMenuMeta): + class mesh_sizing(TUIMenu): """ Enters the mesh sizing menu, which allows you to define the cell sizes. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def max_cell_size(self, *args, **kwargs): """ Sets the maximum cell size in the octree mesh. @@ -6372,13 +6496,14 @@ def delete_surface_sizing(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/rapid_octree/mesh_sizing/delete_surface_sizing").execute(*args, **kwargs) - class advanced_meshing_options(metaclass=PyMenuMeta): + class advanced_meshing_options(TUIMenu): """ Advanced and experimental options for octree mesh generation. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def pseudo_normal_mode(self, *args, **kwargs): """ Sets the mode for cumputing projection front sudo normals. @@ -6410,7 +6535,7 @@ def rename_bounding_box_zones(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/rapid_octree/advanced_meshing_options/rename_bounding_box_zones").execute(*args, **kwargs) - class prism(metaclass=PyMenuMeta): + class prism(TUIMenu): """ Enters the prism menu. """ @@ -6421,6 +6546,7 @@ def __init__(self, path, service): self.post_ignore = self.__class__.post_ignore(path + [("post_ignore", None)], service) self.split = self.__class__.split(path + [("split", None)], service) self.controls = self.__class__.controls(path + [("controls", None)], service) + super().__init__(path, service) def create(self, *args, **kwargs): """ Creates prism layers on one or more boundary face zones based on the offset method, growth method, number of layers, and rate specified. @@ -6457,13 +6583,14 @@ def quality_method(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/prism/quality_method").execute(*args, **kwargs) - class improve(metaclass=PyMenuMeta): + class improve(TUIMenu): """ Enters the prism improve menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def smooth_prism_cells(self, *args, **kwargs): """ Enables optimization based smoothing of prism cells. The nodes of cells with quality worse than the specified threshold value will be moved to improve quality. The cell aspect ratio will also be maintained based on the value specified for max-aspect-ratio. @@ -6495,13 +6622,14 @@ def smooth_cell_rings(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/prism/improve/smooth_cell_rings").execute(*args, **kwargs) - class post_ignore(metaclass=PyMenuMeta): + class post_ignore(TUIMenu): """ Contains the following options for ignoring prism cells: """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def mark_prism_cap(self, *args, **kwargs): """ Marks the prism cap faces for ignoring prism cells in regions of poor quality cells and sharp corners. Specify the prism cell zone and the basis for ignoring prism cells and the relevant parameters. The prism cells can be ignored based on quality, intersection, (both enabled by default), warp, and features (both disabled by default). Specify the quality measure and threshold value to be used for ignoring cells based on quality and (if applicable) the feature edges for ignoring cells based on features. Additionally, specify whether cells are to be marked in regions of high aspect ratio and based on feature angle, and the additional number of cell rings based on which prism cells will be removed. @@ -6523,20 +6651,21 @@ def mark_cavity_prism_cap(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/prism/post_ignore/mark_cavity_prism_cap").execute(*args, **kwargs) - class split(metaclass=PyMenuMeta): + class split(TUIMenu): """ Contains options for splitting the prism layers after the initial prism layers are generated, to generate the total number of layers required. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def split(self, *args, **kwargs): """ Enables you to split the prism layers after the initial prism layers are generated, to generate the total number of layers required. Specify the prism cell zones to be split and the number of divisions per layer. You can also choose to use the existing growth rate (default) or specify the growth rate to be used while splitting the prism layers. """ return PyMenu(self.service, "/mesh/prism/split/split").execute(*args, **kwargs) - class controls(metaclass=PyMenuMeta): + class controls(TUIMenu): """ Enters the prism controls menu. """ @@ -6551,6 +6680,7 @@ def __init__(self, path, service): self.post_ignore = self.__class__.post_ignore(path + [("post_ignore", None)], service) self.adjacent_zone = self.__class__.adjacent_zone(path + [("adjacent_zone", None)], service) self.zone_specific_growth = self.__class__.zone_specific_growth(path + [("zone_specific_growth", None)], service) + super().__init__(path, service) def merge_ignored_threads(self, *args, **kwargs): """ Enables you to automatically merge all ignored zones related to a base thread into a single thread. This option is enabled by default. When this option is disabled, more than one ignored thread will be generated per base thread. However, various zones can be created by ignoring this option. They are: @@ -6582,13 +6712,14 @@ def set_overset_prism_controls(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/prism/controls/set_overset_prism_controls").execute(*args, **kwargs) - class morph(metaclass=PyMenuMeta): + class morph(TUIMenu): """ Enters the prism morphing controls menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def improve_threshold(self, *args, **kwargs): """ Specifies the quality threshold used for improving the quality during the morphing operation. @@ -6605,13 +6736,14 @@ def morphing_convergence_limit(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/prism/controls/morph/morphing_convergence_limit").execute(*args, **kwargs) - class offset(metaclass=PyMenuMeta): + class offset(TUIMenu): """ Enters the prism offset controls menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def min_aspect_ratio(self, *args, **kwargs): """ Specifies the minimum aspect ratio (ratio of prism base length to prism layer height) for the prism cells. @@ -6623,13 +6755,14 @@ def first_aspect_ratio_min(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/prism/controls/offset/first_aspect_ratio_min").execute(*args, **kwargs) - class proximity(metaclass=PyMenuMeta): + class proximity(TUIMenu): """ Enters the prism proximity controls menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def gap_factor(self, *args, **kwargs): """ Controls the gap between the intersecting prisms layers in the proximity region with respect to the cell size of the prisms. @@ -6661,13 +6794,14 @@ def keep_first_layer_offsets(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/prism/controls/proximity/keep_first_layer_offsets").execute(*args, **kwargs) - class normal(metaclass=PyMenuMeta): + class normal(TUIMenu): """ Enters the prism normal controls menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def ignore_invalid_normals(self, *args, **kwargs): """ Enables you to ignore nodes that have poor normals. @@ -6709,13 +6843,14 @@ def orthogonal_layers(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/prism/controls/normal/orthogonal_layers").execute(*args, **kwargs) - class improve(metaclass=PyMenuMeta): + class improve(TUIMenu): """ Enters the prism smoothing controls menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def edge_swap_base_angle(self, *args, **kwargs): """ Specifies the maximum allowable angle between the normals of the base faces for skewness-driven edge swapping. @@ -6767,26 +6902,28 @@ def smooth_improve_prism_cells(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/prism/controls/improve/smooth_improve_prism_cells").execute(*args, **kwargs) - class post_ignore(metaclass=PyMenuMeta): + class post_ignore(TUIMenu): """ Contains options for setting the parameters for removing poor quality prism cells after the required prism layers are created. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def post_remove_cells(self, *args, **kwargs): """ Enables you to set the parameters for removing poor quality prism cells after the required prism layers are created. You can remove cells based on quality, intersection, interior warp, and feature edges. Specify options for removing additional cells in regions of high aspect ratio and feature angle, the number of cell rings to be removed around the marked cells, and options for smoothing the prism boundary and prism side height. """ return PyMenu(self.service, "/mesh/prism/controls/post_ignore/post_remove_cells").execute(*args, **kwargs) - class adjacent_zone(metaclass=PyMenuMeta): + class adjacent_zone(TUIMenu): """ Enters the prism adjacent zone controls menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def side_feature_angle(self, *args, **kwargs): """ Specifies the angle used for computing the feature normals. @@ -6798,13 +6935,14 @@ def project_adjacent_angle(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/prism/controls/adjacent_zone/project_adjacent_angle").execute(*args, **kwargs) - class zone_specific_growth(metaclass=PyMenuMeta): + class zone_specific_growth(TUIMenu): """ Enters the prism growth controls menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def apply_growth(self, *args, **kwargs): """ Applies the zone-specific growth parameters specified. @@ -6821,7 +6959,7 @@ def list_growth(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/prism/controls/zone_specific_growth/list_growth").execute(*args, **kwargs) - class pyramid(metaclass=PyMenuMeta): + class pyramid(TUIMenu): """ Enters the pyramid menu. """ @@ -6829,19 +6967,21 @@ def __init__(self, path, service): self.path = path self.service = service self.controls = self.__class__.controls(path + [("controls", None)], service) + super().__init__(path, service) def create(self, *args, **kwargs): """ Creates a layer of pyramids on the quad face zone. """ return PyMenu(self.service, "/mesh/pyramid/create").execute(*args, **kwargs) - class controls(metaclass=PyMenuMeta): + class controls(TUIMenu): """ Enters the pyramid controls menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def neighbor_angle(self, *args, **kwargs): """ Sets the threshold dihedral angle used to limit the neighboring faces considered for pyramid creation. For example, if the value is set to 110° and the angle between a given quadrilateral face and a neighboring triangular face is greater than 110°, the resulting pyramid will not include the triangular face. @@ -6863,20 +7003,21 @@ def offset_factor(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/pyramid/controls/offset_factor").execute(*args, **kwargs) - class thin_volume_mesh(metaclass=PyMenuMeta): + class thin_volume_mesh(TUIMenu): """ Creates a sweep-like mesh for a body occupying a thin gap. You define source and target boundary faces zones (the source face normal should point to the target). The source face mesh may be triangles or quads. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def create(self, *args, **kwargs): """ Initiates the dialog box to specify source and target faces and specify the following parameters """ return PyMenu(self.service, "/mesh/thin_volume_mesh/create").execute(*args, **kwargs) - class separate(metaclass=PyMenuMeta): + class separate(TUIMenu): """ Separates cells by various user-defined methods. """ @@ -6884,6 +7025,7 @@ def __init__(self, path, service): self.path = path self.service = service self.local_regions = self.__class__.local_regions(path + [("local_regions", None)], service) + super().__init__(path, service) def separate_cell_by_face(self, *args, **kwargs): """ Separates cells that are connected to a specified face zone into another cell zone. This separation method applies only to prism cells. @@ -6920,13 +7062,14 @@ def separate_cell_by_size(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/separate/separate_cell_by_size").execute(*args, **kwargs) - class local_regions(metaclass=PyMenuMeta): + class local_regions(TUIMenu): """ Enters the local refinement menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def define(self, *args, **kwargs): """ Enables you to define the parameters for the refinement region. @@ -6948,7 +7091,7 @@ def list_all_regions(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/separate/local_regions/list_all_regions").execute(*args, **kwargs) - class tet(metaclass=PyMenuMeta): + class tet(TUIMenu): """ Enters the tetrahedral mesh menu. """ @@ -6958,6 +7101,7 @@ def __init__(self, path, service): self.controls = self.__class__.controls(path + [("controls", None)], service) self.improve = self.__class__.improve(path + [("improve", None)], service) self.local_regions = self.__class__.local_regions(path + [("local_regions", None)], service) + super().__init__(path, service) def delete_virtual_cells(self, *args, **kwargs): """ Deletes virtual cells created due to the use of the keep-virtual-entities? option. @@ -6999,7 +7143,7 @@ def trace_path_between_cells(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/tet/trace_path_between_cells").execute(*args, **kwargs) - class controls(metaclass=PyMenuMeta): + class controls(TUIMenu): """ Enters the tet controls menu. """ @@ -7010,6 +7154,7 @@ def __init__(self, path, service): self.adv_front_method = self.__class__.adv_front_method(path + [("adv_front_method", None)], service) self.remove_slivers = self.__class__.remove_slivers(path + [("remove_slivers", None)], service) self.tet_improve = self.__class__.tet_improve(path + [("tet_improve", None)], service) + super().__init__(path, service) def cell_sizing(self, *args, **kwargs): """ Specifies the cell sizing function for refinement. You can select geometric, linear, none, or size-field as appropriate. @@ -7076,13 +7221,14 @@ def skewness_method(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/tet/controls/skewness_method").execute(*args, **kwargs) - class improve_mesh(metaclass=PyMenuMeta): + class improve_mesh(TUIMenu): """ Enters the improve mesh controls menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def improve(self, *args, **kwargs): """ Automatically improves the mesh. @@ -7104,7 +7250,7 @@ def laplace_smooth(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/tet/controls/improve_mesh/laplace_smooth").execute(*args, **kwargs) - class adv_front_method(metaclass=PyMenuMeta): + class adv_front_method(TUIMenu): """ Enters the advancing front refinement controls menu. """ @@ -7112,6 +7258,7 @@ def __init__(self, path, service): self.path = path self.service = service self.skew_improve = self.__class__.skew_improve(path + [("skew_improve", None)], service) + super().__init__(path, service) def refine_parameters(self, *args, **kwargs): """ Defines the cell zone improvement parameters for the advancing front method. @@ -7128,13 +7275,14 @@ def second_improve_params(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/tet/controls/adv_front_method/second_improve_params").execute(*args, **kwargs) - class skew_improve(metaclass=PyMenuMeta): + class skew_improve(TUIMenu): """ Enters the refine improve controls menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def boundary_sliver_skew(self, *args, **kwargs): """ Specifies the boundary sliver skewness for the advancing front method. This parameter is used for removing sliver cells along the boundary. @@ -7171,13 +7319,14 @@ def iterations(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/tet/controls/adv_front_method/skew_improve/iterations").execute(*args, **kwargs) - class remove_slivers(metaclass=PyMenuMeta): + class remove_slivers(TUIMenu): """ Enters the sliver remove controls menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def remove(self, *args, **kwargs): """ Enables/disables the automatic removal of slivers. @@ -7214,13 +7363,14 @@ def method(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/tet/controls/remove_slivers/method").execute(*args, **kwargs) - class tet_improve(metaclass=PyMenuMeta): + class tet_improve(TUIMenu): """ Improve cells controls. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def skew(self, *args, **kwargs): """ Remove skew. @@ -7242,13 +7392,14 @@ def iterations(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/tet/controls/tet_improve/iterations").execute(*args, **kwargs) - class improve(metaclass=PyMenuMeta): + class improve(TUIMenu): """ Enters the tet improve menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def swap_faces(self, *args, **kwargs): """ Performs interior face swapping to improve cell skewness. @@ -7300,13 +7451,14 @@ def skew_smooth_nodes(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/tet/improve/skew_smooth_nodes").execute(*args, **kwargs) - class local_regions(metaclass=PyMenuMeta): + class local_regions(TUIMenu): """ Enters the local refinement menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def activate(self, *args, **kwargs): """ Activates the specified regions for refinement. @@ -7353,13 +7505,14 @@ def ideal_area(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/tet/local_regions/ideal_area").execute(*args, **kwargs) - class manage(metaclass=PyMenuMeta): + class manage(TUIMenu): """ Enters the manage cell zones menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def adjacent_face_zones(self, *args, **kwargs): """ Lists all face zones that refer to the specified cell zone. @@ -7476,13 +7629,14 @@ def get_material_point(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/manage/get_material_point").execute(*args, **kwargs) - class cell_zone_conditions(metaclass=PyMenuMeta): + class cell_zone_conditions(TUIMenu): """ Contains options for copying or clearing cell zone conditions when a case file is read. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def copy(self, *args, **kwargs): """ Enables you to copy the cell zone conditions from the zone selected to the zones specified. @@ -7499,7 +7653,7 @@ def clear_all(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/cell_zone_conditions/clear_all").execute(*args, **kwargs) - class poly(metaclass=PyMenuMeta): + class poly(TUIMenu): """ Enters the polyhedral mesh generation menu. """ @@ -7508,6 +7662,7 @@ def __init__(self, path, service): self.service = service self.controls = self.__class__.controls(path + [("controls", None)], service) self.local_regions = self.__class__.local_regions(path + [("local_regions", None)], service) + super().__init__(path, service) def improve(self, *args, **kwargs): """ Allows you to improve the polyhedral mesh quality based on the quality-method. @@ -7530,7 +7685,7 @@ def quality_method(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/poly/quality_method").execute(*args, **kwargs) - class controls(metaclass=PyMenuMeta): + class controls(TUIMenu): """ Enters the controls menu for setting poly parameters. """ @@ -7539,6 +7694,7 @@ def __init__(self, path, service): self.service = service self.smooth_controls = self.__class__.smooth_controls(path + [("smooth_controls", None)], service) self.prism = self.__class__.prism(path + [("prism", None)], service) + super().__init__(path, service) def cell_sizing(self, *args, **kwargs): """ Sets cell volume distribution function as geometric, linear, or size-field. @@ -7585,13 +7741,14 @@ def remesh_skew(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/poly/controls/remesh_skew").execute(*args, **kwargs) - class smooth_controls(metaclass=PyMenuMeta): + class smooth_controls(TUIMenu): """ Enters the menu for setting smoothing parameters for poly mesh. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def laplace_smooth_iterations(self, *args, **kwargs): """ Sets the number of passes for tet-cell Laplace smoothing during the poly mesh generation phase. @@ -7633,13 +7790,14 @@ def smooth_skew(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/poly/controls/smooth_controls/smooth_skew").execute(*args, **kwargs) - class prism(metaclass=PyMenuMeta): + class prism(TUIMenu): """ Poly prism transition controls. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def apply_growth(self, *args, **kwargs): """ Apply growth settings. @@ -7656,13 +7814,14 @@ def list_growth(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/poly/controls/prism/list_growth").execute(*args, **kwargs) - class local_regions(metaclass=PyMenuMeta): + class local_regions(TUIMenu): """ Enters the local refinement menu. Poly meshing follows tet meshing. These commands behave like the equivalent commands under /mesh/tet/local-regions/. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def activate(self, *args, **kwargs): """ Activates the specified regions for refinement. @@ -7709,7 +7868,7 @@ def ideal_area(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/poly/local_regions/ideal_area").execute(*args, **kwargs) - class poly_hexcore(metaclass=PyMenuMeta): + class poly_hexcore(TUIMenu): """ Enters the menu for poly-hexcore mesh. """ @@ -7717,14 +7876,16 @@ def __init__(self, path, service): self.path = path self.service = service self.controls = self.__class__.controls(path + [("controls", None)], service) + super().__init__(path, service) - class controls(metaclass=PyMenuMeta): + class controls(TUIMenu): """ Enters the menu for setting parameters for poly-hexcore mesh. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def mark_core_region_cell_type_as_hex(self, *args, **kwargs): """ Determines whether or not to apply hexahedra cells in the core region of the mesh. The default value is yes.  @@ -7741,26 +7902,28 @@ def only_polyhedra_for_selected_regions(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/poly_hexcore/controls/only_polyhedra_for_selected_regions").execute(*args, **kwargs) - class auto_mesh_controls(metaclass=PyMenuMeta): + class auto_mesh_controls(TUIMenu): """ Enters the auto-mesh-controls submenu """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def backup_object(self, *args, **kwargs): """ Enables creation of a backup of the surface mesh before volume meshing starts. This option is enabled by default. """ return PyMenu(self.service, "/mesh/auto_mesh_controls/backup_object").execute(*args, **kwargs) - class scoped_prisms(metaclass=PyMenuMeta): + class scoped_prisms(TUIMenu): """ Contains options for creating scoped prism controls for mesh objects. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def create(self, *args, **kwargs): """ Creates a new scoped prism control based on the parameters and scope specified. Specify the name, offset method, first height or aspect ratio, number of layers, and rate or last percent. Select the mesh object and set the scope (fluid-regions, named-regions, or solid-regions). Specify the zones to grow prisms (all-zones, only-walls, selected-face-zones, or selected-labels, or solid-fluid-interface). When named-regions and/or selected-face-zones or selected-labels are selected, specify the volume and/or boundary scope. If interior baffle zones are selected, retain the option to grow prisms on both sides of the baffles or disable it to grow prisms on one side. @@ -7812,7 +7975,7 @@ def set_advanced_controls(self, *args, **kwargs): """ return PyMenu(self.service, "/mesh/scoped_prisms/set_advanced_controls").execute(*args, **kwargs) - class display(metaclass=PyMenuMeta): + class display(TUIMenu): """ Enter the display menu. """ @@ -7828,6 +7991,7 @@ def __init__(self, path, service): self.objects = self.__class__.objects(path + [("objects", None)], service) self.zones = self.__class__.zones(path + [("zones", None)], service) self.advanced_rendering = self.__class__.advanced_rendering(path + [("advanced_rendering", None)], service) + super().__init__(path, service) def annotate(self, *args, **kwargs): """ Adds annotation text to a graphics window. It will prompt you for a string to use as the annotation text, and then a dialog box will prompt you to select a screen location using the mouse-probe button on your mouse. @@ -7909,7 +8073,7 @@ def update_layout(self, *args, **kwargs): """ return PyMenu(self.service, "/display/update_layout").execute(*args, **kwargs) - class set(metaclass=PyMenuMeta): + class set(TUIMenu): """ Enables you to enter the set menu to set the display parameters. """ @@ -7922,6 +8086,7 @@ def __init__(self, path, service): self.rendering_options = self.__class__.rendering_options(path + [("rendering_options", None)], service) self.styles = self.__class__.styles(path + [("styles", None)], service) self.windows = self.__class__.windows(path + [("windows", None)], service) + super().__init__(path, service) def highlight_tree_selection(self, *args, **kwargs): """ Turn on/off outline display of tree selection in graphics window. @@ -7983,7 +8148,7 @@ def title(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/title").execute(*args, **kwargs) - class colors(metaclass=PyMenuMeta): + class colors(TUIMenu): """ Enables you to enter the colors options menu. """ @@ -7992,6 +8157,7 @@ def __init__(self, path, service): self.service = service self.by_type = self.__class__.by_type(path + [("by_type", None)], service) self.by_surface = self.__class__.by_surface(path + [("by_surface", None)], service) + super().__init__(path, service) def background(self, *args, **kwargs): """ Sets the background (window) color. @@ -8123,7 +8289,7 @@ def graphics_color_theme(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/graphics_color_theme").execute(*args, **kwargs) - class by_type(metaclass=PyMenuMeta): + class by_type(TUIMenu): """ Enter the zone type color and material assignment menu. """ @@ -8131,6 +8297,7 @@ def __init__(self, path, service): self.path = path self.service = service self.type_name = self.__class__.type_name(path + [("type_name", None)], service) + super().__init__(path, service) def only_list_case_boundaries(self, *args, **kwargs): """ Only list the boundary types that are assigned in this case. @@ -8147,7 +8314,7 @@ def reset(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/by_type/reset").execute(*args, **kwargs) - class type_name(metaclass=PyMenuMeta): + class type_name(TUIMenu): """ Select the boundary type to specify colors and/or materials. """ @@ -8169,14 +8336,16 @@ def __init__(self, path, service): self.symmetry = self.__class__.symmetry(path + [("symmetry", None)], service) self.traction = self.__class__.traction(path + [("traction", None)], service) self.wall = self.__class__.wall(path + [("wall", None)], service) + super().__init__(path, service) - class axis(metaclass=PyMenuMeta): + class axis(TUIMenu): """ Set the material and/or color for the selected boundary type. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color(self, *args, **kwargs): """ Set a color for the selected boundary type. @@ -8188,13 +8357,14 @@ def material(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/by_type/type_name/axis/material").execute(*args, **kwargs) - class far_field(metaclass=PyMenuMeta): + class far_field(TUIMenu): """ Set the material and/or color for the selected boundary type. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color(self, *args, **kwargs): """ Set a color for the selected boundary type. @@ -8206,13 +8376,14 @@ def material(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/by_type/type_name/far_field/material").execute(*args, **kwargs) - class free_surface(metaclass=PyMenuMeta): + class free_surface(TUIMenu): """ Set the material and/or color for the selected boundary type. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color(self, *args, **kwargs): """ Set a color for the selected boundary type. @@ -8224,13 +8395,14 @@ def material(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/by_type/type_name/free_surface/material").execute(*args, **kwargs) - class inlet(metaclass=PyMenuMeta): + class inlet(TUIMenu): """ Set the material and/or color for the selected boundary type. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color(self, *args, **kwargs): """ Set a color for the selected boundary type. @@ -8242,13 +8414,14 @@ def material(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/by_type/type_name/inlet/material").execute(*args, **kwargs) - class interface(metaclass=PyMenuMeta): + class interface(TUIMenu): """ Set the material and/or color for the selected boundary type. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color(self, *args, **kwargs): """ Set a color for the selected boundary type. @@ -8260,13 +8433,14 @@ def material(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/by_type/type_name/interface/material").execute(*args, **kwargs) - class interior(metaclass=PyMenuMeta): + class interior(TUIMenu): """ Set the material and/or color for the selected boundary type. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color(self, *args, **kwargs): """ Set a color for the selected boundary type. @@ -8278,13 +8452,14 @@ def material(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/by_type/type_name/interior/material").execute(*args, **kwargs) - class internal(metaclass=PyMenuMeta): + class internal(TUIMenu): """ Set the material and/or color for the selected boundary type. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color(self, *args, **kwargs): """ Set a color for the selected boundary type. @@ -8296,13 +8471,14 @@ def material(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/by_type/type_name/internal/material").execute(*args, **kwargs) - class outlet(metaclass=PyMenuMeta): + class outlet(TUIMenu): """ Set the material and/or color for the selected boundary type. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color(self, *args, **kwargs): """ Set a color for the selected boundary type. @@ -8314,13 +8490,14 @@ def material(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/by_type/type_name/outlet/material").execute(*args, **kwargs) - class overset(metaclass=PyMenuMeta): + class overset(TUIMenu): """ Set the material and/or color for the selected boundary type. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color(self, *args, **kwargs): """ Set a color for the selected boundary type. @@ -8332,13 +8509,14 @@ def material(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/by_type/type_name/overset/material").execute(*args, **kwargs) - class periodic(metaclass=PyMenuMeta): + class periodic(TUIMenu): """ Set the material and/or color for the selected boundary type. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color(self, *args, **kwargs): """ Set a color for the selected boundary type. @@ -8350,13 +8528,14 @@ def material(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/by_type/type_name/periodic/material").execute(*args, **kwargs) - class rans_les_interface(metaclass=PyMenuMeta): + class rans_les_interface(TUIMenu): """ Set the material and/or color for the selected boundary type. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color(self, *args, **kwargs): """ Set a color for the selected boundary type. @@ -8368,13 +8547,14 @@ def material(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/by_type/type_name/rans_les_interface/material").execute(*args, **kwargs) - class surface(metaclass=PyMenuMeta): + class surface(TUIMenu): """ Set the material and/or color for the selected boundary type. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color(self, *args, **kwargs): """ Set a color for the selected boundary type. @@ -8386,13 +8566,14 @@ def material(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/by_type/type_name/surface/material").execute(*args, **kwargs) - class symmetry(metaclass=PyMenuMeta): + class symmetry(TUIMenu): """ Set the material and/or color for the selected boundary type. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color(self, *args, **kwargs): """ Set a color for the selected boundary type. @@ -8404,13 +8585,14 @@ def material(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/by_type/type_name/symmetry/material").execute(*args, **kwargs) - class traction(metaclass=PyMenuMeta): + class traction(TUIMenu): """ Set the material and/or color for the selected boundary type. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color(self, *args, **kwargs): """ Set a color for the selected boundary type. @@ -8422,13 +8604,14 @@ def material(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/by_type/type_name/traction/material").execute(*args, **kwargs) - class wall(metaclass=PyMenuMeta): + class wall(TUIMenu): """ Set the material and/or color for the selected boundary type. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color(self, *args, **kwargs): """ Set a color for the selected boundary type. @@ -8440,13 +8623,14 @@ def material(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/by_type/type_name/wall/material").execute(*args, **kwargs) - class by_surface(metaclass=PyMenuMeta): + class by_surface(TUIMenu): """ Enter the surface(s) color and material assignment menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def surfaces(self, *args, **kwargs): """ Select the surface(s) to specify colors and/or materials. @@ -8473,7 +8657,7 @@ def list_surfaces_by_material(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/colors/by_surface/list_surfaces_by_material").execute(*args, **kwargs) - class picture(metaclass=PyMenuMeta): + class picture(TUIMenu): """ Saves a hardcopy file of the active graphics window. """ @@ -8482,6 +8666,7 @@ def __init__(self, path, service): self.service = service self.color_mode = self.__class__.color_mode(path + [("color_mode", None)], service) self.driver = self.__class__.driver(path + [("driver", None)], service) + super().__init__(path, service) def invert_background(self, *args, **kwargs): """ Enables/disables the exchange of foreground/background colors for hardcopy files. @@ -8528,13 +8713,14 @@ def jpeg_hardcopy_quality(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/picture/jpeg_hardcopy_quality").execute(*args, **kwargs) - class color_mode(metaclass=PyMenuMeta): + class color_mode(TUIMenu): """ Contains the available color modes. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def color(self, *args, **kwargs): """ Selects full color and plots the hardcopy in color. @@ -8556,7 +8742,7 @@ def list(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/picture/color_mode/list").execute(*args, **kwargs) - class driver(metaclass=PyMenuMeta): + class driver(TUIMenu): """ Contains the available hardcopy formats. """ @@ -8564,6 +8750,7 @@ def __init__(self, path, service): self.path = path self.service = service self.post_format = self.__class__.post_format(path + [("post_format", None)], service) + super().__init__(path, service) def dump_window(self, *args, **kwargs): """ Sets the command to dump a graphics window to a file. @@ -8630,13 +8817,14 @@ def options(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/picture/driver/options").execute(*args, **kwargs) - class post_format(metaclass=PyMenuMeta): + class post_format(TUIMenu): """ Contains commands for setting the PostScript driver format and save files in PS files that can be printed quickly. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def fast_raster(self, *args, **kwargs): """ Enables a raster file that may be larger than the standard raster file, but will print much more quickly. @@ -8658,7 +8846,7 @@ def vector(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/picture/driver/post_format/vector").execute(*args, **kwargs) - class lights(metaclass=PyMenuMeta): + class lights(TUIMenu): """ Enters the lights menu. """ @@ -8666,6 +8854,7 @@ def __init__(self, path, service): self.path = path self.service = service self.lighting_interpolation = self.__class__.lighting_interpolation(path + [("lighting_interpolation", None)], service) + super().__init__(path, service) def lights_on(self, *args, **kwargs): """ Enables/disables the display of all lights. @@ -8687,13 +8876,14 @@ def headlight_on(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/lights/headlight_on").execute(*args, **kwargs) - class lighting_interpolation(metaclass=PyMenuMeta): + class lighting_interpolation(TUIMenu): """ Sets the lighting interpolation method to be used. You can choose automatic, flat, gouraud, or phong. "Automatic" automatically picks the best lighting method for the display in the graphics window. Flat is the most basic method, and the others are more sophisticated and provide smoother gradations of color. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def automatic(self, *args, **kwargs): """ Fluent automatically picks the best lighting method for the display in the graphics window. @@ -8715,13 +8905,14 @@ def phong(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/lights/lighting_interpolation/phong").execute(*args, **kwargs) - class rendering_options(metaclass=PyMenuMeta): + class rendering_options(TUIMenu): """ Contains the commands that enable you to set options that determine how the scene is rendered. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def auto_spin(self, *args, **kwargs): """ Enables mouse view rotations to continue to spin the display after the button is released. @@ -8793,13 +8984,14 @@ def show_colormap(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/rendering_options/show_colormap").execute(*args, **kwargs) - class styles(metaclass=PyMenuMeta): + class styles(TUIMenu): """ Contains commands for setting the display style for the different types of nodes and faces that can be displayed. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cell_quality(self, *args, **kwargs): """ Indicates cells within the specified cell quality range. @@ -8866,7 +9058,7 @@ def unused(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/styles/unused").execute(*args, **kwargs) - class windows(metaclass=PyMenuMeta): + class windows(TUIMenu): """ Enters the windows options menu, which contains commands that enable you to customize the relative positions of sub-windows inside the active graphics window. """ @@ -8879,6 +9071,7 @@ def __init__(self, path, service): self.text = self.__class__.text(path + [("text", None)], service) self.video = self.__class__.video(path + [("video", None)], service) self.xy = self.__class__.xy(path + [("xy", None)], service) + super().__init__(path, service) def aspect_ratio(self, *args, **kwargs): """ Sets the aspect ratio of the active window. @@ -8900,13 +9093,14 @@ def logo_color(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/windows/logo_color").execute(*args, **kwargs) - class axes(metaclass=PyMenuMeta): + class axes(TUIMenu): """ Enters the axes window options menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def border(self, *args, **kwargs): """ Sets whether or not to draw a border around the axes window. @@ -8933,13 +9127,14 @@ def visible(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/windows/axes/visible").execute(*args, **kwargs) - class main(metaclass=PyMenuMeta): + class main(TUIMenu): """ Enters the main view window options menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def border(self, *args, **kwargs): """ Sets whether or not to draw a border around the main viewing window. @@ -8971,13 +9166,14 @@ def visible(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/windows/main/visible").execute(*args, **kwargs) - class scale(metaclass=PyMenuMeta): + class scale(TUIMenu): """ Enters the color scale window options menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def border(self, *args, **kwargs): """ Sets whether or not to draw a border around the color scale window. @@ -9034,13 +9230,14 @@ def alignment(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/windows/scale/alignment").execute(*args, **kwargs) - class text(metaclass=PyMenuMeta): + class text(TUIMenu): """ Enters the text window options menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def application(self, *args, **kwargs): """ Shows or hides the application name in the picture. @@ -9092,13 +9289,14 @@ def visible(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/windows/text/visible").execute(*args, **kwargs) - class video(metaclass=PyMenuMeta): + class video(TUIMenu): """ Contains options for modifying a video. This menu is not relevant for the meshing mode. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def background(self, *args, **kwargs): """ Sets the background color of the graphics window. The color is specified as a string of three comma-separated numbers between 0 and 1, representing red, green, and blue. For example, to change the background from black (default) to gray, you would enter ".5,.5,.5" after selecting the background command. @@ -9125,13 +9323,14 @@ def pixel_size(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/windows/video/pixel_size").execute(*args, **kwargs) - class xy(metaclass=PyMenuMeta): + class xy(TUIMenu): """ Enters the XY plot window options menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def border(self, *args, **kwargs): """ Sets whether or not to draw a border around the XY plot window. @@ -9163,13 +9362,14 @@ def visible(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set/windows/xy/visible").execute(*args, **kwargs) - class set_grid(metaclass=PyMenuMeta): + class set_grid(TUIMenu): """ Contains options controlling the display of the grid. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def all_cells(self, *args, **kwargs): """ Enables/disables the display of all cells. @@ -9306,7 +9506,7 @@ def default(self, *args, **kwargs): """ return PyMenu(self.service, "/display/set_grid/default").execute(*args, **kwargs) - class views(metaclass=PyMenuMeta): + class views(TUIMenu): """ Enters the view window options menu. """ @@ -9314,6 +9514,7 @@ def __init__(self, path, service): self.path = path self.service = service self.camera = self.__class__.camera(path + [("camera", None)], service) + super().__init__(path, service) def auto_scale(self, *args, **kwargs): """ Scales and centers the current scene without changing its orientation. @@ -9365,13 +9566,14 @@ def write_views(self, *args, **kwargs): """ return PyMenu(self.service, "/display/views/write_views").execute(*args, **kwargs) - class camera(metaclass=PyMenuMeta): + class camera(TUIMenu): """ Contains commands to set the camera options. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def dolly_camera(self, *args, **kwargs): """ Enables you to move the camera left, right, up, down, in, and out. @@ -9423,13 +9625,14 @@ def zoom_camera(self, *args, **kwargs): """ return PyMenu(self.service, "/display/views/camera/zoom_camera").execute(*args, **kwargs) - class display_states(metaclass=PyMenuMeta): + class display_states(TUIMenu): """ Enter the display states menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def list(self, *args, **kwargs): """ Print the names of the existing display states to the console. @@ -9477,13 +9680,14 @@ def create(self, *args, **kwargs): """ return PyMenu(self.service, "/display/display_states/create").execute(*args, **kwargs) - class xy_plot(metaclass=PyMenuMeta): + class xy_plot(TUIMenu): """ Enters the XY plot menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def file(self, *args, **kwargs): """ Enables you to choose a file from which to create an xy plot. @@ -9505,13 +9709,14 @@ def set(self, *args, **kwargs): """ return PyMenu(self.service, "/display/xy_plot/set").execute(*args, **kwargs) - class update_scene(metaclass=PyMenuMeta): + class update_scene(TUIMenu): """ Contains commands that enable you to update the scene description. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def select_geometry(self, *args, **kwargs): """ Enables you to select the geometry to be updated. @@ -9563,21 +9768,14 @@ def set_frame(self, *args, **kwargs): """ return PyMenu(self.service, "/display/update_scene/set_frame").execute(*args, **kwargs) - class objects(metaclass=PyMenuMeta): + class objects(TUIMenu): """ Contains commands for displaying objects. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.xy_plot = self.__class__.xy_plot(path + [("xy_plot", None)], None, service) - self.mesh = self.__class__.mesh(path + [("mesh", None)], None, service) - self.contour = self.__class__.contour(path + [("contour", None)], None, service) - self.vector = self.__class__.vector(path + [("vector", None)], None, service) - self.pathlines = self.__class__.pathlines(path + [("pathlines", None)], None, service) - self.particle_tracks = self.__class__.particle_tracks(path + [("particle_tracks", None)], None, service) - self.scene = self.__class__.scene(path + [("scene", None)], None, service) + super().__init__(path, service) def show_all(self, *args, **kwargs): """ Unhides all the objects in the geometry and displays them. @@ -9634,2544 +9832,14 @@ def isolate_objects(self, *args, **kwargs): """ return PyMenu(self.service, "/display/objects/isolate_objects").execute(*args, **kwargs) - class xy_plot(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.uid = self.__class__.uid(path + [("uid", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - self.plot_direction = self.__class__.plot_direction(path + [("plot_direction", None)], service) - self.x_axis_function = self.__class__.x_axis_function(path + [("x_axis_function", None)], service) - self.y_axis_function = self.__class__.y_axis_function(path + [("y_axis_function", None)], service) - self.surfaces_list = self.__class__.surfaces_list(path + [("surfaces_list", None)], service) - self.physics = self.__class__.physics(path + [("physics", None)], service) - self.geometry = self.__class__.geometry(path + [("geometry", None)], service) - self.surfaces = self.__class__.surfaces(path + [("surfaces", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uid(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.node_values = self.__class__.node_values(path + [("node_values", None)], service) - self.position_on_x_axis = self.__class__.position_on_x_axis(path + [("position_on_x_axis", None)], service) - self.position_on_y_axis = self.__class__.position_on_y_axis(path + [("position_on_y_axis", None)], service) - - class node_values(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class position_on_x_axis(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class position_on_y_axis(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class plot_direction(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.direction_vector = self.__class__.direction_vector(path + [("direction_vector", None)], service) - self.curve_length = self.__class__.curve_length(path + [("curve_length", None)], service) - - class direction_vector(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.x_component = self.__class__.x_component(path + [("x_component", None)], service) - self.y_component = self.__class__.y_component(path + [("y_component", None)], service) - self.z_component = self.__class__.z_component(path + [("z_component", None)], service) - - class x_component(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class y_component(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class z_component(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class curve_length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.default = self.__class__.default(path + [("default", None)], service) - self.reverse = self.__class__.reverse(path + [("reverse", None)], service) - - class default(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class reverse(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class x_axis_function(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class y_axis_function(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces_list(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class physics(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geometry(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mesh(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - self.edge_type = self.__class__.edge_type(path + [("edge_type", None)], service) - self.shrink_factor = self.__class__.shrink_factor(path + [("shrink_factor", None)], service) - self.surfaces_list = self.__class__.surfaces_list(path + [("surfaces_list", None)], service) - self.coloring = self.__class__.coloring(path + [("coloring", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - self.physics = self.__class__.physics(path + [("physics", None)], service) - self.geometry = self.__class__.geometry(path + [("geometry", None)], service) - self.surfaces = self.__class__.surfaces(path + [("surfaces", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.nodes = self.__class__.nodes(path + [("nodes", None)], service) - self.edges = self.__class__.edges(path + [("edges", None)], service) - self.faces = self.__class__.faces(path + [("faces", None)], service) - self.partitions = self.__class__.partitions(path + [("partitions", None)], service) - self.overset = self.__class__.overset(path + [("overset", None)], service) - self.gap = self.__class__.gap(path + [("gap", None)], service) - - class nodes(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class edges(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class faces(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class partitions(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class overset(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class gap(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class edge_type(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.all = self.__class__.all(path + [("all", None)], service) - self.feature = self.__class__.feature(path + [("feature", None)], service) - self.outline = self.__class__.outline(path + [("outline", None)], service) - - class all(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class feature(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.feature_angle = self.__class__.feature_angle(path + [("feature_angle", None)], service) - - class feature_angle(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class outline(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class shrink_factor(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces_list(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coloring(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.automatic = self.__class__.automatic(path + [("automatic", None)], service) - self.manual = self.__class__.manual(path + [("manual", None)], service) - - class automatic(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.type = self.__class__.type(path + [("type", None)], service) - self.id = self.__class__.id(path + [("id", None)], service) - self.normal = self.__class__.normal(path + [("normal", None)], service) - self.partition = self.__class__.partition(path + [("partition", None)], service) - - class type(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class id(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class normal(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class partition(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class manual(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.faces = self.__class__.faces(path + [("faces", None)], service) - self.edges = self.__class__.edges(path + [("edges", None)], service) - self.nodes = self.__class__.nodes(path + [("nodes", None)], service) - self.material_color = self.__class__.material_color(path + [("material_color", None)], service) - - class faces(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class edges(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nodes(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class material_color(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class display_state_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class physics(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geometry(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class contour(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.field = self.__class__.field(path + [("field", None)], service) - self.filled = self.__class__.filled(path + [("filled", None)], service) - self.boundary_values = self.__class__.boundary_values(path + [("boundary_values", None)], service) - self.contour_lines = self.__class__.contour_lines(path + [("contour_lines", None)], service) - self.node_values = self.__class__.node_values(path + [("node_values", None)], service) - self.surfaces_list = self.__class__.surfaces_list(path + [("surfaces_list", None)], service) - self.range_option = self.__class__.range_option(path + [("range_option", None)], service) - self.coloring = self.__class__.coloring(path + [("coloring", None)], service) - self.color_map = self.__class__.color_map(path + [("color_map", None)], service) - self.draw_mesh = self.__class__.draw_mesh(path + [("draw_mesh", None)], service) - self.mesh_object = self.__class__.mesh_object(path + [("mesh_object", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - self.physics = self.__class__.physics(path + [("physics", None)], service) - self.geometry = self.__class__.geometry(path + [("geometry", None)], service) - self.surfaces = self.__class__.surfaces(path + [("surfaces", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class filled(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class boundary_values(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class contour_lines(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class node_values(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces_list(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class range_option(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_range_on = self.__class__.auto_range_on(path + [("auto_range_on", None)], service) - self.auto_range_off = self.__class__.auto_range_off(path + [("auto_range_off", None)], service) - - class auto_range_on(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.global_range = self.__class__.global_range(path + [("global_range", None)], service) - - class global_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class auto_range_off(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.clip_to_range = self.__class__.clip_to_range(path + [("clip_to_range", None)], service) - self.minimum = self.__class__.minimum(path + [("minimum", None)], service) - self.maximum = self.__class__.maximum(path + [("maximum", None)], service) - - class clip_to_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class minimum(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class maximum(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coloring(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.smooth = self.__class__.smooth(path + [("smooth", None)], service) - self.banded = self.__class__.banded(path + [("banded", None)], service) - - class smooth(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class banded(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color_map(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.visible = self.__class__.visible(path + [("visible", None)], service) - self.size = self.__class__.size(path + [("size", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) - self.log_scale = self.__class__.log_scale(path + [("log_scale", None)], service) - self.format = self.__class__.format(path + [("format", None)], service) - self.user_skip = self.__class__.user_skip(path + [("user_skip", None)], service) - self.show_all = self.__class__.show_all(path + [("show_all", None)], service) - self.position = self.__class__.position(path + [("position", None)], service) - self.font_name = self.__class__.font_name(path + [("font_name", None)], service) - self.font_automatic = self.__class__.font_automatic(path + [("font_automatic", None)], service) - self.font_size = self.__class__.font_size(path + [("font_size", None)], service) - self.length = self.__class__.length(path + [("length", None)], service) - self.width = self.__class__.width(path + [("width", None)], service) - - class visible(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class log_scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class format(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class user_skip(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class show_all(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class position(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_automatic(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class width(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class draw_mesh(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mesh_object(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class display_state_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class physics(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geometry(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vector(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.field = self.__class__.field(path + [("field", None)], service) - self.vector_field = self.__class__.vector_field(path + [("vector_field", None)], service) - self.surfaces_list = self.__class__.surfaces_list(path + [("surfaces_list", None)], service) - self.scale = self.__class__.scale(path + [("scale", None)], service) - self.style = self.__class__.style(path + [("style", None)], service) - self.skip = self.__class__.skip(path + [("skip", None)], service) - self.vector_opt = self.__class__.vector_opt(path + [("vector_opt", None)], service) - self.range_option = self.__class__.range_option(path + [("range_option", None)], service) - self.color_map = self.__class__.color_map(path + [("color_map", None)], service) - self.draw_mesh = self.__class__.draw_mesh(path + [("draw_mesh", None)], service) - self.mesh_object = self.__class__.mesh_object(path + [("mesh_object", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - self.physics = self.__class__.physics(path + [("physics", None)], service) - self.geometry = self.__class__.geometry(path + [("geometry", None)], service) - self.surfaces = self.__class__.surfaces(path + [("surfaces", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vector_field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces_list(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_scale = self.__class__.auto_scale(path + [("auto_scale", None)], service) - self.scale_f = self.__class__.scale_f(path + [("scale_f", None)], service) - - class auto_scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class scale_f(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class style(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class skip(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vector_opt(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.in_plane = self.__class__.in_plane(path + [("in_plane", None)], service) - self.fixed_length = self.__class__.fixed_length(path + [("fixed_length", None)], service) - self.x_comp = self.__class__.x_comp(path + [("x_comp", None)], service) - self.y_comp = self.__class__.y_comp(path + [("y_comp", None)], service) - self.z_comp = self.__class__.z_comp(path + [("z_comp", None)], service) - self.scale_head = self.__class__.scale_head(path + [("scale_head", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) - - class in_plane(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class fixed_length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class x_comp(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class y_comp(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class z_comp(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class scale_head(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class range_option(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_range_on = self.__class__.auto_range_on(path + [("auto_range_on", None)], service) - self.auto_range_off = self.__class__.auto_range_off(path + [("auto_range_off", None)], service) - - class auto_range_on(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.global_range = self.__class__.global_range(path + [("global_range", None)], service) - - class global_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class auto_range_off(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.clip_to_range = self.__class__.clip_to_range(path + [("clip_to_range", None)], service) - self.minimum = self.__class__.minimum(path + [("minimum", None)], service) - self.maximum = self.__class__.maximum(path + [("maximum", None)], service) - - class clip_to_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class minimum(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class maximum(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color_map(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.visible = self.__class__.visible(path + [("visible", None)], service) - self.size = self.__class__.size(path + [("size", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) - self.log_scale = self.__class__.log_scale(path + [("log_scale", None)], service) - self.format = self.__class__.format(path + [("format", None)], service) - self.user_skip = self.__class__.user_skip(path + [("user_skip", None)], service) - self.show_all = self.__class__.show_all(path + [("show_all", None)], service) - self.position = self.__class__.position(path + [("position", None)], service) - self.font_name = self.__class__.font_name(path + [("font_name", None)], service) - self.font_automatic = self.__class__.font_automatic(path + [("font_automatic", None)], service) - self.font_size = self.__class__.font_size(path + [("font_size", None)], service) - self.length = self.__class__.length(path + [("length", None)], service) - self.width = self.__class__.width(path + [("width", None)], service) - - class visible(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class log_scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class format(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class user_skip(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class show_all(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class position(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_automatic(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class width(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class draw_mesh(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mesh_object(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class display_state_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class physics(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geometry(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class pathlines(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.uid = self.__class__.uid(path + [("uid", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - self.range = self.__class__.range(path + [("range", None)], service) - self.style_attribute = self.__class__.style_attribute(path + [("style_attribute", None)], service) - self.accuracy_control = self.__class__.accuracy_control(path + [("accuracy_control", None)], service) - self.plot = self.__class__.plot(path + [("plot", None)], service) - self.step = self.__class__.step(path + [("step", None)], service) - self.skip = self.__class__.skip(path + [("skip", None)], service) - self.coarsen = self.__class__.coarsen(path + [("coarsen", None)], service) - self.onzone = self.__class__.onzone(path + [("onzone", None)], service) - self.field = self.__class__.field(path + [("field", None)], service) - self.surfaces_list = self.__class__.surfaces_list(path + [("surfaces_list", None)], service) - self.velocity_domain = self.__class__.velocity_domain(path + [("velocity_domain", None)], service) - self.color_map = self.__class__.color_map(path + [("color_map", None)], service) - self.draw_mesh = self.__class__.draw_mesh(path + [("draw_mesh", None)], service) - self.mesh_object = self.__class__.mesh_object(path + [("mesh_object", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - self.physics = self.__class__.physics(path + [("physics", None)], service) - self.geometry = self.__class__.geometry(path + [("geometry", None)], service) - self.surfaces = self.__class__.surfaces(path + [("surfaces", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uid(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.oil_flow = self.__class__.oil_flow(path + [("oil_flow", None)], service) - self.reverse = self.__class__.reverse(path + [("reverse", None)], service) - self.node_values = self.__class__.node_values(path + [("node_values", None)], service) - self.relative = self.__class__.relative(path + [("relative", None)], service) - - class oil_flow(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class reverse(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class node_values(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class relative(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_range = self.__class__.auto_range(path + [("auto_range", None)], service) - self.clip_to_range = self.__class__.clip_to_range(path + [("clip_to_range", None)], service) - - class auto_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class clip_to_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.min_value = self.__class__.min_value(path + [("min_value", None)], service) - self.max_value = self.__class__.max_value(path + [("max_value", None)], service) - - class min_value(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class max_value(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class style_attribute(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.style = self.__class__.style(path + [("style", None)], service) - self.line_width = self.__class__.line_width(path + [("line_width", None)], service) - self.arrow_space = self.__class__.arrow_space(path + [("arrow_space", None)], service) - self.arrow_scale = self.__class__.arrow_scale(path + [("arrow_scale", None)], service) - self.marker_size = self.__class__.marker_size(path + [("marker_size", None)], service) - self.sphere_size = self.__class__.sphere_size(path + [("sphere_size", None)], service) - self.sphere_lod = self.__class__.sphere_lod(path + [("sphere_lod", None)], service) - self.radius = self.__class__.radius(path + [("radius", None)], service) - self.ribbon = self.__class__.ribbon(path + [("ribbon", None)], service) - - class style(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class line_width(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class arrow_space(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class arrow_scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class marker_size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sphere_size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sphere_lod(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class radius(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ribbon(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.field = self.__class__.field(path + [("field", None)], service) - self.scalefactor = self.__class__.scalefactor(path + [("scalefactor", None)], service) - - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class scalefactor(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class accuracy_control(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.step_size = self.__class__.step_size(path + [("step_size", None)], service) - self.tolerance = self.__class__.tolerance(path + [("tolerance", None)], service) - - class step_size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class tolerance(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class plot(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.x_axis_function = self.__class__.x_axis_function(path + [("x_axis_function", None)], service) - self.enabled = self.__class__.enabled(path + [("enabled", None)], service) - - class x_axis_function(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class enabled(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class step(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class skip(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coarsen(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class onzone(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces_list(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class velocity_domain(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color_map(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.visible = self.__class__.visible(path + [("visible", None)], service) - self.size = self.__class__.size(path + [("size", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) - self.log_scale = self.__class__.log_scale(path + [("log_scale", None)], service) - self.format = self.__class__.format(path + [("format", None)], service) - self.user_skip = self.__class__.user_skip(path + [("user_skip", None)], service) - self.show_all = self.__class__.show_all(path + [("show_all", None)], service) - self.position = self.__class__.position(path + [("position", None)], service) - self.font_name = self.__class__.font_name(path + [("font_name", None)], service) - self.font_automatic = self.__class__.font_automatic(path + [("font_automatic", None)], service) - self.font_size = self.__class__.font_size(path + [("font_size", None)], service) - self.length = self.__class__.length(path + [("length", None)], service) - self.width = self.__class__.width(path + [("width", None)], service) - - class visible(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class log_scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class format(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class user_skip(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class show_all(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class position(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_automatic(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class width(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class draw_mesh(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mesh_object(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class display_state_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class physics(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geometry(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class particle_tracks(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.uid = self.__class__.uid(path + [("uid", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - self.filter_settings = self.__class__.filter_settings(path + [("filter_settings", None)], service) - self.range = self.__class__.range(path + [("range", None)], service) - self.style_attribute = self.__class__.style_attribute(path + [("style_attribute", None)], service) - self.vector_settings = self.__class__.vector_settings(path + [("vector_settings", None)], service) - self.plot = self.__class__.plot(path + [("plot", None)], service) - self.track_single_particle_stream = self.__class__.track_single_particle_stream(path + [("track_single_particle_stream", None)], service) - self.skip = self.__class__.skip(path + [("skip", None)], service) - self.coarsen = self.__class__.coarsen(path + [("coarsen", None)], service) - self.field = self.__class__.field(path + [("field", None)], service) - self.injections_list = self.__class__.injections_list(path + [("injections_list", None)], service) - self.free_stream_particles = self.__class__.free_stream_particles(path + [("free_stream_particles", None)], service) - self.wall_film_particles = self.__class__.wall_film_particles(path + [("wall_film_particles", None)], service) - self.track_pdf_particles = self.__class__.track_pdf_particles(path + [("track_pdf_particles", None)], service) - self.color_map = self.__class__.color_map(path + [("color_map", None)], service) - self.draw_mesh = self.__class__.draw_mesh(path + [("draw_mesh", None)], service) - self.mesh_object = self.__class__.mesh_object(path + [("mesh_object", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uid(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.node_values = self.__class__.node_values(path + [("node_values", None)], service) - - class node_values(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class filter_settings(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.field = self.__class__.field(path + [("field", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - self.enabled = self.__class__.enabled(path + [("enabled", None)], service) - self.filter_minimum = self.__class__.filter_minimum(path + [("filter_minimum", None)], service) - self.filter_maximum = self.__class__.filter_maximum(path + [("filter_maximum", None)], service) - - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.inside = self.__class__.inside(path + [("inside", None)], service) - self.outside = self.__class__.outside(path + [("outside", None)], service) - - class inside(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class outside(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class enabled(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class filter_minimum(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class filter_maximum(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_range = self.__class__.auto_range(path + [("auto_range", None)], service) - self.clip_to_range = self.__class__.clip_to_range(path + [("clip_to_range", None)], service) - - class auto_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class clip_to_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.min_value = self.__class__.min_value(path + [("min_value", None)], service) - self.max_value = self.__class__.max_value(path + [("max_value", None)], service) - - class min_value(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class max_value(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class style_attribute(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.style = self.__class__.style(path + [("style", None)], service) - self.line_width = self.__class__.line_width(path + [("line_width", None)], service) - self.arrow_space = self.__class__.arrow_space(path + [("arrow_space", None)], service) - self.arrow_scale = self.__class__.arrow_scale(path + [("arrow_scale", None)], service) - self.marker_size = self.__class__.marker_size(path + [("marker_size", None)], service) - self.sphere_size = self.__class__.sphere_size(path + [("sphere_size", None)], service) - self.sphere_lod = self.__class__.sphere_lod(path + [("sphere_lod", None)], service) - self.radius = self.__class__.radius(path + [("radius", None)], service) - self.ribbon_settings = self.__class__.ribbon_settings(path + [("ribbon_settings", None)], service) - self.sphere_settings = self.__class__.sphere_settings(path + [("sphere_settings", None)], service) - - class style(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class line_width(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class arrow_space(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class arrow_scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class marker_size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sphere_size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sphere_lod(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class radius(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ribbon_settings(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.field = self.__class__.field(path + [("field", None)], service) - self.scalefactor = self.__class__.scalefactor(path + [("scalefactor", None)], service) - - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class scalefactor(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sphere_settings(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.scale = self.__class__.scale(path + [("scale", None)], service) - self.sphere_lod = self.__class__.sphere_lod(path + [("sphere_lod", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - - class scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sphere_lod(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.constant = self.__class__.constant(path + [("constant", None)], service) - self.variable = self.__class__.variable(path + [("variable", None)], service) - - class constant(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.diameter = self.__class__.diameter(path + [("diameter", None)], service) - - class diameter(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class variable(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.size_by = self.__class__.size_by(path + [("size_by", None)], service) - self.range = self.__class__.range(path + [("range", None)], service) - - class size_by(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_range = self.__class__.auto_range(path + [("auto_range", None)], service) - self.clip_to_range = self.__class__.clip_to_range(path + [("clip_to_range", None)], service) - - class auto_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class clip_to_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.min_value = self.__class__.min_value(path + [("min_value", None)], service) - self.max_value = self.__class__.max_value(path + [("max_value", None)], service) - - class min_value(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class max_value(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vector_settings(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.style = self.__class__.style(path + [("style", None)], service) - self.vector_length = self.__class__.vector_length(path + [("vector_length", None)], service) - self.constant_color = self.__class__.constant_color(path + [("constant_color", None)], service) - self.vector_of = self.__class__.vector_of(path + [("vector_of", None)], service) - self.scale = self.__class__.scale(path + [("scale", None)], service) - self.length_to_head_ratio = self.__class__.length_to_head_ratio(path + [("length_to_head_ratio", None)], service) - - class style(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vector_length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.constant_length = self.__class__.constant_length(path + [("constant_length", None)], service) - self.variable_length = self.__class__.variable_length(path + [("variable_length", None)], service) - - class constant_length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class variable_length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class constant_color(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.enabled = self.__class__.enabled(path + [("enabled", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) - - class enabled(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vector_of(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class length_to_head_ratio(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class plot(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.x_axis_function = self.__class__.x_axis_function(path + [("x_axis_function", None)], service) - self.enabled = self.__class__.enabled(path + [("enabled", None)], service) - - class x_axis_function(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class enabled(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class track_single_particle_stream(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.enabled = self.__class__.enabled(path + [("enabled", None)], service) - self.stream_id = self.__class__.stream_id(path + [("stream_id", None)], service) - - class enabled(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class stream_id(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class skip(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coarsen(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class injections_list(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class free_stream_particles(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wall_film_particles(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class track_pdf_particles(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color_map(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.visible = self.__class__.visible(path + [("visible", None)], service) - self.size = self.__class__.size(path + [("size", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) - self.log_scale = self.__class__.log_scale(path + [("log_scale", None)], service) - self.format = self.__class__.format(path + [("format", None)], service) - self.user_skip = self.__class__.user_skip(path + [("user_skip", None)], service) - self.show_all = self.__class__.show_all(path + [("show_all", None)], service) - self.position = self.__class__.position(path + [("position", None)], service) - self.font_name = self.__class__.font_name(path + [("font_name", None)], service) - self.font_automatic = self.__class__.font_automatic(path + [("font_automatic", None)], service) - self.font_size = self.__class__.font_size(path + [("font_size", None)], service) - self.length = self.__class__.length(path + [("length", None)], service) - self.width = self.__class__.width(path + [("width", None)], service) - - class visible(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class log_scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class format(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class user_skip(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class show_all(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class position(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_automatic(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class width(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class draw_mesh(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mesh_object(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class display_state_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class scene(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.title = self.__class__.title(path + [("title", None)], service) - self.temporary = self.__class__.temporary(path + [("temporary", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class title(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class temporary(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class display_state_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class zones(metaclass=PyMenuMeta): + class zones(TUIMenu): """ Contains commands for displaying zones. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def show_all(self, *args, **kwargs): """ Unhides all the zones in the geometry and displays them. @@ -12218,13 +9886,14 @@ def isolate_zones(self, *args, **kwargs): """ return PyMenu(self.service, "/display/zones/isolate_zones").execute(*args, **kwargs) - class advanced_rendering(metaclass=PyMenuMeta): + class advanced_rendering(TUIMenu): """ Enter the advanced rendering menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def max_extent_culling(self, *args, **kwargs): """ Truncates zones smaller that the maximum extent culling pixel value. @@ -12251,13 +9920,14 @@ def edge_color(self, *args, **kwargs): """ return PyMenu(self.service, "/display/advanced_rendering/edge_color").execute(*args, **kwargs) - class report(metaclass=PyMenuMeta): + class report(TUIMenu): """ Enter the report menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def face_node_degree_distribution(self, *args, **kwargs): """ Reports the distribution of boundary faces based on face node degree. The node degree is the number of faces connected to the node. Specify the list of boundary face zones and the minimum and maximum face node degree to be reported. You can also consider only internal nodes, if required. @@ -12395,13 +10065,14 @@ def spy_level(self, *args, **kwargs): """ return PyMenu(self.service, "/report/spy_level").execute(*args, **kwargs) - class parallel(metaclass=PyMenuMeta): + class parallel(TUIMenu): """ Enter the parallel menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def spawn_solver_processes(self, *args, **kwargs): """ Specifies the number of solver processes. Additional processes will be spawned as necessary when switching to solution mode in Linux with the default MPI. You will also be prompted for (Linux and mixed Windows/Linux) interconnect type, machine list or host file, and (Linux and mixed Windows/Linux) option to be used. @@ -12428,13 +10099,14 @@ def thread_number_control(self, *args, **kwargs): """ return PyMenu(self.service, "/parallel/thread_number_control").execute(*args, **kwargs) - class openmp_controls(metaclass=PyMenuMeta): + class openmp_controls(TUIMenu): """ Enter the openmp menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def get_max_cores(self, *args, **kwargs): """ Max Number of Cores. @@ -12451,13 +10123,14 @@ def set_num_cores(self, *args, **kwargs): """ return PyMenu(self.service, "/openmp_controls/set_num_cores").execute(*args, **kwargs) - class reference_frames(metaclass=PyMenuMeta): + class reference_frames(TUIMenu): """ Manage reference frames. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def add(self, *args, **kwargs): """ Add a new object. diff --git a/src/ansys/fluent/core/meta.py b/src/ansys/fluent/core/meta.py index bff29393f7f8..19788c3a6183 100644 --- a/src/ansys/fluent/core/meta.py +++ b/src/ansys/fluent/core/meta.py @@ -5,7 +5,6 @@ # pylint: disable=unused-private-member # pylint: disable=bad-mcs-classmethod-argument -from ansys.fluent.core.services.datamodel_tui import PyMenu class LocalObjectDataExtractor: @@ -114,40 +113,6 @@ def __get__(self, obj, objtype=None): return self.function(obj) -class PyMenuMeta(type): - """Metaclass for explicit TUI menu classes.""" - - # pyfluent.results.graphics.objects.contour['contour-1'].color_map.size() - @classmethod - def __create_get_state(cls): - def wrapper(self): - return PyMenu(self.service, self.path).get_state() - - return wrapper - - # pyfluent.results.graphics.objects.contour['contour-1'].color_map.size.set_state(80.0) - @classmethod - def __create_set_state(cls): - def wrapper(self, value): - PyMenu(self.service, self.path).set_state(value) - - return wrapper - - @classmethod - def __create_dir(cls): - def wrapper(self): - return PyMenu(self.service, self.path).get_child_names() - - return wrapper - - def __new__(cls, name, bases, attrs): - attrs["__dir__"] = cls.__create_dir() - if "is_extended_tui" in attrs: - attrs["__call__"] = cls.__create_get_state() - attrs["set_state"] = cls.__create_set_state() - return super(PyMenuMeta, cls).__new__(cls, name, bases, attrs) - - class PyLocalBaseMeta(type): @classmethod def __create_get_parent_by_type(cls): @@ -498,81 +463,3 @@ def __setitem__(self, name, value): # del graphics.Contours['contour-1'] def __delitem__(self, name): del self.__collection[name] - - -class PyNamedObjectMeta(type): - """Metaclass for explicit named object classes in Fluent.""" - - @classmethod - def __create_init(cls): - def wrapper(self, path, name, service): - self.path = path[:-1] + [(path[-1][0], name)] - self.service = service - for name, cls in self.__class__.__dict__.items(): - if cls.__class__.__name__ == "PyMenuMeta": - setattr( - self, - name, - cls(self.path + [(name, None)], service), - ) - if cls.__class__.__name__ == "PyNamedObjectMeta": - setattr( - self, - name, - cls(self.path + [(name, None)], None, service), - ) - - return wrapper - - # pyfluent.results.graphics.objects.contour['contour-1'] - @classmethod - def __create_getitem(cls): - def wrapper(self, name): - return self.__class__(self.path, name, self.service) - - return wrapper - - # pyfluent.results.graphics.objects.contour['contour-1'] = {...} - @classmethod - def __create_setitem(cls): - def wrapper(self, name, value): - obj = self.__class__(self.path, name, self.service) - if isinstance(value, dict) and not value: - value["name"] = name # creation with default value - PyMenu(self.service, obj.path).set_state(value) - - return wrapper - - # del pyfluent.results.graphics.objects.contour['contour-1'] - @classmethod - def __create_delitem(cls): - def wrapper(self, name): - obj = self.__class__(self.path, name, self.service) - PyMenu(self.service, obj.path).del_item() - - return wrapper - - # pyfluent.results.graphics.objects.contour['contour-1']() - @classmethod - def __create_get_state(cls): - def wrapper(self): - return PyMenu(self.service, self.path).get_state() - - return wrapper - - # pyfluent.results.graphics.objects.contour['contour-1'].rename('my-contour') - @classmethod - def __create_rename(cls): - def wrapper(self, new_name): - PyMenu(self.service, self.path).rename(new_name) - - return wrapper - - def __new__(cls, name, bases, attrs): - attrs["__init__"] = cls.__create_init() - attrs["__getitem__"] = cls.__create_getitem() - attrs["__setitem__"] = cls.__create_setitem() - attrs["__delitem__"] = cls.__create_delitem() - attrs["__call__"] = cls.__create_get_state() - attrs["rename"] = cls.__create_rename() - return super(PyNamedObjectMeta, cls).__new__(cls, name, bases, attrs) diff --git a/src/ansys/fluent/core/services/datamodel_tui.py b/src/ansys/fluent/core/services/datamodel_tui.py index b37e091135a1..2366db912cd0 100644 --- a/src/ansys/fluent/core/services/datamodel_tui.py +++ b/src/ansys/fluent/core/services/datamodel_tui.py @@ -1,7 +1,7 @@ """Wrappers over TUI-based datamodel grpc service of Fluent.""" import keyword -from typing import Any, List, Tuple, Union +from typing import Any, Iterable, List, Tuple, Union import grpc @@ -107,29 +107,13 @@ class PyMenu: Methods ------- - is_extended_tui(include_unavailable) - Check if menu is in extended TUI - is_container(include_unavailable) - Check if menu is a container get_child_names(include_unavailable): Get child menu names - get_state() - Get state of the object at menu - set_state(value) - Set state of the object at menu execute(*args, **kwargs) Execute command/query at menu with positional or keyword arguments get_doc_string(include_unavailable) Get docstring for menu - rename(new_name) - Rename the object at menu - get_child_object_names() - Get child object names of the container at menu - set_item(name, value) - Create or set state of child object within contanier at menu - del_item() - Delete the child object at menu """ def __init__(self, service: DatamodelService, path: Union[Path, str]): @@ -138,51 +122,6 @@ def __init__(self, service: DatamodelService, path: Union[Path, str]): path if isinstance(path, str) else convert_path_to_grpc_path(path) ) - def is_extended_tui(self, include_unavailable: bool = False) -> bool: - """Check if menu is in extended TUI. - - Parameters - ---------- - include_unavailable : bool, optional - When True, will query over static TUI metadata, - by default False - - Returns - ------- - bool - """ - request = DataModelProtoModule.GetAttributeValueRequest() - request.path = self._path - request.attribute = DataModelProtoModule.Attribute.CUSTOM - request.args["is_extended_tui"] = 1 - if include_unavailable: - request.args["include_unavailable"] = 1 - response = self._service.get_attribute_value(request) - return _convert_gvalue_to_value(response.value) - - def is_container(self, include_unavailable: bool = False) -> bool: - """Check if menu is a container. - - Parameters - ---------- - include_unavailable : bool, optional - When True, will query over static TUI metadata, - by default False - - Returns - ------- - bool - """ - request = DataModelProtoModule.GetAttributeValueRequest() - request.path = self._path - request.attribute = DataModelProtoModule.Attribute.DATA_TYPE - if include_unavailable: - request.args["include_unavailable"] = 1 - response = self._service.get_attribute_value(request) - return ( - _convert_gvalue_to_value(response.value) == "NamedObjectContainer" - ) - def get_child_names(self, include_unavailable: bool = False) -> List[str]: """Get child menu names. @@ -204,32 +143,6 @@ def get_child_names(self, include_unavailable: bool = False) -> List[str]: response = self._service.get_attribute_value(request) return _convert_gvalue_to_value(response.value) - def get_state(self) -> Any: - """Get state of the object at menu. - - Returns - ------- - Any - state - """ - request = DataModelProtoModule.GetStateRequest() - request.path = self._path - response = self._service.get_state(request) - return _convert_gvalue_to_value(response.state) - - def set_state(self, value: Any) -> None: - """Set state of the object at menu. - - Parameters - ---------- - value : Any - state - """ - request = DataModelProtoModule.SetStateRequest() - request.path = self._path - _convert_value_to_gvalue(value, request.state) - self._service.set_state(request) - def _execute_command( self, request: DataModelProtoModule.ExecuteCommandRequest ) -> Any: @@ -287,53 +200,16 @@ def get_doc_string(self, include_unavailable: bool = False) -> str: response = self._service.get_attribute_value(request) return _convert_gvalue_to_value(response.value) - def rename(self, new_name: str) -> None: - """Rename the object at menu. - - Parameters - ---------- - new_name : str - """ - request = DataModelProtoModule.SetStateRequest() - request.path = self._path - _convert_value_to_gvalue( - new_name, request.state.struct_value.fields["name"] - ) - self._service.set_state(request) - - def get_child_object_names(self) -> List[str]: - """Get child object names of the container at menu. - Returns - ------- - List[str] - """ - request = DataModelProtoModule.GetAttributeValueRequest() - request.path = self._path - request.attribute = DataModelProtoModule.Attribute.OBJECT_NAMES - response = self._service.get_attribute_value(request) - return _convert_gvalue_to_value(response.value) +class TUIMenu: + """Base class for the generated menu classes.""" - def set_item(self, name: str, value: Any) -> None: - """Create or set state of child object within contanier at menu. - - Parameters - ---------- - name : str - child object name - value : Any - state - """ - request = DataModelProtoModule.SetStateRequest() - request.path = self._path - _convert_value_to_gvalue(value, request.state) - self._service.set_state(request) + def __init__(self, path, service): + self.path = path + self.service = service - def del_item(self) -> None: - """Delete the child object at path.""" - request = DataModelProtoModule.SetStateRequest() - request.path = self._path - self._service.set_state(request) + def __dir__(self) -> Iterable[str]: + return PyMenu(self.service, self.path).get_child_names() def convert_func_name_to_tui_menu(func_name: str) -> str: diff --git a/src/ansys/fluent/core/solver/tui.py b/src/ansys/fluent/core/solver/tui.py index a4040aac9001..79f1a9fd49b3 100644 --- a/src/ansys/fluent/core/solver/tui.py +++ b/src/ansys/fluent/core/solver/tui.py @@ -4,11 +4,11 @@ # # pylint: disable=line-too-long -from ansys.fluent.core.meta import PyMenuMeta, PyNamedObjectMeta -from ansys.fluent.core.services.datamodel_tui import PyMenu +from ansys.fluent.core.services.datamodel_tui import PyMenu, TUIMenu -class main_menu(metaclass=PyMenuMeta): + +class main_menu(TUIMenu): """ Fluent solver main menu. """ @@ -37,6 +37,7 @@ def __init__(self, path, service): self.views = self.__class__.views(path + [("views", None)], service) self.parametric_study = self.__class__.parametric_study(path + [("parametric_study", None)], service) self.turbo_workflow = self.__class__.turbo_workflow(path + [("turbo_workflow", None)], service) + super().__init__(path, service) def close_fluent(self, *args, **kwargs): """ Exit program. @@ -58,13 +59,14 @@ def print_license_usage(self, *args, **kwargs): """ return PyMenu(self.service, "/print_license_usage").execute(*args, **kwargs) - class adjoint(metaclass=PyMenuMeta): + class adjoint(TUIMenu): """ Adjoint. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def observable(self, *args, **kwargs): """ Menu to create and configure observables of interest. @@ -131,7 +133,7 @@ def utilities(self, *args, **kwargs): """ return PyMenu(self.service, "/adjoint/utilities").execute(*args, **kwargs) - class display(metaclass=PyMenuMeta): + class display(TUIMenu): """ Enter the display menu. """ @@ -151,6 +153,7 @@ def __init__(self, path, service): self.view_sync = self.__class__.view_sync(path + [("view_sync", None)], service) self.update_scene = self.__class__.update_scene(path + [("update_scene", None)], service) self.inverse_dft = self.__class__.inverse_dft(path + [("inverse_dft", None)], service) + super().__init__(path, service) def add_custom_vector(self, *args, **kwargs): """ Adds new custom vector definition. @@ -302,13 +305,14 @@ def switch_to_primary_volume(self, *args, **kwargs): """ return PyMenu(self.service, "/display/switch_to_primary_volume").execute(*args, **kwargs) - class embedded_windows(metaclass=PyMenuMeta): + class embedded_windows(TUIMenu): """ Enter the embedded window menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def close(self, *args, **kwargs): """ Close an embedded window. @@ -335,21 +339,14 @@ def move_out_all(self, *args, **kwargs): """ return PyMenu(self.service, "/display/embedded_windows/move_out_all").execute(*args, **kwargs) - class objects(metaclass=PyMenuMeta): + class objects(TUIMenu): """ Enter to add, edit, delete or display graphics objects. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.xy_plot = self.__class__.xy_plot(path + [("xy_plot", None)], None, service) - self.mesh = self.__class__.mesh(path + [("mesh", None)], None, service) - self.contour = self.__class__.contour(path + [("contour", None)], None, service) - self.vector = self.__class__.vector(path + [("vector", None)], None, service) - self.pathlines = self.__class__.pathlines(path + [("pathlines", None)], None, service) - self.particle_tracks = self.__class__.particle_tracks(path + [("particle_tracks", None)], None, service) - self.scene = self.__class__.scene(path + [("scene", None)], None, service) + super().__init__(path, service) def create(self, *args, **kwargs): """ Create new graphics object. @@ -381,38923 +378,27910 @@ def add_to_graphics(self, *args, **kwargs): """ return PyMenu(self.service, "/display/objects/add_to_graphics").execute(*args, **kwargs) - class xy_plot(metaclass=PyNamedObjectMeta): + class flamelet_data(TUIMenu): + """ + Displays flamelet data. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def draw_number_box(self, *args, **kwargs): + """ + Enables/disables display of the numbers box. + """ + return PyMenu(self.service, "/display/flamelet_data/draw_number_box").execute(*args, **kwargs) + def plot_1d_slice(self, *args, **kwargs): + """ + Enables/disables plot of the 1D-slice. + """ + return PyMenu(self.service, "/display/flamelet_data/plot_1d_slice").execute(*args, **kwargs) + def write_to_file(self, *args, **kwargs): + """ + Enables/disables writing the 1D-slice to file instead of plot. + """ + return PyMenu(self.service, "/display/flamelet_data/write_to_file").execute(*args, **kwargs) + def carpet_plot(self, *args, **kwargs): + """ + Enables/disables display of carpet plot of a property. + """ + return PyMenu(self.service, "/display/flamelet_data/carpet_plot").execute(*args, **kwargs) + + class particle_tracks(TUIMenu): + """ + Enters the particle tracks menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def particle_tracks(self, *args, **kwargs): + """ + Calculates and displays particle tracks from defined injections. + """ + return PyMenu(self.service, "/display/particle_tracks/particle_tracks").execute(*args, **kwargs) + def plot_write_xy_plot(self, *args, **kwargs): + """ + Plots or writes an XY plot of particle tracks. + """ + return PyMenu(self.service, "/display/particle_tracks/plot_write_xy_plot").execute(*args, **kwargs) + + class path_lines(TUIMenu): + """ + Enters the pathlines menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def path_lines(self, *args, **kwargs): + """ + Displays pathlines from a surface. + """ + return PyMenu(self.service, "/display/path_lines/path_lines").execute(*args, **kwargs) + def plot_write_xy_plot(self, *args, **kwargs): + """ + Plots or writes an XY plot of pathlines. + """ + return PyMenu(self.service, "/display/path_lines/plot_write_xy_plot").execute(*args, **kwargs) + def write_to_files(self, *args, **kwargs): + """ + Writes pathlines to a file. + """ + return PyMenu(self.service, "/display/path_lines/write_to_files").execute(*args, **kwargs) + + class pdf_data(TUIMenu): + """ + Enters the PDF data menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def draw_number_box(self, *args, **kwargs): + """ + Enables/disables the display of the numbers box. + """ + return PyMenu(self.service, "/display/pdf_data/draw_number_box").execute(*args, **kwargs) + def plot_1d_slice(self, *args, **kwargs): + """ + Enables/disables a plot of the 1D-slice. + """ + return PyMenu(self.service, "/display/pdf_data/plot_1d_slice").execute(*args, **kwargs) + def write_to_file(self, *args, **kwargs): + """ + Enables/disables writing the 1D-slice to file instead of plot. + """ + return PyMenu(self.service, "/display/pdf_data/write_to_file").execute(*args, **kwargs) + def carpet_plot(self, *args, **kwargs): + """ + Enables/disables the display of a carpet plot of a property. + """ + return PyMenu(self.service, "/display/pdf_data/carpet_plot").execute(*args, **kwargs) + + class set(TUIMenu): + """ + Enter the set menu to set display parameters. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.colors = self.__class__.colors(path + [("colors", None)], service) + self.contours = self.__class__.contours(path + [("contours", None)], service) + self.picture = self.__class__.picture(path + [("picture", None)], service) + self.lights = self.__class__.lights(path + [("lights", None)], service) + self.particle_tracks = self.__class__.particle_tracks(path + [("particle_tracks", None)], service) + self.path_lines = self.__class__.path_lines(path + [("path_lines", None)], service) + self.rendering_options = self.__class__.rendering_options(path + [("rendering_options", None)], service) + self.titles = self.__class__.titles(path + [("titles", None)], service) + self.velocity_vectors = self.__class__.velocity_vectors(path + [("velocity_vectors", None)], service) + self.windows = self.__class__.windows(path + [("windows", None)], service) + super().__init__(path, service) + def color_map(self, *args, **kwargs): + """ + Enters the color map menu, which contains names of predefined and user-defined (in the Colormap Editor panel) colormaps that can be selected. It prompts you for the name of the colormap to be used. + """ + return PyMenu(self.service, "/display/set/color_map").execute(*args, **kwargs) + def element_shrink(self, *args, **kwargs): + """ + Sets shrinkage of both faces and cells. A value of zero indicates no shrinkage, while a value of one will shrink each face or cell to a point. + """ + return PyMenu(self.service, "/display/set/element_shrink").execute(*args, **kwargs) + def filled_mesh(self, *args, **kwargs): + """ + Determines whether the meshes are drawn as wireframe or solid. + """ + return PyMenu(self.service, "/display/set/filled_mesh").execute(*args, **kwargs) + def mesh_level(self, *args, **kwargs): + """ + Sets coarse mesh level to be drawn. + """ + return PyMenu(self.service, "/display/set/mesh_level").execute(*args, **kwargs) + def mesh_partitions(self, *args, **kwargs): + """ + Enables/disables option to draw mesh partition boundaries. + """ + return PyMenu(self.service, "/display/set/mesh_partitions").execute(*args, **kwargs) + def mesh_surfaces(self, *args, **kwargs): + """ + Sets surface IDs to be drawn as meshes. You can include a wildcard (*) within the surface names. + """ + return PyMenu(self.service, "/display/set/mesh_surfaces").execute(*args, **kwargs) + def mesh_zones(self, *args, **kwargs): + """ + Sets zone IDs to be drawn as meshes. + """ + return PyMenu(self.service, "/display/set/mesh_zones").execute(*args, **kwargs) + def line_weight(self, *args, **kwargs): + """ + Set the line-weight factor for the window. + """ + return PyMenu(self.service, "/display/set/line_weight").execute(*args, **kwargs) + def marker_size(self, *args, **kwargs): + """ + Sets the size of markers used to represent points. + """ + return PyMenu(self.service, "/display/set/marker_size").execute(*args, **kwargs) + def marker_symbol(self, *args, **kwargs): + """ + Sets the type of markers used to represent points. + """ + return PyMenu(self.service, "/display/set/marker_symbol").execute(*args, **kwargs) + def mesh_display_configuration(self, *args, **kwargs): + """ + Changes the default mesh display. If set tomeshing, it draws the mesh on edges and faces of the outline surfaces, colored by their zone ID with lighting enabled. If set tosolution, it draws the mesh on edges and faces of the outline surfaces, colored by their zone type with lighting enabled. If set to post-processing, it draws the object outline with lighting disabled. If set toclassic, it draws the mesh on all edges of the outline surfaces. This only applies for 3D cases. + """ + return PyMenu(self.service, "/display/set/mesh_display_configuration").execute(*args, **kwargs) + def mirror_zones(self, *args, **kwargs): + """ + Sets the zones about which the domain is mirrored (symmetry planes). + """ + return PyMenu(self.service, "/display/set/mirror_zones").execute(*args, **kwargs) + def n_stream_func(self, *args, **kwargs): + """ + Sets number of iterations used in computing stream function. + """ + return PyMenu(self.service, "/display/set/n_stream_func").execute(*args, **kwargs) + def nodewt_based_interp(self, *args, **kwargs): + """ + Disables/enables the use of node weights for node-based gradients in postprocessing. + """ + return PyMenu(self.service, "/display/set/nodewt_based_interp").execute(*args, **kwargs) + def overlays(self, *args, **kwargs): + """ + Enable/disable overlays. + """ + return PyMenu(self.service, "/display/set/overlays").execute(*args, **kwargs) + def periodic_instancing(self, *args, **kwargs): + """ + Sets the number of periodic repetitions. + """ + return PyMenu(self.service, "/display/set/periodic_instancing").execute(*args, **kwargs) + def proximity_zones(self, *args, **kwargs): + """ + Sets zones to be used for boundary cell distance and boundary proximity. + """ + return PyMenu(self.service, "/display/set/proximity_zones").execute(*args, **kwargs) + def render_mesh(self, *args, **kwargs): + """ + Enables/disables rendering the mesh on top of contours, vectors, and so on. + """ + return PyMenu(self.service, "/display/set/render_mesh").execute(*args, **kwargs) + def reset_graphics(self, *args, **kwargs): + """ + Reset the graphics system. + """ + return PyMenu(self.service, "/display/set/reset_graphics").execute(*args, **kwargs) + def zero_angle_dir(self, *args, **kwargs): + """ + Sets the vector having zero angular coordinates. + """ + return PyMenu(self.service, "/display/set/zero_angle_dir").execute(*args, **kwargs) + def duplicate_node_display(self, *args, **kwargs): + """ + Set flag to remove duplicate nodes in mesh display. + """ + return PyMenu(self.service, "/display/set/duplicate_node_display").execute(*args, **kwargs) + + class colors(TUIMenu): """ + Enter the color options menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.uid = self.__class__.uid(path + [("uid", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - self.plot_direction = self.__class__.plot_direction(path + [("plot_direction", None)], service) - self.x_axis_function = self.__class__.x_axis_function(path + [("x_axis_function", None)], service) - self.y_axis_function = self.__class__.y_axis_function(path + [("y_axis_function", None)], service) - self.surfaces_list = self.__class__.surfaces_list(path + [("surfaces_list", None)], service) - self.physics = self.__class__.physics(path + [("physics", None)], service) - self.geometry = self.__class__.geometry(path + [("geometry", None)], service) - self.surfaces = self.__class__.surfaces(path + [("surfaces", None)], service) - - class name(metaclass=PyMenuMeta): + self.by_type = self.__class__.by_type(path + [("by_type", None)], service) + self.by_surface = self.__class__.by_surface(path + [("by_surface", None)], service) + super().__init__(path, service) + def background(self, *args, **kwargs): """ + Set the background (window) color. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uid(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/colors/background").execute(*args, **kwargs) + def color_by_type(self, *args, **kwargs): """ + Determine whether to color meshes by type or by surface (ID). """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/display/set/colors/color_by_type").execute(*args, **kwargs) + def foreground(self, *args, **kwargs): + """ + Set the foreground (text and window frame) color. + """ + return PyMenu(self.service, "/display/set/colors/foreground").execute(*args, **kwargs) + def far_field_faces(self, *args, **kwargs): + """ + Set the color of far field faces. + """ + return PyMenu(self.service, "/display/set/colors/far_field_faces").execute(*args, **kwargs) + def inlet_faces(self, *args, **kwargs): + """ + Set the color of inlet faces. + """ + return PyMenu(self.service, "/display/set/colors/inlet_faces").execute(*args, **kwargs) + def interior_faces(self, *args, **kwargs): + """ + Set the color of interior faces. + """ + return PyMenu(self.service, "/display/set/colors/interior_faces").execute(*args, **kwargs) + def internal_faces(self, *args, **kwargs): + """ + Set the color of internal interface faces. + """ + return PyMenu(self.service, "/display/set/colors/internal_faces").execute(*args, **kwargs) + def outlet_faces(self, *args, **kwargs): + """ + Set the color of outlet faces. + """ + return PyMenu(self.service, "/display/set/colors/outlet_faces").execute(*args, **kwargs) + def overset_faces(self, *args, **kwargs): + """ + Set the color of overset faces. + """ + return PyMenu(self.service, "/display/set/colors/overset_faces").execute(*args, **kwargs) + def periodic_faces(self, *args, **kwargs): + """ + Set the color of periodic faces. + """ + return PyMenu(self.service, "/display/set/colors/periodic_faces").execute(*args, **kwargs) + def rans_les_interface_faces(self, *args, **kwargs): + """ + Set the color of RANS/LES interface faces. + """ + return PyMenu(self.service, "/display/set/colors/rans_les_interface_faces").execute(*args, **kwargs) + def reset_user_colors(self, *args, **kwargs): + """ + Reset all user colors. + """ + return PyMenu(self.service, "/display/set/colors/reset_user_colors").execute(*args, **kwargs) + def show_user_colors(self, *args, **kwargs): + """ + List currently defined user colors. + """ + return PyMenu(self.service, "/display/set/colors/show_user_colors").execute(*args, **kwargs) + def symmetry_faces(self, *args, **kwargs): + """ + Set the color of symmetric faces. + """ + return PyMenu(self.service, "/display/set/colors/symmetry_faces").execute(*args, **kwargs) + def axis_faces(self, *args, **kwargs): + """ + Set the color of axisymmetric faces. + """ + return PyMenu(self.service, "/display/set/colors/axis_faces").execute(*args, **kwargs) + def free_surface_faces(self, *args, **kwargs): + """ + Set the color of free-surface faces. + """ + return PyMenu(self.service, "/display/set/colors/free_surface_faces").execute(*args, **kwargs) + def traction_faces(self, *args, **kwargs): + """ + Set the color of traction faces. + """ + return PyMenu(self.service, "/display/set/colors/traction_faces").execute(*args, **kwargs) + def user_color(self, *args, **kwargs): + """ + Explicitly set color of display zone. + """ + return PyMenu(self.service, "/display/set/colors/user_color").execute(*args, **kwargs) + def wall_faces(self, *args, **kwargs): + """ + Set the color of wall faces. + """ + return PyMenu(self.service, "/display/set/colors/wall_faces").execute(*args, **kwargs) + def interface_faces(self, *args, **kwargs): + """ + Set the color of mesh Interfaces. + """ + return PyMenu(self.service, "/display/set/colors/interface_faces").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + List available colors. + """ + return PyMenu(self.service, "/display/set/colors/list").execute(*args, **kwargs) + def reset_colors(self, *args, **kwargs): + """ + Reset individual mesh surface colors to the defaults. + """ + return PyMenu(self.service, "/display/set/colors/reset_colors").execute(*args, **kwargs) + def surface(self, *args, **kwargs): + """ + Set the color of surfaces. + """ + return PyMenu(self.service, "/display/set/colors/surface").execute(*args, **kwargs) + def skip_label(self, *args, **kwargs): + """ + Set the number of labels to be skipped in the colopmap scale. + """ + return PyMenu(self.service, "/display/set/colors/skip_label").execute(*args, **kwargs) + def automatic_skip(self, *args, **kwargs): + """ + Determine whether to skip labels in the colopmap scale automatically. + """ + return PyMenu(self.service, "/display/set/colors/automatic_skip").execute(*args, **kwargs) + def graphics_color_theme(self, *args, **kwargs): + """ + Enter the graphics color theme menu. + """ + return PyMenu(self.service, "/display/set/colors/graphics_color_theme").execute(*args, **kwargs) - class options(metaclass=PyMenuMeta): + class by_type(TUIMenu): """ + Enter the zone type color and material assignment menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.node_values = self.__class__.node_values(path + [("node_values", None)], service) - self.position_on_x_axis = self.__class__.position_on_x_axis(path + [("position_on_x_axis", None)], service) - self.position_on_y_axis = self.__class__.position_on_y_axis(path + [("position_on_y_axis", None)], service) - - class node_values(metaclass=PyMenuMeta): + self.type_name = self.__class__.type_name(path + [("type_name", None)], service) + super().__init__(path, service) + def only_list_case_boundaries(self, *args, **kwargs): """ + Only list the boundary types that are assigned in this case. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class position_on_x_axis(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/colors/by_type/only_list_case_boundaries").execute(*args, **kwargs) + def use_inherent_material_color(self, *args, **kwargs): """ + Use inherent material color for boundary zones. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class position_on_y_axis(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/colors/by_type/use_inherent_material_color").execute(*args, **kwargs) + def reset(self, *args, **kwargs): """ + To reset colors and/or materials to the defaults. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class plot_direction(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.direction_vector = self.__class__.direction_vector(path + [("direction_vector", None)], service) - self.curve_length = self.__class__.curve_length(path + [("curve_length", None)], service) + return PyMenu(self.service, "/display/set/colors/by_type/reset").execute(*args, **kwargs) - class direction_vector(metaclass=PyMenuMeta): + class type_name(TUIMenu): """ + Select the boundary type to specify colors and/or materials. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.x_component = self.__class__.x_component(path + [("x_component", None)], service) - self.y_component = self.__class__.y_component(path + [("y_component", None)], service) - self.z_component = self.__class__.z_component(path + [("z_component", None)], service) + self.axis = self.__class__.axis(path + [("axis", None)], service) + self.far_field = self.__class__.far_field(path + [("far_field", None)], service) + self.free_surface = self.__class__.free_surface(path + [("free_surface", None)], service) + self.inlet = self.__class__.inlet(path + [("inlet", None)], service) + self.interface = self.__class__.interface(path + [("interface", None)], service) + self.interior = self.__class__.interior(path + [("interior", None)], service) + self.internal = self.__class__.internal(path + [("internal", None)], service) + self.outlet = self.__class__.outlet(path + [("outlet", None)], service) + self.overset = self.__class__.overset(path + [("overset", None)], service) + self.periodic = self.__class__.periodic(path + [("periodic", None)], service) + self.rans_les_interface = self.__class__.rans_les_interface(path + [("rans_les_interface", None)], service) + self.surface = self.__class__.surface(path + [("surface", None)], service) + self.symmetry = self.__class__.symmetry(path + [("symmetry", None)], service) + self.traction = self.__class__.traction(path + [("traction", None)], service) + self.wall = self.__class__.wall(path + [("wall", None)], service) + super().__init__(path, service) - class x_component(metaclass=PyMenuMeta): + class axis(TUIMenu): """ + Set the material and/or color for the selected boundary type. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/axis/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/axis/material").execute(*args, **kwargs) - class y_component(metaclass=PyMenuMeta): + class far_field(TUIMenu): """ + Set the material and/or color for the selected boundary type. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/far_field/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/far_field/material").execute(*args, **kwargs) - class z_component(metaclass=PyMenuMeta): + class free_surface(TUIMenu): """ + Set the material and/or color for the selected boundary type. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/free_surface/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/free_surface/material").execute(*args, **kwargs) - class curve_length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.default = self.__class__.default(path + [("default", None)], service) - self.reverse = self.__class__.reverse(path + [("reverse", None)], service) - - class default(metaclass=PyMenuMeta): + class inlet(TUIMenu): """ + Set the material and/or color for the selected boundary type. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/inlet/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/inlet/material").execute(*args, **kwargs) - class reverse(metaclass=PyMenuMeta): + class interface(TUIMenu): """ + Set the material and/or color for the selected boundary type. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/interface/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/interface/material").execute(*args, **kwargs) - class x_axis_function(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class y_axis_function(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class interior(TUIMenu): + """ + Set the material and/or color for the selected boundary type. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/interior/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/interior/material").execute(*args, **kwargs) - class surfaces_list(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class internal(TUIMenu): + """ + Set the material and/or color for the selected boundary type. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/internal/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/internal/material").execute(*args, **kwargs) - class physics(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geometry(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mesh(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - self.edge_type = self.__class__.edge_type(path + [("edge_type", None)], service) - self.shrink_factor = self.__class__.shrink_factor(path + [("shrink_factor", None)], service) - self.surfaces_list = self.__class__.surfaces_list(path + [("surfaces_list", None)], service) - self.coloring = self.__class__.coloring(path + [("coloring", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - self.physics = self.__class__.physics(path + [("physics", None)], service) - self.geometry = self.__class__.geometry(path + [("geometry", None)], service) - self.surfaces = self.__class__.surfaces(path + [("surfaces", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.nodes = self.__class__.nodes(path + [("nodes", None)], service) - self.edges = self.__class__.edges(path + [("edges", None)], service) - self.faces = self.__class__.faces(path + [("faces", None)], service) - self.partitions = self.__class__.partitions(path + [("partitions", None)], service) - self.overset = self.__class__.overset(path + [("overset", None)], service) - self.gap = self.__class__.gap(path + [("gap", None)], service) - - class nodes(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class edges(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class faces(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class partitions(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class overset(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class gap(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class edge_type(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.all = self.__class__.all(path + [("all", None)], service) - self.feature = self.__class__.feature(path + [("feature", None)], service) - self.outline = self.__class__.outline(path + [("outline", None)], service) - - class all(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class feature(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.feature_angle = self.__class__.feature_angle(path + [("feature_angle", None)], service) - - class feature_angle(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class outline(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class shrink_factor(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces_list(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coloring(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.automatic = self.__class__.automatic(path + [("automatic", None)], service) - self.manual = self.__class__.manual(path + [("manual", None)], service) - - class automatic(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.type = self.__class__.type(path + [("type", None)], service) - self.id = self.__class__.id(path + [("id", None)], service) - self.normal = self.__class__.normal(path + [("normal", None)], service) - self.partition = self.__class__.partition(path + [("partition", None)], service) - - class type(metaclass=PyMenuMeta): + class outlet(TUIMenu): """ + Set the material and/or color for the selected boundary type. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/outlet/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/outlet/material").execute(*args, **kwargs) - class id(metaclass=PyMenuMeta): + class overset(TUIMenu): """ + Set the material and/or color for the selected boundary type. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/overset/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/overset/material").execute(*args, **kwargs) - class normal(metaclass=PyMenuMeta): + class periodic(TUIMenu): """ + Set the material and/or color for the selected boundary type. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/periodic/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/periodic/material").execute(*args, **kwargs) - class partition(metaclass=PyMenuMeta): + class rans_les_interface(TUIMenu): """ + Set the material and/or color for the selected boundary type. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/rans_les_interface/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/rans_les_interface/material").execute(*args, **kwargs) - class manual(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.faces = self.__class__.faces(path + [("faces", None)], service) - self.edges = self.__class__.edges(path + [("edges", None)], service) - self.nodes = self.__class__.nodes(path + [("nodes", None)], service) - self.material_color = self.__class__.material_color(path + [("material_color", None)], service) - - class faces(metaclass=PyMenuMeta): + class surface(TUIMenu): """ + Set the material and/or color for the selected boundary type. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/surface/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/surface/material").execute(*args, **kwargs) - class edges(metaclass=PyMenuMeta): + class symmetry(TUIMenu): """ + Set the material and/or color for the selected boundary type. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/symmetry/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/symmetry/material").execute(*args, **kwargs) - class nodes(metaclass=PyMenuMeta): + class traction(TUIMenu): """ + Set the material and/or color for the selected boundary type. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/traction/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/traction/material").execute(*args, **kwargs) - class material_color(metaclass=PyMenuMeta): + class wall(TUIMenu): """ + Set the material and/or color for the selected boundary type. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/wall/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/display/set/colors/by_type/type_name/wall/material").execute(*args, **kwargs) - class display_state_name(metaclass=PyMenuMeta): + class by_surface(TUIMenu): """ + Enter the surface(s) color and material assignment menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def surfaces(self, *args, **kwargs): + """ + Select the surface(s) to specify colors and/or materials. + """ + return PyMenu(self.service, "/display/set/colors/by_surface/surfaces").execute(*args, **kwargs) + def use_inherent_material_color(self, *args, **kwargs): + """ + Use inherent material color for surfaces. + """ + return PyMenu(self.service, "/display/set/colors/by_surface/use_inherent_material_color").execute(*args, **kwargs) + def reset(self, *args, **kwargs): + """ + To reset colors and/or materials to the defaults. + """ + return PyMenu(self.service, "/display/set/colors/by_surface/reset").execute(*args, **kwargs) + def list_surfaces_by_color(self, *args, **kwargs): + """ + To list the surfaces by its color. + """ + return PyMenu(self.service, "/display/set/colors/by_surface/list_surfaces_by_color").execute(*args, **kwargs) + def list_surfaces_by_material(self, *args, **kwargs): + """ + To list the surfaces by its material. + """ + return PyMenu(self.service, "/display/set/colors/by_surface/list_surfaces_by_material").execute(*args, **kwargs) - class physics(metaclass=PyMenuMeta): + class contours(TUIMenu): + """ + Enters the contour options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def auto_range(self, *args, **kwargs): """ + Enables/disables auto-computation of the contour range. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geometry(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/contours/auto_range").execute(*args, **kwargs) + def clip_to_range(self, *args, **kwargs): """ + Turns the clip to range option for filled contours on/off. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/contours/clip_to_range").execute(*args, **kwargs) + def surfaces(self, *args, **kwargs): """ + Sets the surfaces on which contours are drawn. You can include a wildcard (*) within the surface names. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/display/set/contours/surfaces").execute(*args, **kwargs) + def filled_contours(self, *args, **kwargs): + """ + Turns the filled contours option on/off (deselects line-contours?). + """ + return PyMenu(self.service, "/display/set/contours/filled_contours").execute(*args, **kwargs) + def global_range(self, *args, **kwargs): + """ + Turns the global range for contours on/off. + """ + return PyMenu(self.service, "/display/set/contours/global_range").execute(*args, **kwargs) + def line_contours(self, *args, **kwargs): + """ + Turns the line contours option on/off (deselects filled-contours?). + """ + return PyMenu(self.service, "/display/set/contours/line_contours").execute(*args, **kwargs) + def log_scale(self, *args, **kwargs): + """ + Specifies a decimal or logarithmic color scale for contours. + """ + return PyMenu(self.service, "/display/set/contours/log_scale").execute(*args, **kwargs) + def n_contour(self, *args, **kwargs): + """ + Sets the number of contour levels. + """ + return PyMenu(self.service, "/display/set/contours/n_contour").execute(*args, **kwargs) + def node_values(self, *args, **kwargs): + """ + Sets the option to use scalar field at nodes when computing the contours. + """ + return PyMenu(self.service, "/display/set/contours/node_values").execute(*args, **kwargs) + def render_mesh(self, *args, **kwargs): + """ + Determines whether or not to render the mesh on top of contours, vectors, and so on. + """ + return PyMenu(self.service, "/display/set/contours/render_mesh").execute(*args, **kwargs) + def coloring(self, *args, **kwargs): + """ + Specifies whether contours are displayed in bands or with smooth transitions. Note that you can only display smooth contours if node-values are enabled. + """ + return PyMenu(self.service, "/display/set/contours/coloring").execute(*args, **kwargs) - class contour(metaclass=PyNamedObjectMeta): + class picture(TUIMenu): """ + Enter the hardcopy/save-picture options menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.field = self.__class__.field(path + [("field", None)], service) - self.filled = self.__class__.filled(path + [("filled", None)], service) - self.boundary_values = self.__class__.boundary_values(path + [("boundary_values", None)], service) - self.contour_lines = self.__class__.contour_lines(path + [("contour_lines", None)], service) - self.node_values = self.__class__.node_values(path + [("node_values", None)], service) - self.surfaces_list = self.__class__.surfaces_list(path + [("surfaces_list", None)], service) - self.range_option = self.__class__.range_option(path + [("range_option", None)], service) - self.coloring = self.__class__.coloring(path + [("coloring", None)], service) - self.color_map = self.__class__.color_map(path + [("color_map", None)], service) - self.draw_mesh = self.__class__.draw_mesh(path + [("draw_mesh", None)], service) - self.mesh_object = self.__class__.mesh_object(path + [("mesh_object", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - self.physics = self.__class__.physics(path + [("physics", None)], service) - self.geometry = self.__class__.geometry(path + [("geometry", None)], service) - self.surfaces = self.__class__.surfaces(path + [("surfaces", None)], service) - - class name(metaclass=PyMenuMeta): + self.color_mode = self.__class__.color_mode(path + [("color_mode", None)], service) + self.driver = self.__class__.driver(path + [("driver", None)], service) + super().__init__(path, service) + def invert_background(self, *args, **kwargs): """ + Use a white background when the picture is saved. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class field(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/invert_background").execute(*args, **kwargs) + def landscape(self, *args, **kwargs): """ + Plot hardcopies in landscape or portrait orientation. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class filled(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/landscape").execute(*args, **kwargs) + def preview(self, *args, **kwargs): """ + Display a preview image of a hardcopy. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class boundary_values(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/preview").execute(*args, **kwargs) + def x_resolution(self, *args, **kwargs): """ + Set the width of raster-formatted images in pixels (0 implies current window size). """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class contour_lines(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/x_resolution").execute(*args, **kwargs) + def y_resolution(self, *args, **kwargs): """ + Set the height of raster-formatted images in pixels (0 implies current window size). """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class node_values(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/y_resolution").execute(*args, **kwargs) + def dpi(self, *args, **kwargs): """ + Set the DPI for EPS and Postscript files, specifies the resolution in dots per inch (DPI) instead of setting the width and height. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces_list(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/dpi").execute(*args, **kwargs) + def use_window_resolution(self, *args, **kwargs): """ + Use the currently active window's resolution for hardcopy (ignores the x-resolution and y-resolution in this case). """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/display/set/picture/use_window_resolution").execute(*args, **kwargs) + def set_standard_resolution(self, *args, **kwargs): + """ + Select from pre-defined resolution list. + """ + return PyMenu(self.service, "/display/set/picture/set_standard_resolution").execute(*args, **kwargs) + def jpeg_hardcopy_quality(self, *args, **kwargs): + """ + To set jpeg hardcopy quality. + """ + return PyMenu(self.service, "/display/set/picture/jpeg_hardcopy_quality").execute(*args, **kwargs) - class range_option(metaclass=PyMenuMeta): + class color_mode(TUIMenu): """ + Enter the hardcopy color mode menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.auto_range_on = self.__class__.auto_range_on(path + [("auto_range_on", None)], service) - self.auto_range_off = self.__class__.auto_range_off(path + [("auto_range_off", None)], service) - - class auto_range_on(metaclass=PyMenuMeta): + super().__init__(path, service) + def color(self, *args, **kwargs): """ + Plot hardcopies in color. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.global_range = self.__class__.global_range(path + [("global_range", None)], service) - - class global_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class auto_range_off(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/color_mode/color").execute(*args, **kwargs) + def gray_scale(self, *args, **kwargs): """ + Convert color to grayscale for hardcopy. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.clip_to_range = self.__class__.clip_to_range(path + [("clip_to_range", None)], service) - self.minimum = self.__class__.minimum(path + [("minimum", None)], service) - self.maximum = self.__class__.maximum(path + [("maximum", None)], service) - - class clip_to_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class minimum(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class maximum(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coloring(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.smooth = self.__class__.smooth(path + [("smooth", None)], service) - self.banded = self.__class__.banded(path + [("banded", None)], service) - - class smooth(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/color_mode/gray_scale").execute(*args, **kwargs) + def mono_chrome(self, *args, **kwargs): """ + Convert color to monochrome (black and white) for hardcopy. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class banded(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/color_mode/mono_chrome").execute(*args, **kwargs) + def list(self, *args, **kwargs): """ + Display the current hardcopy color mode. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/display/set/picture/color_mode/list").execute(*args, **kwargs) - class color_map(metaclass=PyMenuMeta): + class driver(TUIMenu): """ + Enter the set hardcopy driver menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.visible = self.__class__.visible(path + [("visible", None)], service) - self.size = self.__class__.size(path + [("size", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) - self.log_scale = self.__class__.log_scale(path + [("log_scale", None)], service) - self.format = self.__class__.format(path + [("format", None)], service) - self.user_skip = self.__class__.user_skip(path + [("user_skip", None)], service) - self.show_all = self.__class__.show_all(path + [("show_all", None)], service) - self.position = self.__class__.position(path + [("position", None)], service) - self.font_name = self.__class__.font_name(path + [("font_name", None)], service) - self.font_automatic = self.__class__.font_automatic(path + [("font_automatic", None)], service) - self.font_size = self.__class__.font_size(path + [("font_size", None)], service) - self.length = self.__class__.length(path + [("length", None)], service) - self.width = self.__class__.width(path + [("width", None)], service) - - class visible(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class size(metaclass=PyMenuMeta): + self.post_format = self.__class__.post_format(path + [("post_format", None)], service) + super().__init__(path, service) + def dump_window(self, *args, **kwargs): """ + Set the command used to dump the graphics window to a file. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/driver/dump_window").execute(*args, **kwargs) + def eps(self, *args, **kwargs): """ + Produce encapsulated PostScript (EPS) output for hardcopies. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class log_scale(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/driver/eps").execute(*args, **kwargs) + def jpeg(self, *args, **kwargs): """ + Produce JPEG output for hardcopies. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class format(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/driver/jpeg").execute(*args, **kwargs) + def post_script(self, *args, **kwargs): """ + Produce PostScript output for hardcopies. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class user_skip(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/driver/post_script").execute(*args, **kwargs) + def ppm(self, *args, **kwargs): """ + Produce PPM output for hardcopies. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class show_all(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/driver/ppm").execute(*args, **kwargs) + def tiff(self, *args, **kwargs): """ + Use TIFF output for hardcopies. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class position(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/driver/tiff").execute(*args, **kwargs) + def png(self, *args, **kwargs): """ + Use PNG output for hardcopies. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_name(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/driver/png").execute(*args, **kwargs) + def hsf(self, *args, **kwargs): """ + Use HSF output for hardcopies. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_automatic(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/driver/hsf").execute(*args, **kwargs) + def avz(self, *args, **kwargs): """ + Use AVZ output for hardcopies. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_size(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/driver/avz").execute(*args, **kwargs) + def glb(self, *args, **kwargs): """ + Use GLB output for hardcopies. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class length(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/driver/glb").execute(*args, **kwargs) + def vrml(self, *args, **kwargs): """ + Use VRML output for hardcopies. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class width(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/picture/driver/vrml").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + List the current hardcopy driver. + """ + return PyMenu(self.service, "/display/set/picture/driver/list").execute(*args, **kwargs) + def options(self, *args, **kwargs): + """ + Set the hardcopy options. Available options are: + \\n "no gamma correction", disables gamma correction of colors, + \\n "physical size = (width,height)", where width and height + are the actual measurements of the printable area of the page + in centimeters. + \\n "subscreen = (left,right,bottom,top)", where left,right, + bottom, and top are numbers in [-1,1] describing a subwindow on + the page in which to place the hardcopy. + + \\n The options may be combined by separating them with commas. + """ + return PyMenu(self.service, "/display/set/picture/driver/options").execute(*args, **kwargs) + + class post_format(TUIMenu): """ + Enter the PostScript driver format menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def fast_raster(self, *args, **kwargs): + """ + Use the new raster format. + """ + return PyMenu(self.service, "/display/set/picture/driver/post_format/fast_raster").execute(*args, **kwargs) + def raster(self, *args, **kwargs): + """ + Use the original raster format. + """ + return PyMenu(self.service, "/display/set/picture/driver/post_format/raster").execute(*args, **kwargs) + def rle_raster(self, *args, **kwargs): + """ + Use the run-length encoded raster format. + """ + return PyMenu(self.service, "/display/set/picture/driver/post_format/rle_raster").execute(*args, **kwargs) + def vector(self, *args, **kwargs): + """ + Use vector format. + """ + return PyMenu(self.service, "/display/set/picture/driver/post_format/vector").execute(*args, **kwargs) - class draw_mesh(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mesh_object(metaclass=PyMenuMeta): + class lights(TUIMenu): + """ + Enter the lights menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.lighting_interpolation = self.__class__.lighting_interpolation(path + [("lighting_interpolation", None)], service) + super().__init__(path, service) + def lights_on(self, *args, **kwargs): """ + Turn all active lighting on/off. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class display_state_name(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/lights/lights_on").execute(*args, **kwargs) + def set_ambient_color(self, *args, **kwargs): """ + Set the ambient light color for the scene. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class physics(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/lights/set_ambient_color").execute(*args, **kwargs) + def set_light(self, *args, **kwargs): """ + Add or modify a directional, colored light. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geometry(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/lights/set_light").execute(*args, **kwargs) + def headlight_on(self, *args, **kwargs): """ + Turn the light that moves with the camera on or off. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/display/set/lights/headlight_on").execute(*args, **kwargs) - class surfaces(metaclass=PyMenuMeta): + class lighting_interpolation(TUIMenu): """ + Set lighting interpolation method. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def automatic(self, *args, **kwargs): + """ + Choose Automatic to automatically select the best lighting method for a given graphics object. + """ + return PyMenu(self.service, "/display/set/lights/lighting_interpolation/automatic").execute(*args, **kwargs) + def flat(self, *args, **kwargs): + """ + Use flat shading for meshes and polygons. + """ + return PyMenu(self.service, "/display/set/lights/lighting_interpolation/flat").execute(*args, **kwargs) + def gouraud(self, *args, **kwargs): + """ + Use Gouraud shading to calculate the color at each vertex of a polygon and interpolate it in the interior. + """ + return PyMenu(self.service, "/display/set/lights/lighting_interpolation/gouraud").execute(*args, **kwargs) + def phong(self, *args, **kwargs): + """ + Use Phong shading to interpolate the normals for each pixel of a polygon and compute a color at every pixel. + """ + return PyMenu(self.service, "/display/set/lights/lighting_interpolation/phong").execute(*args, **kwargs) - class vector(metaclass=PyNamedObjectMeta): + class particle_tracks(TUIMenu): """ + Enters the particle-tracks menu to set parameters for display of particle tracks. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.field = self.__class__.field(path + [("field", None)], service) - self.vector_field = self.__class__.vector_field(path + [("vector_field", None)], service) - self.surfaces_list = self.__class__.surfaces_list(path + [("surfaces_list", None)], service) - self.scale = self.__class__.scale(path + [("scale", None)], service) - self.style = self.__class__.style(path + [("style", None)], service) - self.skip = self.__class__.skip(path + [("skip", None)], service) - self.vector_opt = self.__class__.vector_opt(path + [("vector_opt", None)], service) - self.range_option = self.__class__.range_option(path + [("range_option", None)], service) - self.color_map = self.__class__.color_map(path + [("color_map", None)], service) - self.draw_mesh = self.__class__.draw_mesh(path + [("draw_mesh", None)], service) - self.mesh_object = self.__class__.mesh_object(path + [("mesh_object", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - self.physics = self.__class__.physics(path + [("physics", None)], service) - self.geometry = self.__class__.geometry(path + [("geometry", None)], service) - self.surfaces = self.__class__.surfaces(path + [("surfaces", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class field(metaclass=PyMenuMeta): + self.sphere_settings = self.__class__.sphere_settings(path + [("sphere_settings", None)], service) + self.vector_settings = self.__class__.vector_settings(path + [("vector_settings", None)], service) + self.filter_settings = self.__class__.filter_settings(path + [("filter_settings", None)], service) + super().__init__(path, service) + def display(self, *args, **kwargs): """ + Determines whether particle tracks shall be displayed or only tracked. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vector_field(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/display").execute(*args, **kwargs) + def history_filename(self, *args, **kwargs): """ + Specifies the name of the particle history file. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces_list(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/history_filename").execute(*args, **kwargs) + def report_to(self, *args, **kwargs): + """ + Specifies the destination for the report (console, file, none). """ + return PyMenu(self.service, "/display/set/particle_tracks/report_to").execute(*args, **kwargs) + def report_type(self, *args, **kwargs): """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class scale(metaclass=PyMenuMeta): + Sets the report type for particle tracks. """ + return PyMenu(self.service, "/display/set/particle_tracks/report_type").execute(*args, **kwargs) + def report_variables(self, *args, **kwargs): """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_scale = self.__class__.auto_scale(path + [("auto_scale", None)], service) - self.scale_f = self.__class__.scale_f(path + [("scale_f", None)], service) - - class auto_scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class scale_f(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class style(metaclass=PyMenuMeta): + Sets the report variables. """ + return PyMenu(self.service, "/display/set/particle_tracks/report_variables").execute(*args, **kwargs) + def report_default_variables(self, *args, **kwargs): """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class skip(metaclass=PyMenuMeta): + Sets the report variables to default. """ + return PyMenu(self.service, "/display/set/particle_tracks/report_default_variables").execute(*args, **kwargs) + def track_single_particle_stream(self, *args, **kwargs): """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + Specifies the stream ID to be tracked. + """ + return PyMenu(self.service, "/display/set/particle_tracks/track_single_particle_stream").execute(*args, **kwargs) + def arrow_scale(self, *args, **kwargs): + """ + Sets the scale factor for arrows drawn on particle tracks. + """ + return PyMenu(self.service, "/display/set/particle_tracks/arrow_scale").execute(*args, **kwargs) + def arrow_space(self, *args, **kwargs): + """ + Sets the spacing factor for arrows drawn on particle tracks. + """ + return PyMenu(self.service, "/display/set/particle_tracks/arrow_space").execute(*args, **kwargs) + def coarsen_factor(self, *args, **kwargs): + """ + Sets the coarsening factor for particle tracks. + """ + return PyMenu(self.service, "/display/set/particle_tracks/coarsen_factor").execute(*args, **kwargs) + def line_width(self, *args, **kwargs): + """ + Sets the width for particle track. + """ + return PyMenu(self.service, "/display/set/particle_tracks/line_width").execute(*args, **kwargs) + def marker_size(self, *args, **kwargs): + """ + Sets the size of markers used to represent particle tracks. + """ + return PyMenu(self.service, "/display/set/particle_tracks/marker_size").execute(*args, **kwargs) + def radius(self, *args, **kwargs): + """ + Sets the radius for particle track (ribbon/cylinder only) cross-section. + """ + return PyMenu(self.service, "/display/set/particle_tracks/radius").execute(*args, **kwargs) + def style(self, *args, **kwargs): + """ + Sets the display style for particle track (line/ribbon/cylinder/sphere). + """ + return PyMenu(self.service, "/display/set/particle_tracks/style").execute(*args, **kwargs) + def twist_factor(self, *args, **kwargs): + """ + Sets the scale factor for twisting (ribbons only). + """ + return PyMenu(self.service, "/display/set/particle_tracks/twist_factor").execute(*args, **kwargs) + def sphere_attrib(self, *args, **kwargs): + """ + Specifies the size and number of slices to be used in drawing spheres. + """ + return PyMenu(self.service, "/display/set/particle_tracks/sphere_attrib").execute(*args, **kwargs) + def particle_skip(self, *args, **kwargs): + """ + Specifies how many particle tracks should be displayed. + """ + return PyMenu(self.service, "/display/set/particle_tracks/particle_skip").execute(*args, **kwargs) - class vector_opt(metaclass=PyMenuMeta): + class sphere_settings(TUIMenu): """ + Provide sphere specific input. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.in_plane = self.__class__.in_plane(path + [("in_plane", None)], service) - self.fixed_length = self.__class__.fixed_length(path + [("fixed_length", None)], service) - self.x_comp = self.__class__.x_comp(path + [("x_comp", None)], service) - self.y_comp = self.__class__.y_comp(path + [("y_comp", None)], service) - self.z_comp = self.__class__.z_comp(path + [("z_comp", None)], service) - self.scale_head = self.__class__.scale_head(path + [("scale_head", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) - - class in_plane(metaclass=PyMenuMeta): + super().__init__(path, service) + def vary_diameter(self, *args, **kwargs): """ + Specifies whether the spheres can vary with another variable. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class fixed_length(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/sphere_settings/vary_diameter").execute(*args, **kwargs) + def diameter(self, *args, **kwargs): """ + Diameter of the spheres whenvary-diameter is disabled. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class x_comp(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/sphere_settings/diameter").execute(*args, **kwargs) + def auto_range(self, *args, **kwargs): """ + Specifies whether displayed spheres should include auto range of variable to size spheres. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class y_comp(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/sphere_settings/auto_range").execute(*args, **kwargs) + def minimum(self, *args, **kwargs): """ + Sets the minimum value of the sphere to be displayed. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class z_comp(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/sphere_settings/minimum").execute(*args, **kwargs) + def maximum(self, *args, **kwargs): """ + Sets the maximum value of the sphere to be displayed. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class scale_head(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/sphere_settings/maximum").execute(*args, **kwargs) + def smooth_parameter(self, *args, **kwargs): """ + Specifies number of slices to be used in drawing spheres. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/sphere_settings/smooth_parameter").execute(*args, **kwargs) + def scale_factor(self, *args, **kwargs): """ + Specifies a scale factor to enlarge/reduce the size of spheres. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/display/set/particle_tracks/sphere_settings/scale_factor").execute(*args, **kwargs) + def size_variable(self, *args, **kwargs): + """ + Selects a particle variable to size the spheres. + """ + return PyMenu(self.service, "/display/set/particle_tracks/sphere_settings/size_variable").execute(*args, **kwargs) - class range_option(metaclass=PyMenuMeta): + class vector_settings(TUIMenu): """ + Set vector specific input. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.auto_range_on = self.__class__.auto_range_on(path + [("auto_range_on", None)], service) - self.auto_range_off = self.__class__.auto_range_off(path + [("auto_range_off", None)], service) - - class auto_range_on(metaclass=PyMenuMeta): + super().__init__(path, service) + def style(self, *args, **kwargs): """ + Enables and sets the display style for particle vectors (none/vector/centered-vector/centered-cylinder). """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.global_range = self.__class__.global_range(path + [("global_range", None)], service) - - class global_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class auto_range_off(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/style").execute(*args, **kwargs) + def vector_length(self, *args, **kwargs): """ + Specifies the length of constant vectors. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.clip_to_range = self.__class__.clip_to_range(path + [("clip_to_range", None)], service) - self.minimum = self.__class__.minimum(path + [("minimum", None)], service) - self.maximum = self.__class__.maximum(path + [("maximum", None)], service) - - class clip_to_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class minimum(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class maximum(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color_map(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.visible = self.__class__.visible(path + [("visible", None)], service) - self.size = self.__class__.size(path + [("size", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) - self.log_scale = self.__class__.log_scale(path + [("log_scale", None)], service) - self.format = self.__class__.format(path + [("format", None)], service) - self.user_skip = self.__class__.user_skip(path + [("user_skip", None)], service) - self.show_all = self.__class__.show_all(path + [("show_all", None)], service) - self.position = self.__class__.position(path + [("position", None)], service) - self.font_name = self.__class__.font_name(path + [("font_name", None)], service) - self.font_automatic = self.__class__.font_automatic(path + [("font_automatic", None)], service) - self.font_size = self.__class__.font_size(path + [("font_size", None)], service) - self.length = self.__class__.length(path + [("length", None)], service) - self.width = self.__class__.width(path + [("width", None)], service) - - class visible(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class size(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/vector_length").execute(*args, **kwargs) + def vector_length_variable(self, *args, **kwargs): """ + Selects a particle variable to specify the length of vectors. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/vector_length_variable").execute(*args, **kwargs) + def scale_factor(self, *args, **kwargs): """ + Specifies a scale factor to enlarge/reduce the length of vectors. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class log_scale(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/scale_factor").execute(*args, **kwargs) + def length_variable(self, *args, **kwargs): """ + Specifies whether the displayed vectors have length varying with another variable. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class format(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/length_variable").execute(*args, **kwargs) + def length_to_head_ratio(self, *args, **kwargs): """ + Specifies ratio of length to head for vectors and length to diameter for cylinders. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class user_skip(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/length_to_head_ratio").execute(*args, **kwargs) + def constant_color(self, *args, **kwargs): """ + Specifies a constant color for the vectors. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class show_all(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/constant_color").execute(*args, **kwargs) + def color_variable(self, *args, **kwargs): """ + Specifies whether the vectors should be colored by variable specified in /display/particle-track/particle-track (if false use a constant color). """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class position(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/color_variable").execute(*args, **kwargs) + def vector_variable(self, *args, **kwargs): """ + Selects a particle vector function to specify vector direction. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/vector_variable").execute(*args, **kwargs) - class font_name(metaclass=PyMenuMeta): + class filter_settings(TUIMenu): + """ + Set filter for particle display. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable_filtering(self, *args, **kwargs): """ + Specifies whether particle display is filtered. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_automatic(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/filter_settings/enable_filtering").execute(*args, **kwargs) + def inside(self, *args, **kwargs): """ + Specifies whether filter variable must be inside min/max to be displayed (else outside min/max). """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_size(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/filter_settings/inside").execute(*args, **kwargs) + def filter_variable(self, *args, **kwargs): """ + Selects a variable used for filtering of particles. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class length(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/filter_settings/filter_variable").execute(*args, **kwargs) + def minimum(self, *args, **kwargs): """ + Specifies the lower bound for the filter variable. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class width(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/particle_tracks/filter_settings/minimum").execute(*args, **kwargs) + def maximum(self, *args, **kwargs): """ + Specifies the upper bound for the filter variable. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/display/set/particle_tracks/filter_settings/maximum").execute(*args, **kwargs) - class draw_mesh(metaclass=PyMenuMeta): + class path_lines(TUIMenu): + """ + Sets parameters for display of pathlines. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def arrow_scale(self, *args, **kwargs): """ + Sets the scale factor for arrows drawn on pathlines. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mesh_object(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/path_lines/arrow_scale").execute(*args, **kwargs) + def arrow_space(self, *args, **kwargs): """ + Sets the spacing factor for arrows drawn on pathlines. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class display_state_name(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/path_lines/arrow_space").execute(*args, **kwargs) + def display_steps(self, *args, **kwargs): """ + Sets the display stepping for pathlines. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class physics(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/path_lines/display_steps").execute(*args, **kwargs) + def error_control(self, *args, **kwargs): """ + Sets error control during pathline computation. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geometry(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/path_lines/error_control").execute(*args, **kwargs) + def line_width(self, *args, **kwargs): """ + Sets the width for pathlines. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/path_lines/line_width").execute(*args, **kwargs) + def marker_size(self, *args, **kwargs): """ + Sets the marker size for particle drawing. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class pathlines(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.uid = self.__class__.uid(path + [("uid", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - self.range = self.__class__.range(path + [("range", None)], service) - self.style_attribute = self.__class__.style_attribute(path + [("style_attribute", None)], service) - self.accuracy_control = self.__class__.accuracy_control(path + [("accuracy_control", None)], service) - self.plot = self.__class__.plot(path + [("plot", None)], service) - self.step = self.__class__.step(path + [("step", None)], service) - self.skip = self.__class__.skip(path + [("skip", None)], service) - self.coarsen = self.__class__.coarsen(path + [("coarsen", None)], service) - self.onzone = self.__class__.onzone(path + [("onzone", None)], service) - self.field = self.__class__.field(path + [("field", None)], service) - self.surfaces_list = self.__class__.surfaces_list(path + [("surfaces_list", None)], service) - self.velocity_domain = self.__class__.velocity_domain(path + [("velocity_domain", None)], service) - self.color_map = self.__class__.color_map(path + [("color_map", None)], service) - self.draw_mesh = self.__class__.draw_mesh(path + [("draw_mesh", None)], service) - self.mesh_object = self.__class__.mesh_object(path + [("mesh_object", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - self.physics = self.__class__.physics(path + [("physics", None)], service) - self.geometry = self.__class__.geometry(path + [("geometry", None)], service) - self.surfaces = self.__class__.surfaces(path + [("surfaces", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uid(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/path_lines/marker_size").execute(*args, **kwargs) + def maximum_steps(self, *args, **kwargs): """ + Sets the maximum number of steps to take for pathlines. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class options(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/path_lines/maximum_steps").execute(*args, **kwargs) + def maximum_error(self, *args, **kwargs): """ + Sets the maximum error allowed while computing the pathlines. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.oil_flow = self.__class__.oil_flow(path + [("oil_flow", None)], service) - self.reverse = self.__class__.reverse(path + [("reverse", None)], service) - self.node_values = self.__class__.node_values(path + [("node_values", None)], service) - self.relative = self.__class__.relative(path + [("relative", None)], service) - - class oil_flow(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class reverse(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class node_values(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class relative(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class range(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/path_lines/maximum_error").execute(*args, **kwargs) + def radius(self, *args, **kwargs): """ + Sets the radius for pathline (ribbons/cylinder only) cross-section. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_range = self.__class__.auto_range(path + [("auto_range", None)], service) - self.clip_to_range = self.__class__.clip_to_range(path + [("clip_to_range", None)], service) + return PyMenu(self.service, "/display/set/path_lines/radius").execute(*args, **kwargs) + def relative_pathlines(self, *args, **kwargs): + """ + Enables/disables the tracking of pathlines in a relative coordinate system. + """ + return PyMenu(self.service, "/display/set/path_lines/relative_pathlines").execute(*args, **kwargs) + def style(self, *args, **kwargs): + """ + Selects the pathline style (line, point, ribbon, triangle, cylinder). + """ + return PyMenu(self.service, "/display/set/path_lines/style").execute(*args, **kwargs) + def twist_factor(self, *args, **kwargs): + """ + Sets the scale factor for twisting (ribbons only). + """ + return PyMenu(self.service, "/display/set/path_lines/twist_factor").execute(*args, **kwargs) + def step_size(self, *args, **kwargs): + """ + Sets the step length between particle positions for pathlines. + """ + return PyMenu(self.service, "/display/set/path_lines/step_size").execute(*args, **kwargs) + def reverse(self, *args, **kwargs): + """ + Sets direction of path tracking. + """ + return PyMenu(self.service, "/display/set/path_lines/reverse").execute(*args, **kwargs) + def sphere_attrib(self, *args, **kwargs): + """ + Specifies the size and number of slices to be used in drawing spheres. + """ + return PyMenu(self.service, "/display/set/path_lines/sphere_attrib").execute(*args, **kwargs) + def track_in_phase(self, *args, **kwargs): + """ + Selects the phase in which particle pathlines will be computed (Multiphase Eulerian Model only). + """ + return PyMenu(self.service, "/display/set/path_lines/track_in_phase").execute(*args, **kwargs) - class auto_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class rendering_options(TUIMenu): + """ + Enter the rendering options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def auto_spin(self, *args, **kwargs): + """ + Enable/disable mouse view rotations to continue to spin the display after the button is released. + """ + return PyMenu(self.service, "/display/set/rendering_options/auto_spin").execute(*args, **kwargs) + def device_info(self, *args, **kwargs): + """ + List information for the graphics device. + """ + return PyMenu(self.service, "/display/set/rendering_options/device_info").execute(*args, **kwargs) + def double_buffering(self, *args, **kwargs): + """ + Enable/disable double-buffering. + """ + return PyMenu(self.service, "/display/set/rendering_options/double_buffering").execute(*args, **kwargs) + def driver(self, *args, **kwargs): + """ + Change the current graphics driver. + """ + return PyMenu(self.service, "/display/set/rendering_options/driver").execute(*args, **kwargs) + def hidden_surfaces(self, *args, **kwargs): + """ + Enable/disable hidden surface removal. + """ + return PyMenu(self.service, "/display/set/rendering_options/hidden_surfaces").execute(*args, **kwargs) + def hidden_surface_method(self, *args, **kwargs): + """ + Specify the method to perform hidden line and hidden surface rendering. + """ + return PyMenu(self.service, "/display/set/rendering_options/hidden_surface_method").execute(*args, **kwargs) + def outer_face_cull(self, *args, **kwargs): + """ + Enable/disable discarding outer faces during display. + """ + return PyMenu(self.service, "/display/set/rendering_options/outer_face_cull").execute(*args, **kwargs) + def surface_edge_visibility(self, *args, **kwargs): + """ + Set edge visibility flags for surfaces. + """ + return PyMenu(self.service, "/display/set/rendering_options/surface_edge_visibility").execute(*args, **kwargs) + def animation_option(self, *args, **kwargs): + """ + Using Wireframe / All option during animation. + """ + return PyMenu(self.service, "/display/set/rendering_options/animation_option").execute(*args, **kwargs) + def color_map_alignment(self, *args, **kwargs): + """ + Set the color bar alignment. + """ + return PyMenu(self.service, "/display/set/rendering_options/color_map_alignment").execute(*args, **kwargs) + def help_text_color(self, *args, **kwargs): + """ + Set the color of screen help text. + """ + return PyMenu(self.service, "/display/set/rendering_options/help_text_color").execute(*args, **kwargs) + def face_displacement(self, *args, **kwargs): + """ + Set face displacement value in Z-buffer units along the Camera Z-axis. + """ + return PyMenu(self.service, "/display/set/rendering_options/face_displacement").execute(*args, **kwargs) + def set_rendering_options(self, *args, **kwargs): + """ + Set the rendering options. + """ + return PyMenu(self.service, "/display/set/rendering_options/set_rendering_options").execute(*args, **kwargs) + def show_colormap(self, *args, **kwargs): + """ + Enable/Disable colormap. + """ + return PyMenu(self.service, "/display/set/rendering_options/show_colormap").execute(*args, **kwargs) - class clip_to_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.min_value = self.__class__.min_value(path + [("min_value", None)], service) - self.max_value = self.__class__.max_value(path + [("max_value", None)], service) + class titles(TUIMenu): + """ + Set problem title. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def left_top(self, *args, **kwargs): + """ + Set the title text for left top in title segment. + """ + return PyMenu(self.service, "/display/set/titles/left_top").execute(*args, **kwargs) + def left_bottom(self, *args, **kwargs): + """ + Set the title text for left bottom in title segment. + """ + return PyMenu(self.service, "/display/set/titles/left_bottom").execute(*args, **kwargs) + def right_top(self, *args, **kwargs): + """ + Set the title text for right top in title segment. + """ + return PyMenu(self.service, "/display/set/titles/right_top").execute(*args, **kwargs) + def right_middle(self, *args, **kwargs): + """ + Set the title text for right middle in title segment. + """ + return PyMenu(self.service, "/display/set/titles/right_middle").execute(*args, **kwargs) + def right_bottom(self, *args, **kwargs): + """ + Set the title text for right bottom in title segment. + """ + return PyMenu(self.service, "/display/set/titles/right_bottom").execute(*args, **kwargs) - class min_value(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class velocity_vectors(TUIMenu): + """ + Enters the menu to set parameters for display of velocity vectors. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def auto_scale(self, *args, **kwargs): + """ + Auto-scales all vectors so that vector overlap is minimal. + """ + return PyMenu(self.service, "/display/set/velocity_vectors/auto_scale").execute(*args, **kwargs) + def color(self, *args, **kwargs): + """ + Sets the color of all velocity vectors to the color specified. The color scale is ignored. This is useful when overlaying a vector plot over a contour plot. + """ + return PyMenu(self.service, "/display/set/velocity_vectors/color").execute(*args, **kwargs) + def component_x(self, *args, **kwargs): + """ + Sets the option to use only the component of the velocity vectors during display. + """ + return PyMenu(self.service, "/display/set/velocity_vectors/component_x").execute(*args, **kwargs) + def component_y(self, *args, **kwargs): + """ + Sets the option to use only the component of the velocity vectors during display. + """ + return PyMenu(self.service, "/display/set/velocity_vectors/component_y").execute(*args, **kwargs) + def component_z(self, *args, **kwargs): + """ + Sets the option to use only the component of the velocity vectors during display. + """ + return PyMenu(self.service, "/display/set/velocity_vectors/component_z").execute(*args, **kwargs) + def constant_length(self, *args, **kwargs): + """ + Sets the option to draw velocity vectors of constant length. This shows only the direction of the velocity vectors. + """ + return PyMenu(self.service, "/display/set/velocity_vectors/constant_length").execute(*args, **kwargs) + def color_levels(self, *args, **kwargs): + """ + Sets the number of colors used from the colormap. + """ + return PyMenu(self.service, "/display/set/velocity_vectors/color_levels").execute(*args, **kwargs) + def global_range(self, *args, **kwargs): + """ + Turns global range for vectors on/off. + """ + return PyMenu(self.service, "/display/set/velocity_vectors/global_range").execute(*args, **kwargs) + def in_plane(self, *args, **kwargs): + """ + Toggles the display of velocity vector components in the plane of the surface selected for display. + """ + return PyMenu(self.service, "/display/set/velocity_vectors/in_plane").execute(*args, **kwargs) + def log_scale(self, *args, **kwargs): + """ + Toggles whether color scale is logarithmic or linear. + """ + return PyMenu(self.service, "/display/set/velocity_vectors/log_scale").execute(*args, **kwargs) + def node_values(self, *args, **kwargs): + """ + Enables/disables the plotting of node values. Cell values will be plotted if "no". + """ + return PyMenu(self.service, "/display/set/velocity_vectors/node_values").execute(*args, **kwargs) + def relative(self, *args, **kwargs): + """ + Toggles the display of relative velocity vectors. + """ + return PyMenu(self.service, "/display/set/velocity_vectors/relative").execute(*args, **kwargs) + def render_mesh(self, *args, **kwargs): + """ + Enables/disables rendering the mesh on top of contours, vectors, and so on. + """ + return PyMenu(self.service, "/display/set/velocity_vectors/render_mesh").execute(*args, **kwargs) + def scale(self, *args, **kwargs): + """ + Sets the value by which the vector length will be scaled. + """ + return PyMenu(self.service, "/display/set/velocity_vectors/scale").execute(*args, **kwargs) + def scale_head(self, *args, **kwargs): + """ + Sets the value by which the vector head will be scaled. + """ + return PyMenu(self.service, "/display/set/velocity_vectors/scale_head").execute(*args, **kwargs) + def style(self, *args, **kwargs): + """ + Specifies the vector style that will be used when the vectors are displayed. You can choose from:3d arrow,3d arrowhead, cone,filled-arrow, arrow,harpoon, or headless. + """ + return PyMenu(self.service, "/display/set/velocity_vectors/style").execute(*args, **kwargs) + def surfaces(self, *args, **kwargs): + """ + Sets surfaces on which vectors are drawn. You can include a wildcard (*) within the surface names. + """ + return PyMenu(self.service, "/display/set/velocity_vectors/surfaces").execute(*args, **kwargs) - class max_value(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class windows(TUIMenu): + """ + Enter the window options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.axes = self.__class__.axes(path + [("axes", None)], service) + self.main = self.__class__.main(path + [("main", None)], service) + self.scale = self.__class__.scale(path + [("scale", None)], service) + self.text = self.__class__.text(path + [("text", None)], service) + self.video = self.__class__.video(path + [("video", None)], service) + self.xy = self.__class__.xy(path + [("xy", None)], service) + super().__init__(path, service) + def aspect_ratio(self, *args, **kwargs): + """ + Set the aspect ratio of the active window. + """ + return PyMenu(self.service, "/display/set/windows/aspect_ratio").execute(*args, **kwargs) + def logo(self, *args, **kwargs): + """ + Enable/disable visibility of the logo in graphics window. + """ + return PyMenu(self.service, "/display/set/windows/logo").execute(*args, **kwargs) + def ruler(self, *args, **kwargs): + """ + Enable/disable ruler visibility. + """ + return PyMenu(self.service, "/display/set/windows/ruler").execute(*args, **kwargs) + def logo_color(self, *args, **kwargs): + """ + Set logo color to white/black. + """ + return PyMenu(self.service, "/display/set/windows/logo_color").execute(*args, **kwargs) - class style_attribute(metaclass=PyMenuMeta): + class axes(TUIMenu): """ + Enter the axes window options menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.style = self.__class__.style(path + [("style", None)], service) - self.line_width = self.__class__.line_width(path + [("line_width", None)], service) - self.arrow_space = self.__class__.arrow_space(path + [("arrow_space", None)], service) - self.arrow_scale = self.__class__.arrow_scale(path + [("arrow_scale", None)], service) - self.marker_size = self.__class__.marker_size(path + [("marker_size", None)], service) - self.sphere_size = self.__class__.sphere_size(path + [("sphere_size", None)], service) - self.sphere_lod = self.__class__.sphere_lod(path + [("sphere_lod", None)], service) - self.radius = self.__class__.radius(path + [("radius", None)], service) - self.ribbon = self.__class__.ribbon(path + [("ribbon", None)], service) - - class style(metaclass=PyMenuMeta): + super().__init__(path, service) + def border(self, *args, **kwargs): """ + Enable/disable drawing of a border around the axes window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class line_width(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/axes/border").execute(*args, **kwargs) + def bottom(self, *args, **kwargs): """ + Set the bottom boundary of the axes window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class arrow_space(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/axes/bottom").execute(*args, **kwargs) + def clear(self, *args, **kwargs): """ + Set the transparency of the axes window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class arrow_scale(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/axes/clear").execute(*args, **kwargs) + def right(self, *args, **kwargs): """ + Set the right boundary of the axes window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class marker_size(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/axes/right").execute(*args, **kwargs) + def visible(self, *args, **kwargs): """ + Enable/disable axes visibility. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/display/set/windows/axes/visible").execute(*args, **kwargs) - class sphere_size(metaclass=PyMenuMeta): + class main(TUIMenu): + """ + Enter the main view window options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def border(self, *args, **kwargs): """ + Enable/disable drawing of borders around the main viewing window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sphere_lod(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/main/border").execute(*args, **kwargs) + def bottom(self, *args, **kwargs): """ + Set the bottom boundary of the main viewing window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class radius(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/main/bottom").execute(*args, **kwargs) + def left(self, *args, **kwargs): """ + Set the left boundary of the main viewing window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ribbon(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/main/left").execute(*args, **kwargs) + def right(self, *args, **kwargs): """ + Set the right boundary of the main viewing window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.field = self.__class__.field(path + [("field", None)], service) - self.scalefactor = self.__class__.scalefactor(path + [("scalefactor", None)], service) - - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class scalefactor(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class accuracy_control(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.step_size = self.__class__.step_size(path + [("step_size", None)], service) - self.tolerance = self.__class__.tolerance(path + [("tolerance", None)], service) - - class step_size(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/main/right").execute(*args, **kwargs) + def top(self, *args, **kwargs): """ + Set the top boundary of the main viewing window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class tolerance(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/main/top").execute(*args, **kwargs) + def visible(self, *args, **kwargs): """ + Enable/disable visibility of the main viewing window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/display/set/windows/main/visible").execute(*args, **kwargs) - class plot(metaclass=PyMenuMeta): + class scale(TUIMenu): """ + Enter the color scale window options menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.x_axis_function = self.__class__.x_axis_function(path + [("x_axis_function", None)], service) - self.enabled = self.__class__.enabled(path + [("enabled", None)], service) - - class x_axis_function(metaclass=PyMenuMeta): + super().__init__(path, service) + def border(self, *args, **kwargs): """ + Enable/disable drawing of borders around the color scale window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class enabled(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/scale/border").execute(*args, **kwargs) + def bottom(self, *args, **kwargs): """ + Set the bottom boundary of the color scale window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class step(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class skip(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coarsen(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class onzone(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces_list(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class velocity_domain(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color_map(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.visible = self.__class__.visible(path + [("visible", None)], service) - self.size = self.__class__.size(path + [("size", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) - self.log_scale = self.__class__.log_scale(path + [("log_scale", None)], service) - self.format = self.__class__.format(path + [("format", None)], service) - self.user_skip = self.__class__.user_skip(path + [("user_skip", None)], service) - self.show_all = self.__class__.show_all(path + [("show_all", None)], service) - self.position = self.__class__.position(path + [("position", None)], service) - self.font_name = self.__class__.font_name(path + [("font_name", None)], service) - self.font_automatic = self.__class__.font_automatic(path + [("font_automatic", None)], service) - self.font_size = self.__class__.font_size(path + [("font_size", None)], service) - self.length = self.__class__.length(path + [("length", None)], service) - self.width = self.__class__.width(path + [("width", None)], service) - - class visible(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class size(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/scale/bottom").execute(*args, **kwargs) + def clear(self, *args, **kwargs): """ + Set the transparency of the scale window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/scale/clear").execute(*args, **kwargs) + def format(self, *args, **kwargs): """ + Set the number format of the color scale window (e.g. %0.2e). """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class log_scale(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/scale/format").execute(*args, **kwargs) + def font_size(self, *args, **kwargs): """ + Set the font size of the color scale window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class format(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/scale/font_size").execute(*args, **kwargs) + def left(self, *args, **kwargs): """ + Set the left boundary of the color scale window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class user_skip(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/scale/left").execute(*args, **kwargs) + def margin(self, *args, **kwargs): """ + Set the margin of the color scale window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class show_all(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/scale/margin").execute(*args, **kwargs) + def right(self, *args, **kwargs): """ + Set the right boundary of the color scale window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class position(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/scale/right").execute(*args, **kwargs) + def top(self, *args, **kwargs): """ + Set the top boundary of the color scale window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_name(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/scale/top").execute(*args, **kwargs) + def visible(self, *args, **kwargs): """ + Enable/disable visibility of the color scale window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_automatic(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class width(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class draw_mesh(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mesh_object(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class display_state_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class physics(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geometry(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class particle_tracks(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.uid = self.__class__.uid(path + [("uid", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - self.filter_settings = self.__class__.filter_settings(path + [("filter_settings", None)], service) - self.range = self.__class__.range(path + [("range", None)], service) - self.style_attribute = self.__class__.style_attribute(path + [("style_attribute", None)], service) - self.vector_settings = self.__class__.vector_settings(path + [("vector_settings", None)], service) - self.plot = self.__class__.plot(path + [("plot", None)], service) - self.track_single_particle_stream = self.__class__.track_single_particle_stream(path + [("track_single_particle_stream", None)], service) - self.skip = self.__class__.skip(path + [("skip", None)], service) - self.coarsen = self.__class__.coarsen(path + [("coarsen", None)], service) - self.field = self.__class__.field(path + [("field", None)], service) - self.injections_list = self.__class__.injections_list(path + [("injections_list", None)], service) - self.free_stream_particles = self.__class__.free_stream_particles(path + [("free_stream_particles", None)], service) - self.wall_film_particles = self.__class__.wall_film_particles(path + [("wall_film_particles", None)], service) - self.track_pdf_particles = self.__class__.track_pdf_particles(path + [("track_pdf_particles", None)], service) - self.color_map = self.__class__.color_map(path + [("color_map", None)], service) - self.draw_mesh = self.__class__.draw_mesh(path + [("draw_mesh", None)], service) - self.mesh_object = self.__class__.mesh_object(path + [("mesh_object", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uid(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.node_values = self.__class__.node_values(path + [("node_values", None)], service) - - class node_values(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class filter_settings(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.field = self.__class__.field(path + [("field", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - self.enabled = self.__class__.enabled(path + [("enabled", None)], service) - self.filter_minimum = self.__class__.filter_minimum(path + [("filter_minimum", None)], service) - self.filter_maximum = self.__class__.filter_maximum(path + [("filter_maximum", None)], service) - - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.inside = self.__class__.inside(path + [("inside", None)], service) - self.outside = self.__class__.outside(path + [("outside", None)], service) - - class inside(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class outside(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class enabled(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class filter_minimum(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class filter_maximum(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_range = self.__class__.auto_range(path + [("auto_range", None)], service) - self.clip_to_range = self.__class__.clip_to_range(path + [("clip_to_range", None)], service) - - class auto_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class clip_to_range(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/scale/visible").execute(*args, **kwargs) + def alignment(self, *args, **kwargs): """ + Set colormap to bottom/left/top/right. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.min_value = self.__class__.min_value(path + [("min_value", None)], service) - self.max_value = self.__class__.max_value(path + [("max_value", None)], service) - - class min_value(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class max_value(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/display/set/windows/scale/alignment").execute(*args, **kwargs) - class style_attribute(metaclass=PyMenuMeta): + class text(TUIMenu): """ + Enter the text window options menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.style = self.__class__.style(path + [("style", None)], service) - self.line_width = self.__class__.line_width(path + [("line_width", None)], service) - self.arrow_space = self.__class__.arrow_space(path + [("arrow_space", None)], service) - self.arrow_scale = self.__class__.arrow_scale(path + [("arrow_scale", None)], service) - self.marker_size = self.__class__.marker_size(path + [("marker_size", None)], service) - self.sphere_size = self.__class__.sphere_size(path + [("sphere_size", None)], service) - self.sphere_lod = self.__class__.sphere_lod(path + [("sphere_lod", None)], service) - self.radius = self.__class__.radius(path + [("radius", None)], service) - self.ribbon_settings = self.__class__.ribbon_settings(path + [("ribbon_settings", None)], service) - self.sphere_settings = self.__class__.sphere_settings(path + [("sphere_settings", None)], service) - - class style(metaclass=PyMenuMeta): + super().__init__(path, service) + def application(self, *args, **kwargs): """ + Enable/disable the application name in the picture. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class line_width(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/text/application").execute(*args, **kwargs) + def border(self, *args, **kwargs): """ + Enable/disable drawing of borders around the text window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class arrow_space(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/text/border").execute(*args, **kwargs) + def bottom(self, *args, **kwargs): """ + Set the bottom boundary of the text window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class arrow_scale(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/text/bottom").execute(*args, **kwargs) + def clear(self, *args, **kwargs): """ + Enable/disable text window transparency. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class marker_size(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/text/clear").execute(*args, **kwargs) + def company(self, *args, **kwargs): """ + Enable/disable the company name in the picture. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sphere_size(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/text/company").execute(*args, **kwargs) + def date(self, *args, **kwargs): """ + Enable/disable the date in the picture. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sphere_lod(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/text/date").execute(*args, **kwargs) + def left(self, *args, **kwargs): """ + Set the left boundary of the text window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class radius(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/text/left").execute(*args, **kwargs) + def right(self, *args, **kwargs): """ + Set the right boundary of the text window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ribbon_settings(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/text/right").execute(*args, **kwargs) + def top(self, *args, **kwargs): """ + Set the top boundary of the text window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.field = self.__class__.field(path + [("field", None)], service) - self.scalefactor = self.__class__.scalefactor(path + [("scalefactor", None)], service) - - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class scalefactor(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sphere_settings(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/text/top").execute(*args, **kwargs) + def visible(self, *args, **kwargs): """ + Enable/disable text window transparency. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.scale = self.__class__.scale(path + [("scale", None)], service) - self.sphere_lod = self.__class__.sphere_lod(path + [("sphere_lod", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - - class scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sphere_lod(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.constant = self.__class__.constant(path + [("constant", None)], service) - self.variable = self.__class__.variable(path + [("variable", None)], service) - - class constant(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.diameter = self.__class__.diameter(path + [("diameter", None)], service) - - class diameter(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class variable(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.size_by = self.__class__.size_by(path + [("size_by", None)], service) - self.range = self.__class__.range(path + [("range", None)], service) - - class size_by(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_range = self.__class__.auto_range(path + [("auto_range", None)], service) - self.clip_to_range = self.__class__.clip_to_range(path + [("clip_to_range", None)], service) - - class auto_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class clip_to_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.min_value = self.__class__.min_value(path + [("min_value", None)], service) - self.max_value = self.__class__.max_value(path + [("max_value", None)], service) - - class min_value(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class max_value(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/display/set/windows/text/visible").execute(*args, **kwargs) - class vector_settings(metaclass=PyMenuMeta): + class video(TUIMenu): """ + Enter the video window options menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.style = self.__class__.style(path + [("style", None)], service) - self.vector_length = self.__class__.vector_length(path + [("vector_length", None)], service) - self.constant_color = self.__class__.constant_color(path + [("constant_color", None)], service) - self.vector_of = self.__class__.vector_of(path + [("vector_of", None)], service) - self.scale = self.__class__.scale(path + [("scale", None)], service) - self.length_to_head_ratio = self.__class__.length_to_head_ratio(path + [("length_to_head_ratio", None)], service) - - class style(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vector_length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.constant_length = self.__class__.constant_length(path + [("constant_length", None)], service) - self.variable_length = self.__class__.variable_length(path + [("variable_length", None)], service) - - class constant_length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class variable_length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class constant_color(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.enabled = self.__class__.enabled(path + [("enabled", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) - - class enabled(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vector_of(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class length_to_head_ratio(metaclass=PyMenuMeta): + super().__init__(path, service) + def background(self, *args, **kwargs): """ + Set the background color in the video picture. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class plot(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.x_axis_function = self.__class__.x_axis_function(path + [("x_axis_function", None)], service) - self.enabled = self.__class__.enabled(path + [("enabled", None)], service) - - class x_axis_function(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/video/background").execute(*args, **kwargs) + def color_filter(self, *args, **kwargs): """ + Set the color filter options for the picture. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class enabled(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/video/color_filter").execute(*args, **kwargs) + def foreground(self, *args, **kwargs): """ + Set the foreground color in the video picture. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class track_single_particle_stream(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.enabled = self.__class__.enabled(path + [("enabled", None)], service) - self.stream_id = self.__class__.stream_id(path + [("stream_id", None)], service) - - class enabled(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/video/foreground").execute(*args, **kwargs) + def on(self, *args, **kwargs): """ + Enable/disable video picture settings. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class stream_id(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/video/on").execute(*args, **kwargs) + def pixel_size(self, *args, **kwargs): """ + Set the window size in pixels. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class skip(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coarsen(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class injections_list(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class free_stream_particles(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wall_film_particles(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class track_pdf_particles(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/display/set/windows/video/pixel_size").execute(*args, **kwargs) - class color_map(metaclass=PyMenuMeta): + class xy(TUIMenu): """ + Enter the X-Y plot window options menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.visible = self.__class__.visible(path + [("visible", None)], service) - self.size = self.__class__.size(path + [("size", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) - self.log_scale = self.__class__.log_scale(path + [("log_scale", None)], service) - self.format = self.__class__.format(path + [("format", None)], service) - self.user_skip = self.__class__.user_skip(path + [("user_skip", None)], service) - self.show_all = self.__class__.show_all(path + [("show_all", None)], service) - self.position = self.__class__.position(path + [("position", None)], service) - self.font_name = self.__class__.font_name(path + [("font_name", None)], service) - self.font_automatic = self.__class__.font_automatic(path + [("font_automatic", None)], service) - self.font_size = self.__class__.font_size(path + [("font_size", None)], service) - self.length = self.__class__.length(path + [("length", None)], service) - self.width = self.__class__.width(path + [("width", None)], service) - - class visible(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class log_scale(metaclass=PyMenuMeta): + super().__init__(path, service) + def border(self, *args, **kwargs): """ + Enable/disable drawing of a border around the X-Y plotter window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class format(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/xy/border").execute(*args, **kwargs) + def bottom(self, *args, **kwargs): """ + Set the bottom boundary of the X-Y plotter window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class user_skip(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/xy/bottom").execute(*args, **kwargs) + def left(self, *args, **kwargs): """ + Set the left boundary of the X-Y plotter window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class show_all(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/xy/left").execute(*args, **kwargs) + def right(self, *args, **kwargs): """ + Set the right boundary of the X-Y plotter window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class position(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/xy/right").execute(*args, **kwargs) + def top(self, *args, **kwargs): """ + Set the top boundary of the X-Y plotter window. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_name(metaclass=PyMenuMeta): + return PyMenu(self.service, "/display/set/windows/xy/top").execute(*args, **kwargs) + def visible(self, *args, **kwargs): """ + Enable/disable X-Y plotter window visibility. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/display/set/windows/xy/visible").execute(*args, **kwargs) - class font_automatic(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class width(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class draw_mesh(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mesh_object(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class display_state_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class scene(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.title = self.__class__.title(path + [("title", None)], service) - self.temporary = self.__class__.temporary(path + [("temporary", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class title(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class temporary(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class display_state_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class flamelet_data(metaclass=PyMenuMeta): + class surface(TUIMenu): """ - Displays flamelet data. + Enters the data surface-manipulation menu. For a description of the items in this menu, see surface/ + """ def __init__(self, path, service): self.path = path self.service = service - def draw_number_box(self, *args, **kwargs): + self.post_processing_volume = self.__class__.post_processing_volume(path + [("post_processing_volume", None)], service) + self.query = self.__class__.query(path + [("query", None)], service) + super().__init__(path, service) + def circle_slice(self, *args, **kwargs): """ - Enables/disables display of the numbers box. + Extract a circular slice. """ - return PyMenu(self.service, "/display/flamelet_data/draw_number_box").execute(*args, **kwargs) - def plot_1d_slice(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/circle_slice").execute(*args, **kwargs) + def delete_surface(self, *args, **kwargs): """ - Enables/disables plot of the 1D-slice. + Remove a defined data surface. """ - return PyMenu(self.service, "/display/flamelet_data/plot_1d_slice").execute(*args, **kwargs) - def write_to_file(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/delete_surface").execute(*args, **kwargs) + def group_surfaces(self, *args, **kwargs): """ - Enables/disables writing the 1D-slice to file instead of plot. + Group a set of surfaces. """ - return PyMenu(self.service, "/display/flamelet_data/write_to_file").execute(*args, **kwargs) - def carpet_plot(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/group_surfaces").execute(*args, **kwargs) + def ungroup_surface(self, *args, **kwargs): """ - Enables/disables display of carpet plot of a property. + Ungroup the surface(if grouped). """ - return PyMenu(self.service, "/display/flamelet_data/carpet_plot").execute(*args, **kwargs) - - class particle_tracks(metaclass=PyMenuMeta): - """ - Enters the particle tracks menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def particle_tracks(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/ungroup_surface").execute(*args, **kwargs) + def iso_clip(self, *args, **kwargs): """ - Calculates and displays particle tracks from defined injections. + Clip a data surface (surface, curve, or point) between two iso-values. """ - return PyMenu(self.service, "/display/particle_tracks/particle_tracks").execute(*args, **kwargs) - def plot_write_xy_plot(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/iso_clip").execute(*args, **kwargs) + def iso_surface(self, *args, **kwargs): """ - Plots or writes an XY plot of particle tracks. + Extract an iso-surface (surface, curve, or point) from the curent data field. """ - return PyMenu(self.service, "/display/particle_tracks/plot_write_xy_plot").execute(*args, **kwargs) - - class path_lines(metaclass=PyMenuMeta): - """ - Enters the pathlines menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def path_lines(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/iso_surface").execute(*args, **kwargs) + def expression_volume(self, *args, **kwargs): """ - Displays pathlines from a surface. + Create volume with boolean expression. """ - return PyMenu(self.service, "/display/path_lines/path_lines").execute(*args, **kwargs) - def plot_write_xy_plot(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/expression_volume").execute(*args, **kwargs) + def multiple_iso_surfaces(self, *args, **kwargs): """ - Plots or writes an XY plot of pathlines. + Create multiple iso-surfaces from the data field at specified spacing. """ - return PyMenu(self.service, "/display/path_lines/plot_write_xy_plot").execute(*args, **kwargs) - def write_to_files(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/multiple_iso_surfaces").execute(*args, **kwargs) + def line_slice(self, *args, **kwargs): """ - Writes pathlines to a file. + Extract a linear slice. """ - return PyMenu(self.service, "/display/path_lines/write_to_files").execute(*args, **kwargs) - - class pdf_data(metaclass=PyMenuMeta): - """ - Enters the PDF data menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def draw_number_box(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/line_slice").execute(*args, **kwargs) + def line_surface(self, *args, **kwargs): """ - Enables/disables the display of the numbers box. + Define a "line" surface by specifying the two endpoint coordinates. """ - return PyMenu(self.service, "/display/pdf_data/draw_number_box").execute(*args, **kwargs) - def plot_1d_slice(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/line_surface").execute(*args, **kwargs) + def list_surfaces(self, *args, **kwargs): """ - Enables/disables a plot of the 1D-slice. + List the number of facets in the defined surfaces. """ - return PyMenu(self.service, "/display/pdf_data/plot_1d_slice").execute(*args, **kwargs) - def write_to_file(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/list_surfaces").execute(*args, **kwargs) + def mouse_line(self, *args, **kwargs): """ - Enables/disables writing the 1D-slice to file instead of plot. + Define a line surface using the mouse to select two points. """ - return PyMenu(self.service, "/display/pdf_data/write_to_file").execute(*args, **kwargs) - def carpet_plot(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/mouse_line").execute(*args, **kwargs) + def mouse_plane(self, *args, **kwargs): """ - Enables/disables the display of a carpet plot of a property. + Define a plane surface using the mouse to select three points. """ - return PyMenu(self.service, "/display/pdf_data/carpet_plot").execute(*args, **kwargs) - - class set(metaclass=PyMenuMeta): - """ - Enter the set menu to set display parameters. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.colors = self.__class__.colors(path + [("colors", None)], service) - self.contours = self.__class__.contours(path + [("contours", None)], service) - self.picture = self.__class__.picture(path + [("picture", None)], service) - self.lights = self.__class__.lights(path + [("lights", None)], service) - self.particle_tracks = self.__class__.particle_tracks(path + [("particle_tracks", None)], service) - self.path_lines = self.__class__.path_lines(path + [("path_lines", None)], service) - self.rendering_options = self.__class__.rendering_options(path + [("rendering_options", None)], service) - self.titles = self.__class__.titles(path + [("titles", None)], service) - self.velocity_vectors = self.__class__.velocity_vectors(path + [("velocity_vectors", None)], service) - self.windows = self.__class__.windows(path + [("windows", None)], service) - def color_map(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/mouse_plane").execute(*args, **kwargs) + def mouse_rake(self, *args, **kwargs): """ - Enters the color map menu, which contains names of predefined and user-defined (in the Colormap Editor panel) colormaps that can be selected. It prompts you for the name of the colormap to be used. + Define a "rake" surface using the mouse to select the end points. """ - return PyMenu(self.service, "/display/set/color_map").execute(*args, **kwargs) - def element_shrink(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/mouse_rake").execute(*args, **kwargs) + def partition_surface(self, *args, **kwargs): """ - Sets shrinkage of both faces and cells. A value of zero indicates no shrinkage, while a value of one will shrink each face or cell to a point. + Define a data surface on mesh faces on the partition boundary. """ - return PyMenu(self.service, "/display/set/element_shrink").execute(*args, **kwargs) - def filled_mesh(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/partition_surface").execute(*args, **kwargs) + def plane(self, *args, **kwargs): """ - Determines whether the meshes are drawn as wireframe or solid. + Create a plane given 3 points bounded by the domain. """ - return PyMenu(self.service, "/display/set/filled_mesh").execute(*args, **kwargs) - def mesh_level(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/plane").execute(*args, **kwargs) + def plane_surface(self, *args, **kwargs): """ - Sets coarse mesh level to be drawn. + Create a plane from a coordinate plane, point and normal, or three points. """ - return PyMenu(self.service, "/display/set/mesh_level").execute(*args, **kwargs) - def mesh_partitions(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/plane_surface").execute(*args, **kwargs) + def multiple_plane_surfaces(self, *args, **kwargs): """ - Enables/disables option to draw mesh partition boundaries. + Create multiple plane surfaces at specified spacing. """ - return PyMenu(self.service, "/display/set/mesh_partitions").execute(*args, **kwargs) - def mesh_surfaces(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/multiple_plane_surfaces").execute(*args, **kwargs) + def plane_slice(self, *args, **kwargs): """ - Sets surface IDs to be drawn as meshes. You can include a wildcard (*) within the surface names. + Extract a planar slice. """ - return PyMenu(self.service, "/display/set/mesh_surfaces").execute(*args, **kwargs) - def mesh_zones(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/plane_slice").execute(*args, **kwargs) + def point_array(self, *args, **kwargs): """ - Sets zone IDs to be drawn as meshes. + Extract a rectangular array of data points. """ - return PyMenu(self.service, "/display/set/mesh_zones").execute(*args, **kwargs) - def line_weight(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/point_array").execute(*args, **kwargs) + def point_surface(self, *args, **kwargs): """ - Set the line-weight factor for the window. + Define a "point" surface by specifying the coordinates. """ - return PyMenu(self.service, "/display/set/line_weight").execute(*args, **kwargs) - def marker_size(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/point_surface").execute(*args, **kwargs) + def structural_point_surface(self, *args, **kwargs): """ - Sets the size of markers used to represent points. + Define a "structural point" surface by specifying the coordinates. """ - return PyMenu(self.service, "/display/set/marker_size").execute(*args, **kwargs) - def marker_symbol(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/structural_point_surface").execute(*args, **kwargs) + def quadric_slice(self, *args, **kwargs): """ - Sets the type of markers used to represent points. + Extract a quadric slice. """ - return PyMenu(self.service, "/display/set/marker_symbol").execute(*args, **kwargs) - def mesh_display_configuration(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/quadric_slice").execute(*args, **kwargs) + def rake_surface(self, *args, **kwargs): """ - Changes the default mesh display. If set tomeshing, it draws the mesh on edges and faces of the outline surfaces, colored by their zone ID with lighting enabled. If set tosolution, it draws the mesh on edges and faces of the outline surfaces, colored by their zone type with lighting enabled. If set to post-processing, it draws the object outline with lighting disabled. If set toclassic, it draws the mesh on all edges of the outline surfaces. This only applies for 3D cases. + Define a "rake" surface by specifying the end points. """ - return PyMenu(self.service, "/display/set/mesh_display_configuration").execute(*args, **kwargs) - def mirror_zones(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/rake_surface").execute(*args, **kwargs) + def rename_surface(self, *args, **kwargs): """ - Sets the zones about which the domain is mirrored (symmetry planes). + Rename a defined data surface. """ - return PyMenu(self.service, "/display/set/mirror_zones").execute(*args, **kwargs) - def n_stream_func(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/rename_surface").execute(*args, **kwargs) + def sphere_slice(self, *args, **kwargs): """ - Sets number of iterations used in computing stream function. + Extract a spherical slice. """ - return PyMenu(self.service, "/display/set/n_stream_func").execute(*args, **kwargs) - def nodewt_based_interp(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/sphere_slice").execute(*args, **kwargs) + def ellipsoid_slice(self, *args, **kwargs): """ - Disables/enables the use of node weights for node-based gradients in postprocessing. + Extract a ellipsoid slice. """ - return PyMenu(self.service, "/display/set/nodewt_based_interp").execute(*args, **kwargs) - def overlays(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/ellipsoid_slice").execute(*args, **kwargs) + def cone_slice(self, *args, **kwargs): """ - Enable/disable overlays. + Extract a cone slice. """ - return PyMenu(self.service, "/display/set/overlays").execute(*args, **kwargs) - def periodic_instancing(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/cone_slice").execute(*args, **kwargs) + def surface_cells(self, *args, **kwargs): """ - Sets the number of periodic repetitions. + Extract all cells intersected by a data surface. """ - return PyMenu(self.service, "/display/set/periodic_instancing").execute(*args, **kwargs) - def proximity_zones(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/surface_cells").execute(*args, **kwargs) + def transform_surface(self, *args, **kwargs): """ - Sets zones to be used for boundary cell distance and boundary proximity. + Transform surface. """ - return PyMenu(self.service, "/display/set/proximity_zones").execute(*args, **kwargs) - def render_mesh(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/transform_surface").execute(*args, **kwargs) + def create_imprint_surface(self, *args, **kwargs): """ - Enables/disables rendering the mesh on top of contours, vectors, and so on. + Imprint surface. """ - return PyMenu(self.service, "/display/set/render_mesh").execute(*args, **kwargs) - def reset_graphics(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/create_imprint_surface").execute(*args, **kwargs) + def zone_surface(self, *args, **kwargs): """ - Reset the graphics system. + Define a data surface on a mesh zone. """ - return PyMenu(self.service, "/display/set/reset_graphics").execute(*args, **kwargs) - def zero_angle_dir(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/zone_surface").execute(*args, **kwargs) + def reset_zone_surfaces(self, *args, **kwargs): """ - Sets the vector having zero angular coordinates. + Reset case surface list. """ - return PyMenu(self.service, "/display/set/zero_angle_dir").execute(*args, **kwargs) - def duplicate_node_display(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/reset_zone_surfaces").execute(*args, **kwargs) + def multiple_zone_surfaces(self, *args, **kwargs): """ - Set flag to remove duplicate nodes in mesh display. + Create multiple data surfaces at a time. """ - return PyMenu(self.service, "/display/set/duplicate_node_display").execute(*args, **kwargs) + return PyMenu(self.service, "/display/surface/multiple_zone_surfaces").execute(*args, **kwargs) + def edit_surface(self, *args, **kwargs): + """ + Edit a defined data surface. + """ + return PyMenu(self.service, "/display/surface/edit_surface").execute(*args, **kwargs) - class colors(metaclass=PyMenuMeta): + class post_processing_volume(TUIMenu): """ - Enter the color options menu. + Enter post-processing volume menu. """ def __init__(self, path, service): self.path = path self.service = service - self.by_type = self.__class__.by_type(path + [("by_type", None)], service) - self.by_surface = self.__class__.by_surface(path + [("by_surface", None)], service) - def background(self, *args, **kwargs): - """ - Set the background (window) color. - """ - return PyMenu(self.service, "/display/set/colors/background").execute(*args, **kwargs) - def color_by_type(self, *args, **kwargs): - """ - Determine whether to color meshes by type or by surface (ID). - """ - return PyMenu(self.service, "/display/set/colors/color_by_type").execute(*args, **kwargs) - def foreground(self, *args, **kwargs): - """ - Set the foreground (text and window frame) color. - """ - return PyMenu(self.service, "/display/set/colors/foreground").execute(*args, **kwargs) - def far_field_faces(self, *args, **kwargs): + super().__init__(path, service) + def create_from_file(self, *args, **kwargs): """ - Set the color of far field faces. + Read post-processing mesh from file. """ - return PyMenu(self.service, "/display/set/colors/far_field_faces").execute(*args, **kwargs) - def inlet_faces(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/post_processing_volume/create_from_file").execute(*args, **kwargs) + def create_octree(self, *args, **kwargs): """ - Set the color of inlet faces. + Create post-processing octree mesh based on current case. """ - return PyMenu(self.service, "/display/set/colors/inlet_faces").execute(*args, **kwargs) - def interior_faces(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/post_processing_volume/create_octree").execute(*args, **kwargs) + + class query(TUIMenu): + """ + Enter surface query menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def delete_query(self, *args, **kwargs): """ - Set the color of interior faces. + Delete saved query. """ - return PyMenu(self.service, "/display/set/colors/interior_faces").execute(*args, **kwargs) - def internal_faces(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/query/delete_query").execute(*args, **kwargs) + def list_surfaces(self, *args, **kwargs): """ - Set the color of internal interface faces. + List surfaces. """ - return PyMenu(self.service, "/display/set/colors/internal_faces").execute(*args, **kwargs) - def outlet_faces(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/query/list_surfaces").execute(*args, **kwargs) + def named_surface_list(self, *args, **kwargs): """ - Set the color of outlet faces. + Create named list of surfaces. """ - return PyMenu(self.service, "/display/set/colors/outlet_faces").execute(*args, **kwargs) - def overset_faces(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/query/named_surface_list").execute(*args, **kwargs) + def list_named_selection(self, *args, **kwargs): """ - Set the color of overset faces. + List named selection of surface type. """ - return PyMenu(self.service, "/display/set/colors/overset_faces").execute(*args, **kwargs) - def periodic_faces(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/query/list_named_selection").execute(*args, **kwargs) + def list_queries(self, *args, **kwargs): """ - Set the color of periodic faces. + List all saved queries. """ - return PyMenu(self.service, "/display/set/colors/periodic_faces").execute(*args, **kwargs) - def rans_les_interface_faces(self, *args, **kwargs): + return PyMenu(self.service, "/display/surface/query/list_queries").execute(*args, **kwargs) + + class views(TUIMenu): + """ + Enter the view manipulation menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.camera = self.__class__.camera(path + [("camera", None)], service) + super().__init__(path, service) + def auto_scale(self, *args, **kwargs): + """ + Scale and center the current scene. + """ + return PyMenu(self.service, "/display/views/auto_scale").execute(*args, **kwargs) + def default_view(self, *args, **kwargs): + """ + Reset view to front and center. + """ + return PyMenu(self.service, "/display/views/default_view").execute(*args, **kwargs) + def delete_view(self, *args, **kwargs): + """ + Remove a view from the list. + """ + return PyMenu(self.service, "/display/views/delete_view").execute(*args, **kwargs) + def last_view(self, *args, **kwargs): + """ + Return to the camera position before the last manipulation. + """ + return PyMenu(self.service, "/display/views/last_view").execute(*args, **kwargs) + def next_view(self, *args, **kwargs): + """ + Return to the camera position after the current position in the stack. + """ + return PyMenu(self.service, "/display/views/next_view").execute(*args, **kwargs) + def list_views(self, *args, **kwargs): + """ + List predefined and saved views. + """ + return PyMenu(self.service, "/display/views/list_views").execute(*args, **kwargs) + def restore_view(self, *args, **kwargs): + """ + Use a saved view. + """ + return PyMenu(self.service, "/display/views/restore_view").execute(*args, **kwargs) + def read_views(self, *args, **kwargs): + """ + Read views from a view file. + """ + return PyMenu(self.service, "/display/views/read_views").execute(*args, **kwargs) + def save_view(self, *args, **kwargs): + """ + Save the current view to the view list. + """ + return PyMenu(self.service, "/display/views/save_view").execute(*args, **kwargs) + def write_views(self, *args, **kwargs): + """ + Write selected views to a view file. + """ + return PyMenu(self.service, "/display/views/write_views").execute(*args, **kwargs) + + class camera(TUIMenu): + """ + Enter the camera menu to modify the current viewing parameters. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def dolly_camera(self, *args, **kwargs): """ - Set the color of RANS/LES interface faces. + Adjust the camera position and target. """ - return PyMenu(self.service, "/display/set/colors/rans_les_interface_faces").execute(*args, **kwargs) - def reset_user_colors(self, *args, **kwargs): + return PyMenu(self.service, "/display/views/camera/dolly_camera").execute(*args, **kwargs) + def field(self, *args, **kwargs): """ - Reset all user colors. + Set the field of view (width and height). """ - return PyMenu(self.service, "/display/set/colors/reset_user_colors").execute(*args, **kwargs) - def show_user_colors(self, *args, **kwargs): + return PyMenu(self.service, "/display/views/camera/field").execute(*args, **kwargs) + def orbit_camera(self, *args, **kwargs): """ - List currently defined user colors. + Adjust the camera position without modifying the target. """ - return PyMenu(self.service, "/display/set/colors/show_user_colors").execute(*args, **kwargs) - def symmetry_faces(self, *args, **kwargs): + return PyMenu(self.service, "/display/views/camera/orbit_camera").execute(*args, **kwargs) + def pan_camera(self, *args, **kwargs): """ - Set the color of symmetric faces. + Adjust the camera target without modifying the position. """ - return PyMenu(self.service, "/display/set/colors/symmetry_faces").execute(*args, **kwargs) - def axis_faces(self, *args, **kwargs): + return PyMenu(self.service, "/display/views/camera/pan_camera").execute(*args, **kwargs) + def position(self, *args, **kwargs): """ - Set the color of axisymmetric faces. + Set the camera position. """ - return PyMenu(self.service, "/display/set/colors/axis_faces").execute(*args, **kwargs) - def free_surface_faces(self, *args, **kwargs): + return PyMenu(self.service, "/display/views/camera/position").execute(*args, **kwargs) + def projection(self, *args, **kwargs): """ - Set the color of free-surface faces. + Set the camera projection type. """ - return PyMenu(self.service, "/display/set/colors/free_surface_faces").execute(*args, **kwargs) - def traction_faces(self, *args, **kwargs): + return PyMenu(self.service, "/display/views/camera/projection").execute(*args, **kwargs) + def roll_camera(self, *args, **kwargs): """ - Set the color of traction faces. + Adjust the camera up-vector. """ - return PyMenu(self.service, "/display/set/colors/traction_faces").execute(*args, **kwargs) - def user_color(self, *args, **kwargs): + return PyMenu(self.service, "/display/views/camera/roll_camera").execute(*args, **kwargs) + def target(self, *args, **kwargs): """ - Explicitly set color of display zone. + Set the point to be the center of the camera view. """ - return PyMenu(self.service, "/display/set/colors/user_color").execute(*args, **kwargs) - def wall_faces(self, *args, **kwargs): + return PyMenu(self.service, "/display/views/camera/target").execute(*args, **kwargs) + def up_vector(self, *args, **kwargs): """ - Set the color of wall faces. + Set the camera up-vector. """ - return PyMenu(self.service, "/display/set/colors/wall_faces").execute(*args, **kwargs) - def interface_faces(self, *args, **kwargs): + return PyMenu(self.service, "/display/views/camera/up_vector").execute(*args, **kwargs) + def zoom_camera(self, *args, **kwargs): """ - Set the color of mesh Interfaces. + Adjust the camera field of view. """ - return PyMenu(self.service, "/display/set/colors/interface_faces").execute(*args, **kwargs) - def list(self, *args, **kwargs): + return PyMenu(self.service, "/display/views/camera/zoom_camera").execute(*args, **kwargs) + + class display_states(TUIMenu): + """ + Enter the display state manipulation menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def list(self, *args, **kwargs): + """ + Print the names of the available display states to the console. + """ + return PyMenu(self.service, "/display/display_states/list").execute(*args, **kwargs) + def apply(self, *args, **kwargs): + """ + Apply a display state to the active window. + """ + return PyMenu(self.service, "/display/display_states/apply").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Delete a display state. + """ + return PyMenu(self.service, "/display/display_states/delete").execute(*args, **kwargs) + def use_active(self, *args, **kwargs): + """ + Update an existing display state's settings to match those of the active graphics window. + """ + return PyMenu(self.service, "/display/display_states/use_active").execute(*args, **kwargs) + def copy(self, *args, **kwargs): + """ + Create a new display state with settings copied from an existing display state. + """ + return PyMenu(self.service, "/display/display_states/copy").execute(*args, **kwargs) + def read(self, *args, **kwargs): + """ + Read display states from a file. + """ + return PyMenu(self.service, "/display/display_states/read").execute(*args, **kwargs) + def write(self, *args, **kwargs): + """ + Write display states to a file. + """ + return PyMenu(self.service, "/display/display_states/write").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edit a particular display state setting. + """ + return PyMenu(self.service, "/display/display_states/edit").execute(*args, **kwargs) + def create(self, *args, **kwargs): + """ + Create a new display state. + """ + return PyMenu(self.service, "/display/display_states/create").execute(*args, **kwargs) + + class view_sync(TUIMenu): + """ + Synchronize window views. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def list(self, *args, **kwargs): + """ + Print window ids of open windows. + """ + return PyMenu(self.service, "/display/view_sync/list").execute(*args, **kwargs) + def start(self, *args, **kwargs): + """ + Start view synchronization. + """ + return PyMenu(self.service, "/display/view_sync/start").execute(*args, **kwargs) + def stop(self, *args, **kwargs): + """ + Stop view synchronization. + """ + return PyMenu(self.service, "/display/view_sync/stop").execute(*args, **kwargs) + def remove_all(self, *args, **kwargs): + """ + Unsynchronize all windows. + """ + return PyMenu(self.service, "/display/view_sync/remove_all").execute(*args, **kwargs) + def add_all(self, *args, **kwargs): + """ + Synchronize all windows. + """ + return PyMenu(self.service, "/display/view_sync/add_all").execute(*args, **kwargs) + def add(self, *args, **kwargs): + """ + Add list of window ids for synchronization. + """ + return PyMenu(self.service, "/display/view_sync/add").execute(*args, **kwargs) + def remove(self, *args, **kwargs): + """ + Remove list of window ids from synchronization. + """ + return PyMenu(self.service, "/display/view_sync/remove").execute(*args, **kwargs) + + class update_scene(TUIMenu): + """ + Enter the scene options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def select_geometry(self, *args, **kwargs): + """ + Select geometry to be updated. + """ + return PyMenu(self.service, "/display/update_scene/select_geometry").execute(*args, **kwargs) + def overlays(self, *args, **kwargs): + """ + Enable/disable the overlays option. + """ + return PyMenu(self.service, "/display/update_scene/overlays").execute(*args, **kwargs) + def draw_frame(self, *args, **kwargs): + """ + Enable/disable drawing of the bounding frame. + """ + return PyMenu(self.service, "/display/update_scene/draw_frame").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Delete selected geometries. + """ + return PyMenu(self.service, "/display/update_scene/delete").execute(*args, **kwargs) + def display(self, *args, **kwargs): + """ + Display selected geometries. + """ + return PyMenu(self.service, "/display/update_scene/display").execute(*args, **kwargs) + def transform(self, *args, **kwargs): + """ + Apply transformation matrix on selected geometries. + """ + return PyMenu(self.service, "/display/update_scene/transform").execute(*args, **kwargs) + def pathline(self, *args, **kwargs): + """ + Change pathline attributes. + """ + return PyMenu(self.service, "/display/update_scene/pathline").execute(*args, **kwargs) + def iso_sweep(self, *args, **kwargs): + """ + Change iso-sweep values. + """ + return PyMenu(self.service, "/display/update_scene/iso_sweep").execute(*args, **kwargs) + def time(self, *args, **kwargs): + """ + Change time-step value. + """ + return PyMenu(self.service, "/display/update_scene/time").execute(*args, **kwargs) + def set_frame(self, *args, **kwargs): + """ + Change frame options. + """ + return PyMenu(self.service, "/display/update_scene/set_frame").execute(*args, **kwargs) + + class inverse_dft(TUIMenu): + """ + Reconstruct DFT signal. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def set(self, *args, **kwargs): + """ + Set reconstruction parameters. + """ + return PyMenu(self.service, "/display/inverse_dft/set").execute(*args, **kwargs) + def reconstruct(self, *args, **kwargs): + """ + Make inverse DFT recontruction. + """ + return PyMenu(self.service, "/display/inverse_dft/reconstruct").execute(*args, **kwargs) + + class define(TUIMenu): + """ + Enter the define menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.boundary_conditions = self.__class__.boundary_conditions(path + [("boundary_conditions", None)], service) + self.spectral = self.__class__.spectral(path + [("spectral", None)], service) + self.custom_field_functions = self.__class__.custom_field_functions(path + [("custom_field_functions", None)], service) + self.dynamic_mesh = self.__class__.dynamic_mesh(path + [("dynamic_mesh", None)], service) + self.mesh_interfaces = self.__class__.mesh_interfaces(path + [("mesh_interfaces", None)], service) + self.gap_model = self.__class__.gap_model(path + [("gap_model", None)], service) + self.materials = self.__class__.materials(path + [("materials", None)], service) + self.mixing_planes = self.__class__.mixing_planes(path + [("mixing_planes", None)], service) + self.models = self.__class__.models(path + [("models", None)], service) + self.overset_interfaces = self.__class__.overset_interfaces(path + [("overset_interfaces", None)], service) + self.operating_conditions = self.__class__.operating_conditions(path + [("operating_conditions", None)], service) + self.parameters = self.__class__.parameters(path + [("parameters", None)], service) + self.periodic_conditions = self.__class__.periodic_conditions(path + [("periodic_conditions", None)], service) + self.turbo_model = self.__class__.turbo_model(path + [("turbo_model", None)], service) + self.phases = self.__class__.phases(path + [("phases", None)], service) + self.profiles = self.__class__.profiles(path + [("profiles", None)], service) + self.solution_strategy = self.__class__.solution_strategy(path + [("solution_strategy", None)], service) + self.reference_frames = self.__class__.reference_frames(path + [("reference_frames", None)], service) + self.user_defined = self.__class__.user_defined(path + [("user_defined", None)], service) + self.named_expressions = self.__class__.named_expressions(path + [("named_expressions", None)], service) + self.virtual_boundary = self.__class__.virtual_boundary(path + [("virtual_boundary", None)], service) + self.curvilinear_coordinate_system = self.__class__.curvilinear_coordinate_system(path + [("curvilinear_coordinate_system", None)], service) + super().__init__(path, service) + def beta_feature_access(self, *args, **kwargs): + """ + Enable access to beta features in the interface. + """ + return PyMenu(self.service, "/define/beta_feature_access").execute(*args, **kwargs) + def physics(self, *args, **kwargs): + """ + Manage Physics-regions. + """ + return PyMenu(self.service, "/define/physics").execute(*args, **kwargs) + def injections(self, *args, **kwargs): + """ + Enters the injections menu. For a description of the items in this menu, see define/models/dpm/injections. + """ + return PyMenu(self.service, "/define/injections").execute(*args, **kwargs) + def enable_mesh_morpher_optimizer(self, *args, **kwargs): + """ + Enables the mesh morpher/optimizer. When the mesh morpher/optimizer is enabled, the define/mesh-morpher-optimizer text command becomes available. + """ + return PyMenu(self.service, "/define/enable_mesh_morpher_optimizer").execute(*args, **kwargs) + def units(self, *args, **kwargs): + """ + Sets unit conversion factors. + """ + return PyMenu(self.service, "/define/units").execute(*args, **kwargs) + def set_unit_system(self, *args, **kwargs): + """ + Applies a standard set of units to all quantities. The options include default,si, british, andcgs. + """ + return PyMenu(self.service, "/define/set_unit_system").execute(*args, **kwargs) + + class boundary_conditions(TUIMenu): + """ + Enters the boundary conditions menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.modify_zones = self.__class__.modify_zones(path + [("modify_zones", None)], service) + self.non_reflecting_bc = self.__class__.non_reflecting_bc(path + [("non_reflecting_bc", None)], service) + self.rename_zone = self.__class__.rename_zone(path + [("rename_zone", None)], service) + self.bc_settings = self.__class__.bc_settings(path + [("bc_settings", None)], service) + self.perforated_walls = self.__class__.perforated_walls(path + [("perforated_walls", None)], service) + self.set = self.__class__.set(path + [("set", None)], service) + self.impedance_data_fitting = self.__class__.impedance_data_fitting(path + [("impedance_data_fitting", None)], service) + super().__init__(path, service) + def axis(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/axis").execute(*args, **kwargs) + def copy_bc(self, *args, **kwargs): + """ + Copies boundary conditions to other zones. + """ + return PyMenu(self.service, "/define/boundary_conditions/copy_bc").execute(*args, **kwargs) + def degassing(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/degassing").execute(*args, **kwargs) + def exhaust_fan(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/exhaust_fan").execute(*args, **kwargs) + def fan(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/fan").execute(*args, **kwargs) + def fluid(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/fluid").execute(*args, **kwargs) + def geometry(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/geometry").execute(*args, **kwargs) + def inlet_vent(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/inlet_vent").execute(*args, **kwargs) + def intake_fan(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/intake_fan").execute(*args, **kwargs) + def interface(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/interface").execute(*args, **kwargs) + def interior(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/interior").execute(*args, **kwargs) + def list_zones(self, *args, **kwargs): + """ + Prints out the types and IDs of all zones in the console window. You can use your mouse to check a zone ID, following the instructions listed under Zone in the + Boundary Conditions Task Page + section of the User’s Guide. + """ + return PyMenu(self.service, "/define/boundary_conditions/list_zones").execute(*args, **kwargs) + def mass_flow_inlet(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/mass_flow_inlet").execute(*args, **kwargs) + def mass_flow_outlet(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/mass_flow_outlet").execute(*args, **kwargs) + def network(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/network").execute(*args, **kwargs) + def network_end(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/network_end").execute(*args, **kwargs) + def openchannel_threads(self, *args, **kwargs): + """ + Lists open channel group IDs, names, types and variables. + """ + return PyMenu(self.service, "/define/boundary_conditions/openchannel_threads").execute(*args, **kwargs) + def open_channel_wave_settings(self, *args, **kwargs): + """ + Opens channel wave input analysis. + """ + return PyMenu(self.service, "/define/boundary_conditions/open_channel_wave_settings").execute(*args, **kwargs) + def outflow(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/outflow").execute(*args, **kwargs) + def outlet_vent(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/outlet_vent").execute(*args, **kwargs) + def overset(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/overset").execute(*args, **kwargs) + def periodic(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/periodic").execute(*args, **kwargs) + def porous_jump(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/porous_jump").execute(*args, **kwargs) + def pressure_far_field(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/pressure_far_field").execute(*args, **kwargs) + def pressure_inlet(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/pressure_inlet").execute(*args, **kwargs) + def pressure_outlet(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/pressure_outlet").execute(*args, **kwargs) + def radiator(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/radiator").execute(*args, **kwargs) + def rans_les_interface(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/rans_les_interface").execute(*args, **kwargs) + def recirculation_inlet(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/recirculation_inlet").execute(*args, **kwargs) + def recirculation_outlet(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/recirculation_outlet").execute(*args, **kwargs) + def shadow(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/shadow").execute(*args, **kwargs) + def solid(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/solid").execute(*args, **kwargs) + def symmetry(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/symmetry").execute(*args, **kwargs) + def velocity_inlet(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/velocity_inlet").execute(*args, **kwargs) + def wall(self, *args, **kwargs): + """ + Sets boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/define/boundary_conditions/wall").execute(*args, **kwargs) + def zone_name(self, *args, **kwargs): + """ + Gives a zone a new name. + """ + return PyMenu(self.service, "/define/boundary_conditions/zone_name").execute(*args, **kwargs) + def zone_type(self, *args, **kwargs): + """ + Sets the type for a zone or multiple zones of the same category. You will be prompted for the name / ID of the zone to be changed and the new type for that zone. To change multiple zones, you can enter a list (separated by spaces and contained within a pair of parentheses) or use asterisks (*) as wildcards. + """ + return PyMenu(self.service, "/define/boundary_conditions/zone_type").execute(*args, **kwargs) + def target_mass_flow_rate_settings(self, *args, **kwargs): + """ + Enters the targeted mass flow rate settings menu. + """ + return PyMenu(self.service, "/define/boundary_conditions/target_mass_flow_rate_settings").execute(*args, **kwargs) + def non_overlapping_zone_name(self, *args, **kwargs): + """ + Displays the name of the non-overlapping zone associated with a specified interface zone. This text command is only available after a mesh interface has been created. + """ + return PyMenu(self.service, "/define/boundary_conditions/non_overlapping_zone_name").execute(*args, **kwargs) + def knudsen_number_calculator(self, *args, **kwargs): + """ + Computes the Knudsen number based on a characteristic physical length and the area-averaged flow quantities along an incoming-flow boundary. You can use this information to determine flow regime for selecting the appropriate wall boundary treatment. For details, see . + """ + return PyMenu(self.service, "/define/boundary_conditions/knudsen_number_calculator").execute(*args, **kwargs) + + class modify_zones(TUIMenu): + """ + Enters the modify zones menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def activate_cell_zone(self, *args, **kwargs): """ - List available colors. + Activates cell thread. """ - return PyMenu(self.service, "/display/set/colors/list").execute(*args, **kwargs) - def reset_colors(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/activate_cell_zone").execute(*args, **kwargs) + def append_mesh(self, *args, **kwargs): """ - Reset individual mesh surface colors to the defaults. + Appends new mesh. """ - return PyMenu(self.service, "/display/set/colors/reset_colors").execute(*args, **kwargs) - def surface(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/append_mesh").execute(*args, **kwargs) + def append_mesh_data(self, *args, **kwargs): """ - Set the color of surfaces. + Appends new mesh with data. """ - return PyMenu(self.service, "/display/set/colors/surface").execute(*args, **kwargs) - def skip_label(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/append_mesh_data").execute(*args, **kwargs) + def copy_move_cell_zone(self, *args, **kwargs): """ - Set the number of labels to be skipped in the colopmap scale. + Creates a copy of a cell zone that is offset from the original either by a translational distance or a rotational angle. In the copied zone, the bounding face zones are all converted to walls, any existing cell data is initialized to a constant value, and non-conformal interfaces and dynamic zones are not copied; otherwise, the model settings are the same as in the original zone. Note that if you want the copied zone to be connected to existing zones, you must either fuse the boundaries (see ) or set up a non-conformal interface (see ). """ - return PyMenu(self.service, "/display/set/colors/skip_label").execute(*args, **kwargs) - def automatic_skip(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/copy_move_cell_zone").execute(*args, **kwargs) + def create_all_shell_threads(self, *args, **kwargs): """ - Determine whether to skip labels in the colopmap scale automatically. + Marks all finite thickness walls for shell creation. Shell zones will be created at the start of the iterations. """ - return PyMenu(self.service, "/display/set/colors/automatic_skip").execute(*args, **kwargs) - def graphics_color_theme(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/create_all_shell_threads").execute(*args, **kwargs) + def deactivate_cell_zone(self, *args, **kwargs): """ - Enter the graphics color theme menu. + Deactivates cell thread. """ - return PyMenu(self.service, "/display/set/colors/graphics_color_theme").execute(*args, **kwargs) - - class by_type(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/deactivate_cell_zone").execute(*args, **kwargs) + def recreate_all_shells(self, *args, **kwargs): """ - Enter the zone type color and material assignment menu. + Recreates shells on all the walls that were deleted using the command delete-all-shells. """ - def __init__(self, path, service): - self.path = path - self.service = service - self.type_name = self.__class__.type_name(path + [("type_name", None)], service) - def only_list_case_boundaries(self, *args, **kwargs): - """ - Only list the boundary types that are assigned in this case. - """ - return PyMenu(self.service, "/display/set/colors/by_type/only_list_case_boundaries").execute(*args, **kwargs) - def use_inherent_material_color(self, *args, **kwargs): - """ - Use inherent material color for boundary zones. - """ - return PyMenu(self.service, "/display/set/colors/by_type/use_inherent_material_color").execute(*args, **kwargs) - def reset(self, *args, **kwargs): - """ - To reset colors and/or materials to the defaults. - """ - return PyMenu(self.service, "/display/set/colors/by_type/reset").execute(*args, **kwargs) - - class type_name(metaclass=PyMenuMeta): - """ - Select the boundary type to specify colors and/or materials. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.axis = self.__class__.axis(path + [("axis", None)], service) - self.far_field = self.__class__.far_field(path + [("far_field", None)], service) - self.free_surface = self.__class__.free_surface(path + [("free_surface", None)], service) - self.inlet = self.__class__.inlet(path + [("inlet", None)], service) - self.interface = self.__class__.interface(path + [("interface", None)], service) - self.interior = self.__class__.interior(path + [("interior", None)], service) - self.internal = self.__class__.internal(path + [("internal", None)], service) - self.outlet = self.__class__.outlet(path + [("outlet", None)], service) - self.overset = self.__class__.overset(path + [("overset", None)], service) - self.periodic = self.__class__.periodic(path + [("periodic", None)], service) - self.rans_les_interface = self.__class__.rans_les_interface(path + [("rans_les_interface", None)], service) - self.surface = self.__class__.surface(path + [("surface", None)], service) - self.symmetry = self.__class__.symmetry(path + [("symmetry", None)], service) - self.traction = self.__class__.traction(path + [("traction", None)], service) - self.wall = self.__class__.wall(path + [("wall", None)], service) - - class axis(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/axis/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/axis/material").execute(*args, **kwargs) - - class far_field(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/far_field/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/far_field/material").execute(*args, **kwargs) - - class free_surface(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/free_surface/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/free_surface/material").execute(*args, **kwargs) - - class inlet(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/inlet/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/inlet/material").execute(*args, **kwargs) - - class interface(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/interface/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/interface/material").execute(*args, **kwargs) - - class interior(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/interior/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/interior/material").execute(*args, **kwargs) - - class internal(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/internal/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/internal/material").execute(*args, **kwargs) - - class outlet(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/outlet/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/outlet/material").execute(*args, **kwargs) - - class overset(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/overset/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/overset/material").execute(*args, **kwargs) - - class periodic(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/periodic/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/periodic/material").execute(*args, **kwargs) - - class rans_les_interface(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/rans_les_interface/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/rans_les_interface/material").execute(*args, **kwargs) - - class surface(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/surface/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/surface/material").execute(*args, **kwargs) - - class symmetry(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/symmetry/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/symmetry/material").execute(*args, **kwargs) - - class traction(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/traction/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/traction/material").execute(*args, **kwargs) - - class wall(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/wall/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/display/set/colors/by_type/type_name/wall/material").execute(*args, **kwargs) - - class by_surface(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/recreate_all_shells").execute(*args, **kwargs) + def delete_all_shells(self, *args, **kwargs): """ - Enter the surface(s) color and material assignment menu. + Deletes all shell zones and switches off shell conduction on all the walls. These zones can be recreated using the command recreate-all-shells. """ - def __init__(self, path, service): - self.path = path - self.service = service - def surfaces(self, *args, **kwargs): - """ - Select the surface(s) to specify colors and/or materials. - """ - return PyMenu(self.service, "/display/set/colors/by_surface/surfaces").execute(*args, **kwargs) - def use_inherent_material_color(self, *args, **kwargs): - """ - Use inherent material color for surfaces. - """ - return PyMenu(self.service, "/display/set/colors/by_surface/use_inherent_material_color").execute(*args, **kwargs) - def reset(self, *args, **kwargs): - """ - To reset colors and/or materials to the defaults. - """ - return PyMenu(self.service, "/display/set/colors/by_surface/reset").execute(*args, **kwargs) - def list_surfaces_by_color(self, *args, **kwargs): - """ - To list the surfaces by its color. - """ - return PyMenu(self.service, "/display/set/colors/by_surface/list_surfaces_by_color").execute(*args, **kwargs) - def list_surfaces_by_material(self, *args, **kwargs): - """ - To list the surfaces by its material. - """ - return PyMenu(self.service, "/display/set/colors/by_surface/list_surfaces_by_material").execute(*args, **kwargs) - - class contours(metaclass=PyMenuMeta): - """ - Enters the contour options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def auto_range(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/delete_all_shells").execute(*args, **kwargs) + def delete_cell_zone(self, *args, **kwargs): """ - Enables/disables auto-computation of the contour range. + Deletes a cell thread. """ - return PyMenu(self.service, "/display/set/contours/auto_range").execute(*args, **kwargs) - def clip_to_range(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/delete_cell_zone").execute(*args, **kwargs) + def extrude_face_zone_delta(self, *args, **kwargs): """ - Turns the clip to range option for filled contours on/off. + Extrudes a face thread a specified distance based on a list of deltas. """ - return PyMenu(self.service, "/display/set/contours/clip_to_range").execute(*args, **kwargs) - def surfaces(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/extrude_face_zone_delta").execute(*args, **kwargs) + def extrude_face_zone_para(self, *args, **kwargs): """ - Sets the surfaces on which contours are drawn. You can include a wildcard (*) within the surface names. + Extrudes a face thread a specified distance based on a distance and a list of parametric locations between 0 and 1, for example, 0 0.2 0.4 0.8 1.0. """ - return PyMenu(self.service, "/display/set/contours/surfaces").execute(*args, **kwargs) - def filled_contours(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/extrude_face_zone_para").execute(*args, **kwargs) + def fuse_face_zones(self, *args, **kwargs): """ - Turns the filled contours option on/off (deselects line-contours?). + Attempts to fuse zones by removing duplicate faces and nodes. """ - return PyMenu(self.service, "/display/set/contours/filled_contours").execute(*args, **kwargs) - def global_range(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/fuse_face_zones").execute(*args, **kwargs) + def list_zones(self, *args, **kwargs): """ - Turns the global range for contours on/off. + Lists zone IDs, types, kinds, and names. """ - return PyMenu(self.service, "/display/set/contours/global_range").execute(*args, **kwargs) - def line_contours(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/list_zones").execute(*args, **kwargs) + def make_periodic(self, *args, **kwargs): """ - Turns the line contours option on/off (deselects filled-contours?). + Attempts to establish periodic/shadow face zone connectivity. """ - return PyMenu(self.service, "/display/set/contours/line_contours").execute(*args, **kwargs) - def log_scale(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/make_periodic").execute(*args, **kwargs) + def create_periodic_interface(self, *args, **kwargs): """ - Specifies a decimal or logarithmic color scale for contours. + Creates a conformal or non-conformal periodic interface. """ - return PyMenu(self.service, "/display/set/contours/log_scale").execute(*args, **kwargs) - def n_contour(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/create_periodic_interface").execute(*args, **kwargs) + def scale_zone(self, *args, **kwargs): """ - Sets the number of contour levels. + Scales individual cell zones. """ - return PyMenu(self.service, "/display/set/contours/n_contour").execute(*args, **kwargs) - def node_values(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/scale_zone").execute(*args, **kwargs) + def rotate_zone(self, *args, **kwargs): """ - Sets the option to use scalar field at nodes when computing the contours. + Rotates individual cell zones. """ - return PyMenu(self.service, "/display/set/contours/node_values").execute(*args, **kwargs) - def render_mesh(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/rotate_zone").execute(*args, **kwargs) + def translate_zone(self, *args, **kwargs): """ - Determines whether or not to render the mesh on top of contours, vectors, and so on. + Translates individual cell zones. """ - return PyMenu(self.service, "/display/set/contours/render_mesh").execute(*args, **kwargs) - def coloring(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/translate_zone").execute(*args, **kwargs) + def matching_tolerance(self, *args, **kwargs): """ - Specifies whether contours are displayed in bands or with smooth transitions. Note that you can only display smooth contours if node-values are enabled. + Sets normalized tolerance used for finding coincident nodes. """ - return PyMenu(self.service, "/display/set/contours/coloring").execute(*args, **kwargs) - - class picture(metaclass=PyMenuMeta): - """ - Enter the hardcopy/save-picture options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.color_mode = self.__class__.color_mode(path + [("color_mode", None)], service) - self.driver = self.__class__.driver(path + [("driver", None)], service) - def invert_background(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/matching_tolerance").execute(*args, **kwargs) + def merge_zones(self, *args, **kwargs): """ - Use a white background when the picture is saved. + Merges zones of same type and condition into one. """ - return PyMenu(self.service, "/display/set/picture/invert_background").execute(*args, **kwargs) - def landscape(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/merge_zones").execute(*args, **kwargs) + def mrf_to_sliding_mesh(self, *args, **kwargs): """ - Plot hardcopies in landscape or portrait orientation. + Changes the motion specification from MRF to moving mesh. """ - return PyMenu(self.service, "/display/set/picture/landscape").execute(*args, **kwargs) - def preview(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/mrf_to_sliding_mesh").execute(*args, **kwargs) + def convert_all_solid_mrf_to_solid_motion(self, *args, **kwargs): """ - Display a preview image of a hardcopy. + Converts all solid zones using frame motion to instead use solid motion, copying the motion variable values for origin, axis, and velocities. """ - return PyMenu(self.service, "/display/set/picture/preview").execute(*args, **kwargs) - def x_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/convert_all_solid_mrf_to_solid_motion").execute(*args, **kwargs) + def orient_face_zone(self, *args, **kwargs): """ - Set the width of raster-formatted images in pixels (0 implies current window size). + Orients the face zone. """ - return PyMenu(self.service, "/display/set/picture/x_resolution").execute(*args, **kwargs) - def y_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/orient_face_zone").execute(*args, **kwargs) + def replace_zone(self, *args, **kwargs): """ - Set the height of raster-formatted images in pixels (0 implies current window size). + Replaces cell zone. """ - return PyMenu(self.service, "/display/set/picture/y_resolution").execute(*args, **kwargs) - def dpi(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/replace_zone").execute(*args, **kwargs) + def sep_cell_zone_mark(self, *args, **kwargs): """ - Set the DPI for EPS and Postscript files, specifies the resolution in dots per inch (DPI) instead of setting the width and height. + Separates cell zone based on cell marking. """ - return PyMenu(self.service, "/display/set/picture/dpi").execute(*args, **kwargs) - def use_window_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/sep_cell_zone_mark").execute(*args, **kwargs) + def sep_cell_zone_region(self, *args, **kwargs): """ - Use the currently active window's resolution for hardcopy (ignores the x-resolution and y-resolution in this case). + Separates cell zone based on contiguous regions. """ - return PyMenu(self.service, "/display/set/picture/use_window_resolution").execute(*args, **kwargs) - def set_standard_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/sep_cell_zone_region").execute(*args, **kwargs) + def sep_face_zone_angle(self, *args, **kwargs): """ - Select from pre-defined resolution list. + Separates face zone based on significant angle. """ - return PyMenu(self.service, "/display/set/picture/set_standard_resolution").execute(*args, **kwargs) - def jpeg_hardcopy_quality(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/sep_face_zone_angle").execute(*args, **kwargs) + def sep_face_zone_face(self, *args, **kwargs): """ - To set jpeg hardcopy quality. + Separates each face in zone into unique zone. """ - return PyMenu(self.service, "/display/set/picture/jpeg_hardcopy_quality").execute(*args, **kwargs) + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/sep_face_zone_face").execute(*args, **kwargs) + def sep_face_zone_mark(self, *args, **kwargs): + """ + Separates face zone based on cell marking. + """ + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/sep_face_zone_mark").execute(*args, **kwargs) + def sep_face_zone_region(self, *args, **kwargs): + """ + Separates face zone based on contiguous regions. + """ + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/sep_face_zone_region").execute(*args, **kwargs) + def slit_periodic(self, *args, **kwargs): + """ + Slits periodic zone into two symmetry zones. + """ + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/slit_periodic").execute(*args, **kwargs) + def slit_face_zone(self, *args, **kwargs): + """ + Slits two-sided wall into two connected wall zones. + """ + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/slit_face_zone").execute(*args, **kwargs) + def slit_interior_between_diff_solids(self, *args, **kwargs): + """ + Slits the interior zone between solid zones of differing materials to create a coupled wall. You will generally be prompted by Fluent if this is necessary. + """ + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/slit_interior_between_diff_solids").execute(*args, **kwargs) + def zone_name(self, *args, **kwargs): + """ + Gives a zone a new name. + """ + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/zone_name").execute(*args, **kwargs) + def zone_type(self, *args, **kwargs): + """ + Sets the type for a zone or multiple zones of the same category. You will be prompted for the name / ID of the zone to be changed and the new type for that zone. To change multiple zones, you can enter a list (separated by spaces and contained within a pair of parentheses) or use asterisks (*) as wildcards. + """ + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/zone_type").execute(*args, **kwargs) + def copy_mrf_to_mesh_motion(self, *args, **kwargs): + """ + Copies motion variable values for origin, axis, and velocities from Frame Motion to Mesh Motion. + """ + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/copy_mrf_to_mesh_motion").execute(*args, **kwargs) + def copy_mesh_to_mrf_motion(self, *args, **kwargs): + """ + Copies motion variable values for origin, axis, and velocities from Mesh Motion to Frame Motion. + """ + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/copy_mesh_to_mrf_motion").execute(*args, **kwargs) + def change_zone_state(self, *args, **kwargs): + """ + Sets the state (liquid or vapor) for a specific fluid zone. + """ + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/change_zone_state").execute(*args, **kwargs) + def change_zone_phase(self, *args, **kwargs): + """ + Change the realgas phase for a zone. + """ + return PyMenu(self.service, "/define/boundary_conditions/modify_zones/change_zone_phase").execute(*args, **kwargs) + + class non_reflecting_bc(TUIMenu): + """ + Enters the non-reflecting boundary condition menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.general_nrbc = self.__class__.general_nrbc(path + [("general_nrbc", None)], service) + self.turbo_specific_nrbc = self.__class__.turbo_specific_nrbc(path + [("turbo_specific_nrbc", None)], service) + super().__init__(path, service) - class color_mode(metaclass=PyMenuMeta): + class general_nrbc(TUIMenu): """ - Enter the hardcopy color mode menu. + Setting for general non-reflecting b.c. """ def __init__(self, path, service): self.path = path self.service = service - def color(self, *args, **kwargs): - """ - Plot hardcopies in color. - """ - return PyMenu(self.service, "/display/set/picture/color_mode/color").execute(*args, **kwargs) - def gray_scale(self, *args, **kwargs): - """ - Convert color to grayscale for hardcopy. - """ - return PyMenu(self.service, "/display/set/picture/color_mode/gray_scale").execute(*args, **kwargs) - def mono_chrome(self, *args, **kwargs): + self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) + + class set(TUIMenu): """ - Convert color to monochrome (black and white) for hardcopy. + Enters the setup menu for general non-reflecting b.c.’s. """ - return PyMenu(self.service, "/display/set/picture/color_mode/mono_chrome").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Display the current hardcopy color mode. - """ - return PyMenu(self.service, "/display/set/picture/color_mode/list").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def sigma(self, *args, **kwargs): + """ + Sets NRBC sigma factor (default value 0.15). + """ + return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/general_nrbc/set/sigma").execute(*args, **kwargs) + def sigma2(self, *args, **kwargs): + """ + Sets NRBC sigma2 factor (default value 5.0). + """ + return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/general_nrbc/set/sigma2").execute(*args, **kwargs) + def relax(self, *args, **kwargs): + """ + Set NRBC relaxation factor (default value 0.5). + """ + return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/general_nrbc/set/relax").execute(*args, **kwargs) + def tangential_source(self, *args, **kwargs): + """ + Include or not NRBC tangential source (default value #t). + """ + return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/general_nrbc/set/tangential_source").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Enables/disables nrbc verbosity scheme output. + """ + return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/general_nrbc/set/verbosity").execute(*args, **kwargs) - class driver(metaclass=PyMenuMeta): + class turbo_specific_nrbc(TUIMenu): """ - Enter the set hardcopy driver menu. + Enters the turbo specific nrbc menu. """ def __init__(self, path, service): self.path = path self.service = service - self.post_format = self.__class__.post_format(path + [("post_format", None)], service) - def dump_window(self, *args, **kwargs): - """ - Set the command used to dump the graphics window to a file. - """ - return PyMenu(self.service, "/display/set/picture/driver/dump_window").execute(*args, **kwargs) - def eps(self, *args, **kwargs): - """ - Produce encapsulated PostScript (EPS) output for hardcopies. - """ - return PyMenu(self.service, "/display/set/picture/driver/eps").execute(*args, **kwargs) - def jpeg(self, *args, **kwargs): - """ - Produce JPEG output for hardcopies. - """ - return PyMenu(self.service, "/display/set/picture/driver/jpeg").execute(*args, **kwargs) - def post_script(self, *args, **kwargs): - """ - Produce PostScript output for hardcopies. - """ - return PyMenu(self.service, "/display/set/picture/driver/post_script").execute(*args, **kwargs) - def ppm(self, *args, **kwargs): - """ - Produce PPM output for hardcopies. - """ - return PyMenu(self.service, "/display/set/picture/driver/ppm").execute(*args, **kwargs) - def tiff(self, *args, **kwargs): - """ - Use TIFF output for hardcopies. - """ - return PyMenu(self.service, "/display/set/picture/driver/tiff").execute(*args, **kwargs) - def png(self, *args, **kwargs): - """ - Use PNG output for hardcopies. - """ - return PyMenu(self.service, "/display/set/picture/driver/png").execute(*args, **kwargs) - def hsf(self, *args, **kwargs): - """ - Use HSF output for hardcopies. - """ - return PyMenu(self.service, "/display/set/picture/driver/hsf").execute(*args, **kwargs) - def avz(self, *args, **kwargs): - """ - Use AVZ output for hardcopies. - """ - return PyMenu(self.service, "/display/set/picture/driver/avz").execute(*args, **kwargs) - def glb(self, *args, **kwargs): - """ - Use GLB output for hardcopies. - """ - return PyMenu(self.service, "/display/set/picture/driver/glb").execute(*args, **kwargs) - def vrml(self, *args, **kwargs): + self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) + def enable(self, *args, **kwargs): """ - Use VRML output for hardcopies. + Enables/disables non-reflecting b.c.’s. """ - return PyMenu(self.service, "/display/set/picture/driver/vrml").execute(*args, **kwargs) - def list(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/turbo_specific_nrbc/enable").execute(*args, **kwargs) + def initialize(self, *args, **kwargs): """ - List the current hardcopy driver. + Initializes non-reflecting b.c.’s. """ - return PyMenu(self.service, "/display/set/picture/driver/list").execute(*args, **kwargs) - def options(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/turbo_specific_nrbc/initialize").execute(*args, **kwargs) + def show_status(self, *args, **kwargs): """ - Set the hardcopy options. Available options are: - \\n "no gamma correction", disables gamma correction of colors, - \\n "physical size = (width,height)", where width and height - are the actual measurements of the printable area of the page - in centimeters. - \\n "subscreen = (left,right,bottom,top)", where left,right, - bottom, and top are numbers in [-1,1] describing a subwindow on - the page in which to place the hardcopy. - - \\n The options may be combined by separating them with commas. + Shows current status of non-reflecting b.c.’s. """ - return PyMenu(self.service, "/display/set/picture/driver/options").execute(*args, **kwargs) + return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/turbo_specific_nrbc/show_status").execute(*args, **kwargs) - class post_format(metaclass=PyMenuMeta): + class set(TUIMenu): """ - Enter the PostScript driver format menu. + Enters the set menu for non-reflecting b.c. parameters. """ def __init__(self, path, service): self.path = path self.service = service - def fast_raster(self, *args, **kwargs): - """ - Use the new raster format. - """ - return PyMenu(self.service, "/display/set/picture/driver/post_format/fast_raster").execute(*args, **kwargs) - def raster(self, *args, **kwargs): + super().__init__(path, service) + def discretization(self, *args, **kwargs): """ - Use the original raster format. + Enables use of higher-order reconstruction at boundaries if available. """ - return PyMenu(self.service, "/display/set/picture/driver/post_format/raster").execute(*args, **kwargs) - def rle_raster(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/turbo_specific_nrbc/set/discretization").execute(*args, **kwargs) + def under_relaxation(self, *args, **kwargs): """ - Use the run-length encoded raster format. + Sets non-reflecting b.c. under-relaxation factor. """ - return PyMenu(self.service, "/display/set/picture/driver/post_format/rle_raster").execute(*args, **kwargs) - def vector(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/turbo_specific_nrbc/set/under_relaxation").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): """ - Use vector format. + Sets non-reflecting b.c. verbosity level. 0 : silent, 1 : basic information (default), 2 : detailed information for debugging. """ - return PyMenu(self.service, "/display/set/picture/driver/post_format/vector").execute(*args, **kwargs) + return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/turbo_specific_nrbc/set/verbosity").execute(*args, **kwargs) - class lights(metaclass=PyMenuMeta): + class rename_zone(TUIMenu): """ - Enter the lights menu. + Enter the menu for renaming cell and face zones based on adjacency, adding suffixes or prefixes to names, and renaming zones based on the Fluent naming conventions. """ def __init__(self, path, service): self.path = path self.service = service - self.lighting_interpolation = self.__class__.lighting_interpolation(path + [("lighting_interpolation", None)], service) - def lights_on(self, *args, **kwargs): + super().__init__(path, service) + def rename_by_adjacency(self, *args, **kwargs): """ - Turn all active lighting on/off. + Append the name of the adjacent cell zone to the specified face zone. For example, if fluid is the adjacent cell zone, and you select a face zone named interior, the resulting name of the face zone would be interior-fluid. """ - return PyMenu(self.service, "/display/set/lights/lights_on").execute(*args, **kwargs) - def set_ambient_color(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/rename_zone/rename_by_adjacency").execute(*args, **kwargs) + def rename_to_default(self, *args, **kwargs): """ - Set the ambient light color for the scene. + Rename a zone to use the Fluent naming convention. """ - return PyMenu(self.service, "/display/set/lights/set_ambient_color").execute(*args, **kwargs) - def set_light(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/rename_zone/rename_to_default").execute(*args, **kwargs) + def add_suffix_or_prefix(self, *args, **kwargs): """ - Add or modify a directional, colored light. + Add a suffix or prefix to one or more zones. """ - return PyMenu(self.service, "/display/set/lights/set_light").execute(*args, **kwargs) - def headlight_on(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/rename_zone/add_suffix_or_prefix").execute(*args, **kwargs) + + class bc_settings(TUIMenu): + """ + Enters the boundary conditions settings menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.pressure_far_field = self.__class__.pressure_far_field(path + [("pressure_far_field", None)], service) + super().__init__(path, service) + def mass_flow(self, *args, **kwargs): """ - Turn the light that moves with the camera on or off. + Selects method for setting the mass flow rate. """ - return PyMenu(self.service, "/display/set/lights/headlight_on").execute(*args, **kwargs) + return PyMenu(self.service, "/define/boundary_conditions/bc_settings/mass_flow").execute(*args, **kwargs) + def pressure_outlet(self, *args, **kwargs): + """ + Sets advanced options for pressure outlet boundaries. + """ + return PyMenu(self.service, "/define/boundary_conditions/bc_settings/pressure_outlet").execute(*args, **kwargs) - class lighting_interpolation(metaclass=PyMenuMeta): + class pressure_far_field(TUIMenu): """ - Set lighting interpolation method. + Sets advanced options for pressure far field boundaries. """ def __init__(self, path, service): self.path = path self.service = service - def automatic(self, *args, **kwargs): - """ - Choose Automatic to automatically select the best lighting method for a given graphics object. - """ - return PyMenu(self.service, "/display/set/lights/lighting_interpolation/automatic").execute(*args, **kwargs) - def flat(self, *args, **kwargs): - """ - Use flat shading for meshes and polygons. - """ - return PyMenu(self.service, "/display/set/lights/lighting_interpolation/flat").execute(*args, **kwargs) - def gouraud(self, *args, **kwargs): + super().__init__(path, service) + def riemann_invariants_tangency_correction(self, *args, **kwargs): """ - Use Gouraud shading to calculate the color at each vertex of a polygon and interpolate it in the interior. + Enables/disables the Riemann-invariant tangency correction as described in . """ - return PyMenu(self.service, "/display/set/lights/lighting_interpolation/gouraud").execute(*args, **kwargs) - def phong(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/bc_settings/pressure_far_field/riemann_invariants_tangency_correction").execute(*args, **kwargs) + def type(self, *args, **kwargs): """ - Use Phong shading to interpolate the normals for each pixel of a polygon and compute a color at every pixel. + Choose pressure-far-field boundary-condition type. """ - return PyMenu(self.service, "/display/set/lights/lighting_interpolation/phong").execute(*args, **kwargs) + return PyMenu(self.service, "/define/boundary_conditions/bc_settings/pressure_far_field/type").execute(*args, **kwargs) - class particle_tracks(metaclass=PyMenuMeta): + class perforated_walls(TUIMenu): """ - Enters the particle-tracks menu to set parameters for display of particle tracks. + Enters the perforated walls menu. """ def __init__(self, path, service): self.path = path self.service = service - self.sphere_settings = self.__class__.sphere_settings(path + [("sphere_settings", None)], service) - self.vector_settings = self.__class__.vector_settings(path + [("vector_settings", None)], service) - self.filter_settings = self.__class__.filter_settings(path + [("filter_settings", None)], service) - def display(self, *args, **kwargs): + super().__init__(path, service) + def read_input_file(self, *args, **kwargs): """ - Determines whether particle tracks shall be displayed or only tracked. + Reads an input file for perforated walls. """ - return PyMenu(self.service, "/display/set/particle_tracks/display").execute(*args, **kwargs) - def history_filename(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/perforated_walls/read_input_file").execute(*args, **kwargs) + def model_setup(self, *args, **kwargs): """ - Specifies the name of the particle history file. + Sets up the perforated wall model for each effusion surface. """ - return PyMenu(self.service, "/display/set/particle_tracks/history_filename").execute(*args, **kwargs) - def report_to(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/perforated_walls/model_setup").execute(*args, **kwargs) + + class set(TUIMenu): + """ + Allows you to define one or more settings at single or multiple boundaries/cell zones of a given type at once. Enter q to exit the define/boundary-conditions/set/ command. For a description of the items in this menu, see corresponding define/boundary-conditions/. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def axis(self, *args, **kwargs): """ - Specifies the destination for the report (console, file, none). + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/particle_tracks/report_to").execute(*args, **kwargs) - def report_type(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/axis").execute(*args, **kwargs) + def degassing(self, *args, **kwargs): """ - Sets the report type for particle tracks. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/particle_tracks/report_type").execute(*args, **kwargs) - def report_variables(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/degassing").execute(*args, **kwargs) + def exhaust_fan(self, *args, **kwargs): """ - Sets the report variables. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/particle_tracks/report_variables").execute(*args, **kwargs) - def report_default_variables(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/exhaust_fan").execute(*args, **kwargs) + def fan(self, *args, **kwargs): """ - Sets the report variables to default. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/particle_tracks/report_default_variables").execute(*args, **kwargs) - def track_single_particle_stream(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/fan").execute(*args, **kwargs) + def fluid(self, *args, **kwargs): """ - Specifies the stream ID to be tracked. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/particle_tracks/track_single_particle_stream").execute(*args, **kwargs) - def arrow_scale(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/fluid").execute(*args, **kwargs) + def geometry(self, *args, **kwargs): """ - Sets the scale factor for arrows drawn on particle tracks. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/particle_tracks/arrow_scale").execute(*args, **kwargs) - def arrow_space(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/geometry").execute(*args, **kwargs) + def inlet_vent(self, *args, **kwargs): """ - Sets the spacing factor for arrows drawn on particle tracks. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/particle_tracks/arrow_space").execute(*args, **kwargs) - def coarsen_factor(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/inlet_vent").execute(*args, **kwargs) + def intake_fan(self, *args, **kwargs): """ - Sets the coarsening factor for particle tracks. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/particle_tracks/coarsen_factor").execute(*args, **kwargs) - def line_width(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/intake_fan").execute(*args, **kwargs) + def interface(self, *args, **kwargs): """ - Sets the width for particle track. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/particle_tracks/line_width").execute(*args, **kwargs) - def marker_size(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/interface").execute(*args, **kwargs) + def interior(self, *args, **kwargs): """ - Sets the size of markers used to represent particle tracks. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/particle_tracks/marker_size").execute(*args, **kwargs) - def radius(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/interior").execute(*args, **kwargs) + def mass_flow_inlet(self, *args, **kwargs): """ - Sets the radius for particle track (ribbon/cylinder only) cross-section. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/particle_tracks/radius").execute(*args, **kwargs) - def style(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/mass_flow_inlet").execute(*args, **kwargs) + def mass_flow_outlet(self, *args, **kwargs): """ - Sets the display style for particle track (line/ribbon/cylinder/sphere). + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/particle_tracks/style").execute(*args, **kwargs) - def twist_factor(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/mass_flow_outlet").execute(*args, **kwargs) + def network(self, *args, **kwargs): """ - Sets the scale factor for twisting (ribbons only). + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/particle_tracks/twist_factor").execute(*args, **kwargs) - def sphere_attrib(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/network").execute(*args, **kwargs) + def network_end(self, *args, **kwargs): """ - Specifies the size and number of slices to be used in drawing spheres. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/particle_tracks/sphere_attrib").execute(*args, **kwargs) - def particle_skip(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/network_end").execute(*args, **kwargs) + def outflow(self, *args, **kwargs): """ - Specifies how many particle tracks should be displayed. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/particle_tracks/particle_skip").execute(*args, **kwargs) - - class sphere_settings(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/boundary_conditions/set/outflow").execute(*args, **kwargs) + def outlet_vent(self, *args, **kwargs): """ - Provide sphere specific input. + Set boundary conditions for a zone or multiple zones of this type. """ - def __init__(self, path, service): - self.path = path - self.service = service - def vary_diameter(self, *args, **kwargs): - """ - Specifies whether the spheres can vary with another variable. - """ - return PyMenu(self.service, "/display/set/particle_tracks/sphere_settings/vary_diameter").execute(*args, **kwargs) - def diameter(self, *args, **kwargs): - """ - Diameter of the spheres whenvary-diameter is disabled. - """ - return PyMenu(self.service, "/display/set/particle_tracks/sphere_settings/diameter").execute(*args, **kwargs) - def auto_range(self, *args, **kwargs): - """ - Specifies whether displayed spheres should include auto range of variable to size spheres. - """ - return PyMenu(self.service, "/display/set/particle_tracks/sphere_settings/auto_range").execute(*args, **kwargs) - def minimum(self, *args, **kwargs): - """ - Sets the minimum value of the sphere to be displayed. - """ - return PyMenu(self.service, "/display/set/particle_tracks/sphere_settings/minimum").execute(*args, **kwargs) - def maximum(self, *args, **kwargs): - """ - Sets the maximum value of the sphere to be displayed. - """ - return PyMenu(self.service, "/display/set/particle_tracks/sphere_settings/maximum").execute(*args, **kwargs) - def smooth_parameter(self, *args, **kwargs): - """ - Specifies number of slices to be used in drawing spheres. - """ - return PyMenu(self.service, "/display/set/particle_tracks/sphere_settings/smooth_parameter").execute(*args, **kwargs) - def scale_factor(self, *args, **kwargs): - """ - Specifies a scale factor to enlarge/reduce the size of spheres. - """ - return PyMenu(self.service, "/display/set/particle_tracks/sphere_settings/scale_factor").execute(*args, **kwargs) - def size_variable(self, *args, **kwargs): - """ - Selects a particle variable to size the spheres. - """ - return PyMenu(self.service, "/display/set/particle_tracks/sphere_settings/size_variable").execute(*args, **kwargs) - - class vector_settings(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/boundary_conditions/set/outlet_vent").execute(*args, **kwargs) + def overset(self, *args, **kwargs): """ - Set vector specific input. + Set boundary conditions for a zone or multiple zones of this type. """ - def __init__(self, path, service): - self.path = path - self.service = service - def style(self, *args, **kwargs): - """ - Enables and sets the display style for particle vectors (none/vector/centered-vector/centered-cylinder). - """ - return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/style").execute(*args, **kwargs) - def vector_length(self, *args, **kwargs): - """ - Specifies the length of constant vectors. - """ - return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/vector_length").execute(*args, **kwargs) - def vector_length_variable(self, *args, **kwargs): - """ - Selects a particle variable to specify the length of vectors. - """ - return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/vector_length_variable").execute(*args, **kwargs) - def scale_factor(self, *args, **kwargs): - """ - Specifies a scale factor to enlarge/reduce the length of vectors. - """ - return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/scale_factor").execute(*args, **kwargs) - def length_variable(self, *args, **kwargs): - """ - Specifies whether the displayed vectors have length varying with another variable. - """ - return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/length_variable").execute(*args, **kwargs) - def length_to_head_ratio(self, *args, **kwargs): - """ - Specifies ratio of length to head for vectors and length to diameter for cylinders. - """ - return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/length_to_head_ratio").execute(*args, **kwargs) - def constant_color(self, *args, **kwargs): - """ - Specifies a constant color for the vectors. - """ - return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/constant_color").execute(*args, **kwargs) - def color_variable(self, *args, **kwargs): - """ - Specifies whether the vectors should be colored by variable specified in /display/particle-track/particle-track (if false use a constant color). - """ - return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/color_variable").execute(*args, **kwargs) - def vector_variable(self, *args, **kwargs): - """ - Selects a particle vector function to specify vector direction. - """ - return PyMenu(self.service, "/display/set/particle_tracks/vector_settings/vector_variable").execute(*args, **kwargs) - - class filter_settings(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/boundary_conditions/set/overset").execute(*args, **kwargs) + def periodic(self, *args, **kwargs): """ - Set filter for particle display. + Set boundary conditions for a zone or multiple zones of this type. """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable_filtering(self, *args, **kwargs): - """ - Specifies whether particle display is filtered. - """ - return PyMenu(self.service, "/display/set/particle_tracks/filter_settings/enable_filtering").execute(*args, **kwargs) - def inside(self, *args, **kwargs): - """ - Specifies whether filter variable must be inside min/max to be displayed (else outside min/max). - """ - return PyMenu(self.service, "/display/set/particle_tracks/filter_settings/inside").execute(*args, **kwargs) - def filter_variable(self, *args, **kwargs): - """ - Selects a variable used for filtering of particles. - """ - return PyMenu(self.service, "/display/set/particle_tracks/filter_settings/filter_variable").execute(*args, **kwargs) - def minimum(self, *args, **kwargs): - """ - Specifies the lower bound for the filter variable. - """ - return PyMenu(self.service, "/display/set/particle_tracks/filter_settings/minimum").execute(*args, **kwargs) - def maximum(self, *args, **kwargs): - """ - Specifies the upper bound for the filter variable. - """ - return PyMenu(self.service, "/display/set/particle_tracks/filter_settings/maximum").execute(*args, **kwargs) - - class path_lines(metaclass=PyMenuMeta): - """ - Sets parameters for display of pathlines. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def arrow_scale(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/periodic").execute(*args, **kwargs) + def porous_jump(self, *args, **kwargs): """ - Sets the scale factor for arrows drawn on pathlines. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/path_lines/arrow_scale").execute(*args, **kwargs) - def arrow_space(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/porous_jump").execute(*args, **kwargs) + def pressure_far_field(self, *args, **kwargs): """ - Sets the spacing factor for arrows drawn on pathlines. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/path_lines/arrow_space").execute(*args, **kwargs) - def display_steps(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/pressure_far_field").execute(*args, **kwargs) + def pressure_inlet(self, *args, **kwargs): """ - Sets the display stepping for pathlines. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/path_lines/display_steps").execute(*args, **kwargs) - def error_control(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/pressure_inlet").execute(*args, **kwargs) + def pressure_outlet(self, *args, **kwargs): """ - Sets error control during pathline computation. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/path_lines/error_control").execute(*args, **kwargs) - def line_width(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/pressure_outlet").execute(*args, **kwargs) + def radiator(self, *args, **kwargs): """ - Sets the width for pathlines. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/path_lines/line_width").execute(*args, **kwargs) - def marker_size(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/radiator").execute(*args, **kwargs) + def rans_les_interface(self, *args, **kwargs): """ - Sets the marker size for particle drawing. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/path_lines/marker_size").execute(*args, **kwargs) - def maximum_steps(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/rans_les_interface").execute(*args, **kwargs) + def recirculation_inlet(self, *args, **kwargs): """ - Sets the maximum number of steps to take for pathlines. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/path_lines/maximum_steps").execute(*args, **kwargs) - def maximum_error(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/recirculation_inlet").execute(*args, **kwargs) + def recirculation_outlet(self, *args, **kwargs): """ - Sets the maximum error allowed while computing the pathlines. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/path_lines/maximum_error").execute(*args, **kwargs) - def radius(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/recirculation_outlet").execute(*args, **kwargs) + def shadow(self, *args, **kwargs): """ - Sets the radius for pathline (ribbons/cylinder only) cross-section. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/path_lines/radius").execute(*args, **kwargs) - def relative_pathlines(self, *args, **kwargs): - """ - Enables/disables the tracking of pathlines in a relative coordinate system. - """ - return PyMenu(self.service, "/display/set/path_lines/relative_pathlines").execute(*args, **kwargs) - def style(self, *args, **kwargs): - """ - Selects the pathline style (line, point, ribbon, triangle, cylinder). - """ - return PyMenu(self.service, "/display/set/path_lines/style").execute(*args, **kwargs) - def twist_factor(self, *args, **kwargs): - """ - Sets the scale factor for twisting (ribbons only). - """ - return PyMenu(self.service, "/display/set/path_lines/twist_factor").execute(*args, **kwargs) - def step_size(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/shadow").execute(*args, **kwargs) + def solid(self, *args, **kwargs): """ - Sets the step length between particle positions for pathlines. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/path_lines/step_size").execute(*args, **kwargs) - def reverse(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/solid").execute(*args, **kwargs) + def symmetry(self, *args, **kwargs): """ - Sets direction of path tracking. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/path_lines/reverse").execute(*args, **kwargs) - def sphere_attrib(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/symmetry").execute(*args, **kwargs) + def velocity_inlet(self, *args, **kwargs): """ - Specifies the size and number of slices to be used in drawing spheres. + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/path_lines/sphere_attrib").execute(*args, **kwargs) - def track_in_phase(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/set/velocity_inlet").execute(*args, **kwargs) + def wall(self, *args, **kwargs): """ - Selects the phase in which particle pathlines will be computed (Multiphase Eulerian Model only). + Set boundary conditions for a zone or multiple zones of this type. """ - return PyMenu(self.service, "/display/set/path_lines/track_in_phase").execute(*args, **kwargs) + return PyMenu(self.service, "/define/boundary_conditions/set/wall").execute(*args, **kwargs) - class rendering_options(metaclass=PyMenuMeta): + class impedance_data_fitting(TUIMenu): """ - Enter the rendering options menu. + Enters the impedance data fitting menu, which provides text commands that can be helpful when you are using the impedance boundary condition (IBC). """ def __init__(self, path, service): self.path = path self.service = service - def auto_spin(self, *args, **kwargs): - """ - Enable/disable mouse view rotations to continue to spin the display after the button is released. - """ - return PyMenu(self.service, "/display/set/rendering_options/auto_spin").execute(*args, **kwargs) - def device_info(self, *args, **kwargs): - """ - List information for the graphics device. - """ - return PyMenu(self.service, "/display/set/rendering_options/device_info").execute(*args, **kwargs) - def double_buffering(self, *args, **kwargs): - """ - Enable/disable double-buffering. - """ - return PyMenu(self.service, "/display/set/rendering_options/double_buffering").execute(*args, **kwargs) - def driver(self, *args, **kwargs): - """ - Change the current graphics driver. - """ - return PyMenu(self.service, "/display/set/rendering_options/driver").execute(*args, **kwargs) - def hidden_surfaces(self, *args, **kwargs): - """ - Enable/disable hidden surface removal. - """ - return PyMenu(self.service, "/display/set/rendering_options/hidden_surfaces").execute(*args, **kwargs) - def hidden_surface_method(self, *args, **kwargs): - """ - Specify the method to perform hidden line and hidden surface rendering. - """ - return PyMenu(self.service, "/display/set/rendering_options/hidden_surface_method").execute(*args, **kwargs) - def outer_face_cull(self, *args, **kwargs): + super().__init__(path, service) + def impedance_data(self, *args, **kwargs): """ - Enable/disable discarding outer faces during display. + Reads an input file with experimental specific impedance data in the frequency domain and then computes the terms needed for an approximation of the reflection coefficient as a series of poles / residues in the time domain. The resulting terms are printed in the console, and can be written to a pole / residue file (which can be imported and the impedance parameters applied to a boundary condition using the define/boundary-conditions/impedance-data-fitting/import-parameters text command). You can also write a file with fitted frequency / impedance data, which can be compared to the input data to evaluate how well it fits. """ - return PyMenu(self.service, "/display/set/rendering_options/outer_face_cull").execute(*args, **kwargs) - def surface_edge_visibility(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/impedance_data_fitting/impedance_data").execute(*args, **kwargs) + def reflection_data(self, *args, **kwargs): """ - Set edge visibility flags for surfaces. + Reads an input file with experimental reflection coefficient data in the frequency domain and then computes the terms needed for an approximation of the reflection coefficient as a series of poles / residues in the time domain. The resulting terms are printed in the console, and can be written to a pole / residue file (which can be imported and the impedance parameters applied to a boundary condition using the define/boundary-conditions/impedance-data-fitting/import-parameters text command). You can also write a file with fitted frequency / impedance data, which can be compared to the input data to evaluate how well it fits. """ - return PyMenu(self.service, "/display/set/rendering_options/surface_edge_visibility").execute(*args, **kwargs) - def animation_option(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/impedance_data_fitting/reflection_data").execute(*args, **kwargs) + def absorption_data(self, *args, **kwargs): """ - Using Wireframe / All option during animation. + Reads an input file with experimental absorption coefficient data in the frequency domain and then computes the terms needed for an approximation of the reflection coefficient as a series of poles / residues in the time domain. The resulting terms are printed in the console, and can be written to a pole / residue file (which can be imported and the impedance parameters applied to a boundary condition using the define/boundary-conditions/impedance-data-fitting/import-parameters text command). You can also write a file with fitted frequency / impedance data, which can be compared to the input data to evaluate how well it fits. """ - return PyMenu(self.service, "/display/set/rendering_options/animation_option").execute(*args, **kwargs) - def color_map_alignment(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/impedance_data_fitting/absorption_data").execute(*args, **kwargs) + def iterations(self, *args, **kwargs): """ - Set the color bar alignment. + Sets the number of internal iterations used for the calculations performed from the define/boundary-conditions/impedance-data-fitting/ text command menu. By default, the number of iterations is set to 20. """ - return PyMenu(self.service, "/display/set/rendering_options/color_map_alignment").execute(*args, **kwargs) - def help_text_color(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/impedance_data_fitting/iterations").execute(*args, **kwargs) + def convergence_tolerance(self, *args, **kwargs): """ - Set the color of screen help text. + Sets the convergence tolerance, which is an accuracy that is used for completing the iterative fitting procedure in the calculations performed from the define/boundary-conditions/impedance-data-fitting/ text command menu. By default, the tolerance is set to 1e-6. """ - return PyMenu(self.service, "/display/set/rendering_options/help_text_color").execute(*args, **kwargs) - def face_displacement(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/impedance_data_fitting/convergence_tolerance").execute(*args, **kwargs) + def residue_tolerance(self, *args, **kwargs): """ - Set face displacement value in Z-buffer units along the Camera Z-axis. + Sets the residue tolerance, which is the minimum value of residues that are kept in the fitting performed from the define/boundary-conditions/impedance-data-fitting/ text command menu. This residue check helps to eliminate parasitic poles. By default, the tolerance is set to 1e-6. """ - return PyMenu(self.service, "/display/set/rendering_options/face_displacement").execute(*args, **kwargs) - def set_rendering_options(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/impedance_data_fitting/residue_tolerance").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): """ - Set the rendering options. + Sets the verbosity of the progress messages during the fitting performed from the define/boundary-conditions/impedance-data-fitting/ text command menu. Setting this to 1 results in messages being printed in the console as the fitting calculation progresses. The default value of 0 suppresses this output. """ - return PyMenu(self.service, "/display/set/rendering_options/set_rendering_options").execute(*args, **kwargs) - def show_colormap(self, *args, **kwargs): + return PyMenu(self.service, "/define/boundary_conditions/impedance_data_fitting/verbosity").execute(*args, **kwargs) + def import_parameters(self, *args, **kwargs): """ - Enable/Disable colormap. + Reads a pole / residue file with impedance parameters in the time domain and applies them to a specified boundary condition. """ - return PyMenu(self.service, "/display/set/rendering_options/show_colormap").execute(*args, **kwargs) + return PyMenu(self.service, "/define/boundary_conditions/impedance_data_fitting/import_parameters").execute(*args, **kwargs) - class titles(metaclass=PyMenuMeta): + class spectral(TUIMenu): + """ + Enter the Spectral menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def calculate_fourier_coefficients(self, *args, **kwargs): """ - Set problem title. + Calculates Fourier coefficient data. """ - def __init__(self, path, service): - self.path = path - self.service = service - def left_top(self, *args, **kwargs): - """ - Set the title text for left top in title segment. - """ - return PyMenu(self.service, "/display/set/titles/left_top").execute(*args, **kwargs) - def left_bottom(self, *args, **kwargs): - """ - Set the title text for left bottom in title segment. - """ - return PyMenu(self.service, "/display/set/titles/left_bottom").execute(*args, **kwargs) - def right_top(self, *args, **kwargs): - """ - Set the title text for right top in title segment. - """ - return PyMenu(self.service, "/display/set/titles/right_top").execute(*args, **kwargs) - def right_middle(self, *args, **kwargs): - """ - Set the title text for right middle in title segment. - """ - return PyMenu(self.service, "/display/set/titles/right_middle").execute(*args, **kwargs) - def right_bottom(self, *args, **kwargs): - """ - Set the title text for right bottom in title segment. - """ - return PyMenu(self.service, "/display/set/titles/right_bottom").execute(*args, **kwargs) + return PyMenu(self.service, "/define/spectral/calculate_fourier_coefficients").execute(*args, **kwargs) + def delete_fourier_coefficients(self, *args, **kwargs): + """ + Deletes Fourier coefficient data. + """ + return PyMenu(self.service, "/define/spectral/delete_fourier_coefficients").execute(*args, **kwargs) + def calculate_harmonic_exports(self, *args, **kwargs): + """ + Calculates Harmonic Export data. + """ + return PyMenu(self.service, "/define/spectral/calculate_harmonic_exports").execute(*args, **kwargs) + def delete_harmonic_exports(self, *args, **kwargs): + """ + Deletes Harmonic Export data. + """ + return PyMenu(self.service, "/define/spectral/delete_harmonic_exports").execute(*args, **kwargs) - class velocity_vectors(metaclass=PyMenuMeta): + class custom_field_functions(TUIMenu): + """ + Enters the custom field functions menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def define(self, *args, **kwargs): """ - Enters the menu to set parameters for display of velocity vectors. + Defines a custom field function. """ - def __init__(self, path, service): - self.path = path - self.service = service - def auto_scale(self, *args, **kwargs): - """ - Auto-scales all vectors so that vector overlap is minimal. - """ - return PyMenu(self.service, "/display/set/velocity_vectors/auto_scale").execute(*args, **kwargs) - def color(self, *args, **kwargs): - """ - Sets the color of all velocity vectors to the color specified. The color scale is ignored. This is useful when overlaying a vector plot over a contour plot. - """ - return PyMenu(self.service, "/display/set/velocity_vectors/color").execute(*args, **kwargs) - def component_x(self, *args, **kwargs): - """ - Sets the option to use only the component of the velocity vectors during display. - """ - return PyMenu(self.service, "/display/set/velocity_vectors/component_x").execute(*args, **kwargs) - def component_y(self, *args, **kwargs): - """ - Sets the option to use only the component of the velocity vectors during display. - """ - return PyMenu(self.service, "/display/set/velocity_vectors/component_y").execute(*args, **kwargs) - def component_z(self, *args, **kwargs): - """ - Sets the option to use only the component of the velocity vectors during display. - """ - return PyMenu(self.service, "/display/set/velocity_vectors/component_z").execute(*args, **kwargs) - def constant_length(self, *args, **kwargs): - """ - Sets the option to draw velocity vectors of constant length. This shows only the direction of the velocity vectors. - """ - return PyMenu(self.service, "/display/set/velocity_vectors/constant_length").execute(*args, **kwargs) - def color_levels(self, *args, **kwargs): - """ - Sets the number of colors used from the colormap. - """ - return PyMenu(self.service, "/display/set/velocity_vectors/color_levels").execute(*args, **kwargs) - def global_range(self, *args, **kwargs): - """ - Turns global range for vectors on/off. - """ - return PyMenu(self.service, "/display/set/velocity_vectors/global_range").execute(*args, **kwargs) - def in_plane(self, *args, **kwargs): - """ - Toggles the display of velocity vector components in the plane of the surface selected for display. - """ - return PyMenu(self.service, "/display/set/velocity_vectors/in_plane").execute(*args, **kwargs) - def log_scale(self, *args, **kwargs): - """ - Toggles whether color scale is logarithmic or linear. - """ - return PyMenu(self.service, "/display/set/velocity_vectors/log_scale").execute(*args, **kwargs) - def node_values(self, *args, **kwargs): - """ - Enables/disables the plotting of node values. Cell values will be plotted if "no". - """ - return PyMenu(self.service, "/display/set/velocity_vectors/node_values").execute(*args, **kwargs) - def relative(self, *args, **kwargs): - """ - Toggles the display of relative velocity vectors. - """ - return PyMenu(self.service, "/display/set/velocity_vectors/relative").execute(*args, **kwargs) - def render_mesh(self, *args, **kwargs): - """ - Enables/disables rendering the mesh on top of contours, vectors, and so on. - """ - return PyMenu(self.service, "/display/set/velocity_vectors/render_mesh").execute(*args, **kwargs) - def scale(self, *args, **kwargs): - """ - Sets the value by which the vector length will be scaled. - """ - return PyMenu(self.service, "/display/set/velocity_vectors/scale").execute(*args, **kwargs) - def scale_head(self, *args, **kwargs): - """ - Sets the value by which the vector head will be scaled. - """ - return PyMenu(self.service, "/display/set/velocity_vectors/scale_head").execute(*args, **kwargs) - def style(self, *args, **kwargs): - """ - Specifies the vector style that will be used when the vectors are displayed. You can choose from:3d arrow,3d arrowhead, cone,filled-arrow, arrow,harpoon, or headless. - """ - return PyMenu(self.service, "/display/set/velocity_vectors/style").execute(*args, **kwargs) - def surfaces(self, *args, **kwargs): - """ - Sets surfaces on which vectors are drawn. You can include a wildcard (*) within the surface names. - """ - return PyMenu(self.service, "/display/set/velocity_vectors/surfaces").execute(*args, **kwargs) + return PyMenu(self.service, "/define/custom_field_functions/define").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes a custom field function. + """ + return PyMenu(self.service, "/define/custom_field_functions/delete").execute(*args, **kwargs) + def save(self, *args, **kwargs): + """ + Saves a custom field function. + """ + return PyMenu(self.service, "/define/custom_field_functions/save").execute(*args, **kwargs) + def load(self, *args, **kwargs): + """ + Loads a custom field function. + """ + return PyMenu(self.service, "/define/custom_field_functions/load").execute(*args, **kwargs) + def list_valid_cell_function_names(self, *args, **kwargs): + """ + Lists the names of cell functions that can be used in a custom field function. + """ + return PyMenu(self.service, "/define/custom_field_functions/list_valid_cell_function_names").execute(*args, **kwargs) + def example_cff_definitions(self, *args, **kwargs): + """ + Lists example custom field functions. + """ + return PyMenu(self.service, "/define/custom_field_functions/example_cff_definitions").execute(*args, **kwargs) + + class dynamic_mesh(TUIMenu): + """ + Enters the dynamic mesh menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.controls = self.__class__.controls(path + [("controls", None)], service) + self.events = self.__class__.events(path + [("events", None)], service) + self.zones = self.__class__.zones(path + [("zones", None)], service) + self.actions = self.__class__.actions(path + [("actions", None)], service) + self.transient_settings = self.__class__.transient_settings(path + [("transient_settings", None)], service) + super().__init__(path, service) + def dynamic_mesh(self, *args, **kwargs): + """ + Enables/disables the dynamic mesh solver. + """ + return PyMenu(self.service, "/define/dynamic_mesh/dynamic_mesh").execute(*args, **kwargs) - class windows(metaclass=PyMenuMeta): + class controls(TUIMenu): """ - Enter the window options menu. + Enters the dynamic mesh controls menu. This text command is only available when the define/dynamic-mesh/dynamic-mesh? text command is enabled. """ def __init__(self, path, service): self.path = path self.service = service - self.axes = self.__class__.axes(path + [("axes", None)], service) - self.main = self.__class__.main(path + [("main", None)], service) - self.scale = self.__class__.scale(path + [("scale", None)], service) - self.text = self.__class__.text(path + [("text", None)], service) - self.video = self.__class__.video(path + [("video", None)], service) - self.xy = self.__class__.xy(path + [("xy", None)], service) - def aspect_ratio(self, *args, **kwargs): + self.smoothing_parameters = self.__class__.smoothing_parameters(path + [("smoothing_parameters", None)], service) + self.layering_parameters = self.__class__.layering_parameters(path + [("layering_parameters", None)], service) + self.remeshing_parameters = self.__class__.remeshing_parameters(path + [("remeshing_parameters", None)], service) + self.in_cylinder_parameters = self.__class__.in_cylinder_parameters(path + [("in_cylinder_parameters", None)], service) + self.implicit_update_parameters = self.__class__.implicit_update_parameters(path + [("implicit_update_parameters", None)], service) + self.six_dof_parameters = self.__class__.six_dof_parameters(path + [("six_dof_parameters", None)], service) + self.periodic_displacement_parameters = self.__class__.periodic_displacement_parameters(path + [("periodic_displacement_parameters", None)], service) + self.contact_parameters = self.__class__.contact_parameters(path + [("contact_parameters", None)], service) + super().__init__(path, service) + def in_cylinder_output(self, *args, **kwargs): """ - Set the aspect ratio of the active window. + Enables/disables in-cylinder output. """ - return PyMenu(self.service, "/display/set/windows/aspect_ratio").execute(*args, **kwargs) - def logo(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_output").execute(*args, **kwargs) + def smoothing(self, *args, **kwargs): """ - Enable/disable visibility of the logo in graphics window. + Enables/disables smoothing in cell zones. """ - return PyMenu(self.service, "/display/set/windows/logo").execute(*args, **kwargs) - def ruler(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing").execute(*args, **kwargs) + def layering(self, *args, **kwargs): """ - Enable/disable ruler visibility. + Enables/disables dynamic-layering in quad/hex cell zones. """ - return PyMenu(self.service, "/display/set/windows/ruler").execute(*args, **kwargs) - def logo_color(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/layering").execute(*args, **kwargs) + def remeshing(self, *args, **kwargs): """ - Set logo color to white/black. + Enables/disables local remeshing in tri/tet and mixed cell zones. """ - return PyMenu(self.service, "/display/set/windows/logo_color").execute(*args, **kwargs) + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing").execute(*args, **kwargs) + def steady_pseudo_time_control(self, *args, **kwargs): + """ + Enables/disables the pseudo time step control in the graphical user interface. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/steady_pseudo_time_control").execute(*args, **kwargs) - class axes(metaclass=PyMenuMeta): + class smoothing_parameters(TUIMenu): """ - Enter the axes window options menu. + Enters the dynamic mesh smoothing-parameters menu. """ def __init__(self, path, service): self.path = path self.service = service - def border(self, *args, **kwargs): + super().__init__(path, service) + def smoothing_method(self, *args, **kwargs): """ - Enable/disable drawing of a border around the axes window. + Specify the smoothing method used by the dynamic mesh model. """ - return PyMenu(self.service, "/display/set/windows/axes/border").execute(*args, **kwargs) - def bottom(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/smoothing_method").execute(*args, **kwargs) + def constant_factor(self, *args, **kwargs): """ - Set the bottom boundary of the axes window. + Sets the spring constant relaxation factor. """ - return PyMenu(self.service, "/display/set/windows/axes/bottom").execute(*args, **kwargs) - def clear(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/constant_factor").execute(*args, **kwargs) + def bnd_node_relaxation(self, *args, **kwargs): """ - Set the transparency of the axes window. + The boundary node relaxation is used by spring smoothing. The boundary node relaxation allows you to relax the update of the node positions at deforming boundaries. A value of 0 prevents deforming boundary nodes from moving and a value of 1 indicates no under-relaxation. """ - return PyMenu(self.service, "/display/set/windows/axes/clear").execute(*args, **kwargs) - def right(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/bnd_node_relaxation").execute(*args, **kwargs) + def bnd_stiffness_factor(self, *args, **kwargs): """ - Set the right boundary of the axes window. + Sets the stiffness factor for springs connected to boundary nodes. """ - return PyMenu(self.service, "/display/set/windows/axes/right").execute(*args, **kwargs) - def visible(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/bnd_stiffness_factor").execute(*args, **kwargs) + def convergence_tolerance(self, *args, **kwargs): """ - Enable/disable axes visibility. + Sets the convergence tolerance for spring-based solver. """ - return PyMenu(self.service, "/display/set/windows/axes/visible").execute(*args, **kwargs) - - class main(metaclass=PyMenuMeta): - """ - Enter the main view window options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def border(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/convergence_tolerance").execute(*args, **kwargs) + def max_iter(self, *args, **kwargs): """ - Enable/disable drawing of borders around the main viewing window. + Set the maximum number of iterations for spring-based solver. """ - return PyMenu(self.service, "/display/set/windows/main/border").execute(*args, **kwargs) - def bottom(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/max_iter").execute(*args, **kwargs) + def spring_on_all_elements(self, *args, **kwargs): """ - Set the bottom boundary of the main viewing window. + Enables/disables spring-based smoothing for all cell shapes; if disabled, the spring-based smoothing is applied based on the setting of the define/dynamic-mesh/controls/smoothing-parameters/spring-on-simplex-shapes? text command. """ - return PyMenu(self.service, "/display/set/windows/main/bottom").execute(*args, **kwargs) - def left(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/spring_on_all_elements").execute(*args, **kwargs) + def spring_on_simplex_elements(self, *args, **kwargs): """ - Set the left boundary of the main viewing window. + Enable/disable spring-based smoothing for tri/tet elements in mixed element zones. """ - return PyMenu(self.service, "/display/set/windows/main/left").execute(*args, **kwargs) - def right(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/spring_on_simplex_elements").execute(*args, **kwargs) + def skew_smooth_niter(self, *args, **kwargs): """ - Set the right boundary of the main viewing window. + Sets the number of skewness-based smoothing cycles. """ - return PyMenu(self.service, "/display/set/windows/main/right").execute(*args, **kwargs) - def top(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/skew_smooth_niter").execute(*args, **kwargs) + def skew_smooth_cell_skew_max(self, *args, **kwargs): """ - Set the top boundary of the main viewing window. + Sets the skewness threshold, above which cells will be smoothed using the skewness method. """ - return PyMenu(self.service, "/display/set/windows/main/top").execute(*args, **kwargs) - def visible(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/skew_smooth_cell_skew_max").execute(*args, **kwargs) + def skew_smooth_face_skew_max(self, *args, **kwargs): """ - Enable/disable visibility of the main viewing window. + Sets the skewness threshold, above which faces will be smoothed using the skewness method. """ - return PyMenu(self.service, "/display/set/windows/main/visible").execute(*args, **kwargs) - - class scale(metaclass=PyMenuMeta): - """ - Enter the color scale window options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def border(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/skew_smooth_face_skew_max").execute(*args, **kwargs) + def skew_smooth_all_deforming_boundaries(self, *args, **kwargs): """ - Enable/disable drawing of borders around the color scale window. + Enables/disables skewness smoothing for all deforming dynamic boundary zones. This is enabled by default. If disabled, skewness smoothing is only applied to the deforming dynamic boundary zones that have smoothing explicitly enabled or use local face remeshing. """ - return PyMenu(self.service, "/display/set/windows/scale/border").execute(*args, **kwargs) - def bottom(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/skew_smooth_all_deforming_boundaries").execute(*args, **kwargs) + def laplace_node_relaxation(self, *args, **kwargs): """ - Set the bottom boundary of the color scale window. + Set the Laplace boundary node relaxation factor. """ - return PyMenu(self.service, "/display/set/windows/scale/bottom").execute(*args, **kwargs) - def clear(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/laplace_node_relaxation").execute(*args, **kwargs) + def diffusion_coeff_function(self, *args, **kwargs): """ - Set the transparency of the scale window. + Specifies whether the diffusion coefficient for diffusion-based smoothing is based on the boundary distance or the cell volume. """ - return PyMenu(self.service, "/display/set/windows/scale/clear").execute(*args, **kwargs) - def format(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/diffusion_coeff_function").execute(*args, **kwargs) + def diffusion_coeff_parameter(self, *args, **kwargs): """ - Set the number format of the color scale window (e.g. %0.2e). + Sets the diffusion coefficient parameter used for diffusion-based smoothing. """ - return PyMenu(self.service, "/display/set/windows/scale/format").execute(*args, **kwargs) - def font_size(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/diffusion_coeff_parameter").execute(*args, **kwargs) + def diffusion_fvm(self, *args, **kwargs): """ - Set the font size of the color scale window. + Answering yes at the prompt changes the diffusion-based smoothing method to the cell-based finite volume approach that was the default in releases prior to Fluent 15.0. Answering no at the prompt changes the diffusion-based smoothing method to the default node-based finite element method. """ - return PyMenu(self.service, "/display/set/windows/scale/font_size").execute(*args, **kwargs) - def left(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/diffusion_fvm").execute(*args, **kwargs) + def poisson_ratio(self, *args, **kwargs): """ - Set the left boundary of the color scale window. + Sets the Poisson’s ratio used for smoothing based on the linearly elastic solid model. """ - return PyMenu(self.service, "/display/set/windows/scale/left").execute(*args, **kwargs) - def margin(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/poisson_ratio").execute(*args, **kwargs) + def smooth_from_reference_position(self, *args, **kwargs): """ - Set the margin of the color scale window. + Enables/disables smoothing from a reference position. Such smoothing may produce greater mesh quality consistency for stationary or moving meshes with periodic or quasi-periodic motion, and is only available when the smoothing method is based on diffusion or the linearly elastic solid model. """ - return PyMenu(self.service, "/display/set/windows/scale/margin").execute(*args, **kwargs) - def right(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/smooth_from_reference_position").execute(*args, **kwargs) + def relative_convergence_tolerance(self, *args, **kwargs): """ - Set the right boundary of the color scale window. + Sets the relative residual convergence tolerance for smoothing based on diffusion or the linearly elastic solid model. """ - return PyMenu(self.service, "/display/set/windows/scale/right").execute(*args, **kwargs) - def top(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/relative_convergence_tolerance").execute(*args, **kwargs) + def amg_stabilization(self, *args, **kwargs): """ - Set the top boundary of the color scale window. + Set the AMG stabilization method for mesh smoothing (FEM). """ - return PyMenu(self.service, "/display/set/windows/scale/top").execute(*args, **kwargs) - def visible(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/amg_stabilization").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): """ - Enable/disable visibility of the color scale window. + Set the verbosity for spring smoothing. """ - return PyMenu(self.service, "/display/set/windows/scale/visible").execute(*args, **kwargs) - def alignment(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/verbosity").execute(*args, **kwargs) + def boundary_distance_method(self, *args, **kwargs): """ - Set colormap to bottom/left/top/right. + Sets the method used to evaluate the boundary distance for the diffusion coefficient calculation, when diffusion-based smoothing is enabled. """ - return PyMenu(self.service, "/display/set/windows/scale/alignment").execute(*args, **kwargs) + return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/boundary_distance_method").execute(*args, **kwargs) - class text(metaclass=PyMenuMeta): + class layering_parameters(TUIMenu): """ - Enter the text window options menu. + Enters the dynamic mesh layering menu. """ def __init__(self, path, service): self.path = path self.service = service - def application(self, *args, **kwargs): + super().__init__(path, service) + def split_factor(self, *args, **kwargs): """ - Enable/disable the application name in the picture. + Sets the factor determining when to split dynamic layers. """ - return PyMenu(self.service, "/display/set/windows/text/application").execute(*args, **kwargs) - def border(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/layering_parameters/split_factor").execute(*args, **kwargs) + def collapse_factor(self, *args, **kwargs): """ - Enable/disable drawing of borders around the text window. + Sets the factor determining when to collapse dynamic layers. """ - return PyMenu(self.service, "/display/set/windows/text/border").execute(*args, **kwargs) - def bottom(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/layering_parameters/collapse_factor").execute(*args, **kwargs) + def constant_height(self, *args, **kwargs): """ - Set the bottom boundary of the text window. + Enables/disables layering based on constant height, else layering based on constant ratio. """ - return PyMenu(self.service, "/display/set/windows/text/bottom").execute(*args, **kwargs) - def clear(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/layering_parameters/constant_height").execute(*args, **kwargs) + + class remeshing_parameters(TUIMenu): + """ + Enters the dynamic mesh remeshing menu to set parameters for all remeshing methods. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.prism_controls = self.__class__.prism_controls(path + [("prism_controls", None)], service) + self.sizing_controls = self.__class__.sizing_controls(path + [("sizing_controls", None)], service) + self.prism_layer_parameters = self.__class__.prism_layer_parameters(path + [("prism_layer_parameters", None)], service) + super().__init__(path, service) + def unified_remeshing(self, *args, **kwargs): """ - Enable/disable text window transparency. + Enables/disables unified remeshing, which specifies that an algorithm is used that combines aspects of a variety of remeshing methods. It is applied to triangular or tetrahedral cells and can produce wedge cells in 3D boundary layer meshes. Unified remeshing simplifies the remeshing setup and can provide increased robustness compared to methods-based remeshing, especially for parallel simulations. """ - return PyMenu(self.service, "/display/set/windows/text/clear").execute(*args, **kwargs) - def company(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/unified_remeshing").execute(*args, **kwargs) + def retain_size_distribution(self, *args, **kwargs): """ - Enable/disable the company name in the picture. + Enables/disables the use of local size criteria when marking cells for unified remeshing (in an attempt to maintain the initial mesh size distribution even as the mesh moves), rather than marking cells based on the minimum and maximum length scale values of the cell zone in the initial mesh. Either marking can be overridden if more restrictive values are specified using the define/dynamic-mesh/controls/remeshing-parameters/length-min and define/dynamic-mesh/controls/remeshing-parameters/length-max text commands. """ - return PyMenu(self.service, "/display/set/windows/text/company").execute(*args, **kwargs) - def date(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/retain_size_distribution").execute(*args, **kwargs) + def poly_remeshing(self, *args, **kwargs): """ - Enable/disable the date in the picture. + Enable/disable poly remeshing. """ - return PyMenu(self.service, "/display/set/windows/text/date").execute(*args, **kwargs) - def left(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/poly_remeshing").execute(*args, **kwargs) + def remeshing_methods(self, *args, **kwargs): """ - Set the left boundary of the text window. + Enables/disables individual remeshing options as part of methods-based remeshing. """ - return PyMenu(self.service, "/display/set/windows/text/left").execute(*args, **kwargs) - def right(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/remeshing_methods").execute(*args, **kwargs) + def zone_remeshing(self, *args, **kwargs): """ - Set the right boundary of the text window. + Enables/disables the cell zone remeshing method as part of methods-based remeshing. """ - return PyMenu(self.service, "/display/set/windows/text/right").execute(*args, **kwargs) - def top(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/zone_remeshing").execute(*args, **kwargs) + def length_min(self, *args, **kwargs): """ - Set the top boundary of the text window. + Sets the length threshold below which cells will be remeshed. """ - return PyMenu(self.service, "/display/set/windows/text/top").execute(*args, **kwargs) - def visible(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/length_min").execute(*args, **kwargs) + def length_max(self, *args, **kwargs): """ - Enable/disable text window transparency. + Sets the length threshold above which cells will be remeshed. """ - return PyMenu(self.service, "/display/set/windows/text/visible").execute(*args, **kwargs) + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/length_max").execute(*args, **kwargs) + def cell_skew_max(self, *args, **kwargs): + """ + Sets the cell skewness threshold above which cells will be remeshed. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/cell_skew_max").execute(*args, **kwargs) + def face_skew_max(self, *args, **kwargs): + """ + Sets the face skewness threshold above which faces will be remeshed. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/face_skew_max").execute(*args, **kwargs) + def size_remesh_interval(self, *args, **kwargs): + """ + Sets the interval (in time steps) when remeshing based on size is done for methods-based remeshing. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/size_remesh_interval").execute(*args, **kwargs) + def sizing_function(self, *args, **kwargs): + """ + Enables/disables the sizing function as part of methods-based remeshing. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_function").execute(*args, **kwargs) + def sizing_funct_defaults(self, *args, **kwargs): + """ + Sets sizing function defaults. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_funct_defaults").execute(*args, **kwargs) + def sizing_funct_resolution(self, *args, **kwargs): + """ + Sets the sizing function resolution with respect to shortest boundary. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_funct_resolution").execute(*args, **kwargs) + def sizing_funct_variation(self, *args, **kwargs): + """ + Sets the maximum sizing function increase/decrease in the interior. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_funct_variation").execute(*args, **kwargs) + def sizing_funct_rate(self, *args, **kwargs): + """ + Determines how far from the boundary the increase/decrease happens. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_funct_rate").execute(*args, **kwargs) + def parallel_remeshing(self, *args, **kwargs): + """ + Disables/enables parallel remeshing as part of methods-based remeshing.. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/parallel_remeshing").execute(*args, **kwargs) + def remeshing_after_moving(self, *args, **kwargs): + """ + Enables a second round of remeshing based on the skewness parameters after the boundary has moved as part of methods-based remeshing. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/remeshing_after_moving").execute(*args, **kwargs) + + class prism_controls(TUIMenu): + """ + Enters the dynamic mesh prism controls menu, which provides text commands that can be useful when you want to modify the algorithm that attempts to retain the size distribution during unified remeshing. Each prism control definition is applied to one or more boundary zones, and then affects the height distribution and number of layers of the wedge cells in the adjacent boundary layers. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add(self, *args, **kwargs): + """ + Adds a new prism controls definition. After being prompted for a name, you can enter the following to complete the definition: + + + + first-height Sets the height of the first layer of wedge cells in the boundary layer adjacent to the specified zones. + + + + growth-method Specifies the method used to determine the increase in height of the wedge cell layers beyond the first layer. The only available option is geometric, so that the height of each layer is the height of the previous layer multiplied by the rate. + + + + name Specifies the name of the prism controls definition. + + + + nlayers Sets the number of layers of wedge cells in the boundary layer adjacent to the specified zones. + + + + rate Sets the coefficient for the growth-method used to determine the increase in height of the wedge cell layers beyond the first layer. + + + + zones Specifies all of the boundary zones on which this prism controls definition is applied. + + + Enter q when the definition is complete to return to the text command menu. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/prism_controls/add").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edits an existing prism controls definition. You can revise the fields listed previously for the define/dynamic-mesh/controls/remeshing-parameters/prism-controls/add text command. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/prism_controls/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes an existing prism controls definition. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/prism_controls/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Prints a list of the existing prism controls definitions in the console. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/prism_controls/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + Prints the properties of an existing prism controls definition of your choice in the console. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/prism_controls/list_properties").execute(*args, **kwargs) + + class sizing_controls(TUIMenu): + """ + Enters the dynamic mesh sizing controls menu, which provides text commands that can be useful when you want to modify the algorithm that attempts to retain the size distribution during unified remeshing. Each sizing control definition is applied to one or more boundary zones, and then affects the size of the cells throughout the mesh based on their distance from those boundary zone(s) and your settings in the definition. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add(self, *args, **kwargs): + """ + Adds a new sizing controls definition. After being prompted for a name, you can enter the following to complete the definition: + + + + growth-rate Sets the growth rate of the sizing controls definition. + + + + max-length Sets a maximum length threshold that is used when the type is set to auto or soft. + + + + min-length Sets a maximum length threshold that is used when the type is set to auto. + + + + motion Determines whether the size control definition affects the remeshing based on whether the mesh undergoes motion: auto specifies that it is applied whether or not there is motion; and static specifies that it is only applied if there is no motion. + + + + name Specifies the name of the sizing controls definition. + + + + type Specifies how the sizing is affected by the selected boundary zones: auto specifies that the default size distribution (rather than the initial size distribution in your selected boundary zones) is used, along with your specified max-length and min-length values; soft specifies that the maximum length scale of your selected boundary zones is used, along with your specified min-length value; and meshed specifies that the maximum and minimum length scales of your selected boundary zones are used, in order to respect their initial size distribution. This setting is only relevant if you have more than one sizing controls definition. + + + + zones Specifies all of the boundary zones on which the sizing controls definition is applied. + + + Enter q when the definition is complete to return to the text command menu. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_controls/add").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edits an existing sizing controls definition. You can revise the fields listed previously for the define/dynamic-mesh/controls/remeshing-parameters/sizing-controls/add text command. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_controls/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes an existing sizing controls definition. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_controls/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Prints a list of the existing sizing controls definitions in the console. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_controls/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + Prints the properties of an existing sizing controls definition of your choice in the console. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_controls/list_properties").execute(*args, **kwargs) + + class prism_layer_parameters(TUIMenu): + """ + Enters the dynamic mesh prism layer parameters menu, where you can define the parameters of the prism layers as part of methods-based remeshing. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def first_height(self, *args, **kwargs): + """ + Sets the first cell height in the prism layer. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/prism_layer_parameters/first_height").execute(*args, **kwargs) + def growth_rate(self, *args, **kwargs): + """ + Sets the geometric growth rate of the prism layer. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/prism_layer_parameters/growth_rate").execute(*args, **kwargs) + def number_of_layers(self, *args, **kwargs): + """ + Sets the number of elements in the prism layer. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/prism_layer_parameters/number_of_layers").execute(*args, **kwargs) - class video(metaclass=PyMenuMeta): + class in_cylinder_parameters(TUIMenu): """ - Enter the video window options menu. + Enters the dynamic mesh in-cylinder menu. """ def __init__(self, path, service): self.path = path self.service = service - def background(self, *args, **kwargs): + super().__init__(path, service) + def starting_crank_angle(self, *args, **kwargs): """ - Set the background color in the video picture. + Specifies the initial value for the crank angle. """ - return PyMenu(self.service, "/display/set/windows/video/background").execute(*args, **kwargs) - def color_filter(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/starting_crank_angle").execute(*args, **kwargs) + def crank_angle_step(self, *args, **kwargs): """ - Set the color filter options for the picture. + Specifies crank angle step size. """ - return PyMenu(self.service, "/display/set/windows/video/color_filter").execute(*args, **kwargs) - def foreground(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/crank_angle_step").execute(*args, **kwargs) + def crank_period(self, *args, **kwargs): """ - Set the foreground color in the video picture. + Specifies the crank period. """ - return PyMenu(self.service, "/display/set/windows/video/foreground").execute(*args, **kwargs) - def on(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/crank_period").execute(*args, **kwargs) + def max_crank_angle_step(self, *args, **kwargs): """ - Enable/disable video picture settings. + Specifies maximum crank angle step size. """ - return PyMenu(self.service, "/display/set/windows/video/on").execute(*args, **kwargs) - def pixel_size(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/max_crank_angle_step").execute(*args, **kwargs) + def piston_data(self, *args, **kwargs): """ - Set the window size in pixels. + Specifies the crank radius and connecting rod length. """ - return PyMenu(self.service, "/display/set/windows/video/pixel_size").execute(*args, **kwargs) + return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/piston_data").execute(*args, **kwargs) + def piston_stroke_cutoff(self, *args, **kwargs): + """ + Specifies the cut off point for in-cylinder piston. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/piston_stroke_cutoff").execute(*args, **kwargs) + def minimum_lift(self, *args, **kwargs): + """ + Specifies minimum lift for in-cylinder valves. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/minimum_lift").execute(*args, **kwargs) + def print_plot_lift(self, *args, **kwargs): + """ + Prints or plot valve lift curve. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/print_plot_lift").execute(*args, **kwargs) + def modify_lift(self, *args, **kwargs): + """ + Modifies lift curve (shift or scale). + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/modify_lift").execute(*args, **kwargs) + def position_starting_mesh(self, *args, **kwargs): + """ + Moves mesh from top dead center to starting crank angle. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/position_starting_mesh").execute(*args, **kwargs) - class xy(metaclass=PyMenuMeta): + class implicit_update_parameters(TUIMenu): """ - Enter the X-Y plot window options menu. + Enters the dynamic mesh implicit update menu. This text command is only available when you enable implicit mesh updating using the prompts of the define/dynamic-mesh/dynamic-mesh? text command. """ def __init__(self, path, service): self.path = path self.service = service - def border(self, *args, **kwargs): + super().__init__(path, service) + def update_interval(self, *args, **kwargs): """ - Enable/disable drawing of a border around the X-Y plotter window. + Specifies the update interval (that is, the frequency in iterations) at which the mesh is updated within a time step. """ - return PyMenu(self.service, "/display/set/windows/xy/border").execute(*args, **kwargs) - def bottom(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/implicit_update_parameters/update_interval").execute(*args, **kwargs) + def motion_relaxation(self, *args, **kwargs): """ - Set the bottom boundary of the X-Y plotter window. + Specifies a value (within the range of 0 to 1) for the motion relaxation, which is applied during the implicit mesh update. """ - return PyMenu(self.service, "/display/set/windows/xy/bottom").execute(*args, **kwargs) - def left(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/implicit_update_parameters/motion_relaxation").execute(*args, **kwargs) + def residual_criteria(self, *args, **kwargs): """ - Set the left boundary of the X-Y plotter window. + Specifies the relative residual threshold that is used to check the motion convergence during the implicit mesh update. """ - return PyMenu(self.service, "/display/set/windows/xy/left").execute(*args, **kwargs) - def right(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/implicit_update_parameters/residual_criteria").execute(*args, **kwargs) + + class six_dof_parameters(TUIMenu): + """ + Enters the dynamic mesh six degrees of freedom (DOF) solver menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def create_properties(self, *args, **kwargs): """ - Set the right boundary of the X-Y plotter window. + Creates/edits a set of six DOF properties for rigid body motion. """ - return PyMenu(self.service, "/display/set/windows/xy/right").execute(*args, **kwargs) - def top(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/create_properties").execute(*args, **kwargs) + def delete_properties(self, *args, **kwargs): """ - Set the top boundary of the X-Y plotter window. + Deletes a set of six DOF properties for rigid body motion. """ - return PyMenu(self.service, "/display/set/windows/xy/top").execute(*args, **kwargs) - def visible(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/delete_properties").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): """ - Enable/disable X-Y plotter window visibility. + Prints summaries of the existing sets of six DOF properties for rigid body motion. """ - return PyMenu(self.service, "/display/set/windows/xy/visible").execute(*args, **kwargs) + return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/list_properties").execute(*args, **kwargs) + def x_component_of_gravity(self, *args, **kwargs): + """ + Specifies x-component of gravity. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/x_component_of_gravity").execute(*args, **kwargs) + def y_component_of_gravity(self, *args, **kwargs): + """ + Specifies y-component of gravity. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/y_component_of_gravity").execute(*args, **kwargs) + def z_component_of_gravity(self, *args, **kwargs): + """ + Specifies z-component of gravity. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/z_component_of_gravity").execute(*args, **kwargs) + def second_order(self, *args, **kwargs): + """ + Enables/disables the second order six degrees of freedom solver. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/second_order").execute(*args, **kwargs) + def motion_history(self, *args, **kwargs): + """ + Enables/disables writing position/orientation of six DOF zones to file. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/motion_history").execute(*args, **kwargs) + def motion_history_file_name(self, *args, **kwargs): + """ + Specifies the name and location of the six DOF motion history file. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/motion_history_file_name").execute(*args, **kwargs) - class surface(metaclass=PyMenuMeta): - """ - Enters the data surface-manipulation menu. For a description of the items in this menu, see surface/ - - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.post_processing_volume = self.__class__.post_processing_volume(path + [("post_processing_volume", None)], service) - self.query = self.__class__.query(path + [("query", None)], service) - def circle_slice(self, *args, **kwargs): - """ - Extract a circular slice. - """ - return PyMenu(self.service, "/display/surface/circle_slice").execute(*args, **kwargs) - def delete_surface(self, *args, **kwargs): - """ - Remove a defined data surface. - """ - return PyMenu(self.service, "/display/surface/delete_surface").execute(*args, **kwargs) - def group_surfaces(self, *args, **kwargs): - """ - Group a set of surfaces. - """ - return PyMenu(self.service, "/display/surface/group_surfaces").execute(*args, **kwargs) - def ungroup_surface(self, *args, **kwargs): - """ - Ungroup the surface(if grouped). - """ - return PyMenu(self.service, "/display/surface/ungroup_surface").execute(*args, **kwargs) - def iso_clip(self, *args, **kwargs): - """ - Clip a data surface (surface, curve, or point) between two iso-values. - """ - return PyMenu(self.service, "/display/surface/iso_clip").execute(*args, **kwargs) - def iso_surface(self, *args, **kwargs): - """ - Extract an iso-surface (surface, curve, or point) from the curent data field. - """ - return PyMenu(self.service, "/display/surface/iso_surface").execute(*args, **kwargs) - def expression_volume(self, *args, **kwargs): - """ - Create volume with boolean expression. - """ - return PyMenu(self.service, "/display/surface/expression_volume").execute(*args, **kwargs) - def multiple_iso_surfaces(self, *args, **kwargs): - """ - Create multiple iso-surfaces from the data field at specified spacing. - """ - return PyMenu(self.service, "/display/surface/multiple_iso_surfaces").execute(*args, **kwargs) - def line_slice(self, *args, **kwargs): - """ - Extract a linear slice. - """ - return PyMenu(self.service, "/display/surface/line_slice").execute(*args, **kwargs) - def line_surface(self, *args, **kwargs): - """ - Define a "line" surface by specifying the two endpoint coordinates. - """ - return PyMenu(self.service, "/display/surface/line_surface").execute(*args, **kwargs) - def list_surfaces(self, *args, **kwargs): - """ - List the number of facets in the defined surfaces. - """ - return PyMenu(self.service, "/display/surface/list_surfaces").execute(*args, **kwargs) - def mouse_line(self, *args, **kwargs): - """ - Define a line surface using the mouse to select two points. - """ - return PyMenu(self.service, "/display/surface/mouse_line").execute(*args, **kwargs) - def mouse_plane(self, *args, **kwargs): - """ - Define a plane surface using the mouse to select three points. - """ - return PyMenu(self.service, "/display/surface/mouse_plane").execute(*args, **kwargs) - def mouse_rake(self, *args, **kwargs): - """ - Define a "rake" surface using the mouse to select the end points. - """ - return PyMenu(self.service, "/display/surface/mouse_rake").execute(*args, **kwargs) - def partition_surface(self, *args, **kwargs): - """ - Define a data surface on mesh faces on the partition boundary. - """ - return PyMenu(self.service, "/display/surface/partition_surface").execute(*args, **kwargs) - def plane(self, *args, **kwargs): - """ - Create a plane given 3 points bounded by the domain. - """ - return PyMenu(self.service, "/display/surface/plane").execute(*args, **kwargs) - def plane_surface(self, *args, **kwargs): - """ - Create a plane from a coordinate plane, point and normal, or three points. - """ - return PyMenu(self.service, "/display/surface/plane_surface").execute(*args, **kwargs) - def multiple_plane_surfaces(self, *args, **kwargs): - """ - Create multiple plane surfaces at specified spacing. - """ - return PyMenu(self.service, "/display/surface/multiple_plane_surfaces").execute(*args, **kwargs) - def plane_slice(self, *args, **kwargs): - """ - Extract a planar slice. - """ - return PyMenu(self.service, "/display/surface/plane_slice").execute(*args, **kwargs) - def point_array(self, *args, **kwargs): - """ - Extract a rectangular array of data points. - """ - return PyMenu(self.service, "/display/surface/point_array").execute(*args, **kwargs) - def point_surface(self, *args, **kwargs): - """ - Define a "point" surface by specifying the coordinates. - """ - return PyMenu(self.service, "/display/surface/point_surface").execute(*args, **kwargs) - def structural_point_surface(self, *args, **kwargs): - """ - Define a "structural point" surface by specifying the coordinates. - """ - return PyMenu(self.service, "/display/surface/structural_point_surface").execute(*args, **kwargs) - def quadric_slice(self, *args, **kwargs): - """ - Extract a quadric slice. - """ - return PyMenu(self.service, "/display/surface/quadric_slice").execute(*args, **kwargs) - def rake_surface(self, *args, **kwargs): - """ - Define a "rake" surface by specifying the end points. - """ - return PyMenu(self.service, "/display/surface/rake_surface").execute(*args, **kwargs) - def rename_surface(self, *args, **kwargs): - """ - Rename a defined data surface. - """ - return PyMenu(self.service, "/display/surface/rename_surface").execute(*args, **kwargs) - def sphere_slice(self, *args, **kwargs): - """ - Extract a spherical slice. - """ - return PyMenu(self.service, "/display/surface/sphere_slice").execute(*args, **kwargs) - def ellipsoid_slice(self, *args, **kwargs): - """ - Extract a ellipsoid slice. - """ - return PyMenu(self.service, "/display/surface/ellipsoid_slice").execute(*args, **kwargs) - def cone_slice(self, *args, **kwargs): - """ - Extract a cone slice. - """ - return PyMenu(self.service, "/display/surface/cone_slice").execute(*args, **kwargs) - def surface_cells(self, *args, **kwargs): - """ - Extract all cells intersected by a data surface. - """ - return PyMenu(self.service, "/display/surface/surface_cells").execute(*args, **kwargs) - def transform_surface(self, *args, **kwargs): - """ - Transform surface. - """ - return PyMenu(self.service, "/display/surface/transform_surface").execute(*args, **kwargs) - def create_imprint_surface(self, *args, **kwargs): - """ - Imprint surface. - """ - return PyMenu(self.service, "/display/surface/create_imprint_surface").execute(*args, **kwargs) - def zone_surface(self, *args, **kwargs): - """ - Define a data surface on a mesh zone. - """ - return PyMenu(self.service, "/display/surface/zone_surface").execute(*args, **kwargs) - def reset_zone_surfaces(self, *args, **kwargs): - """ - Reset case surface list. - """ - return PyMenu(self.service, "/display/surface/reset_zone_surfaces").execute(*args, **kwargs) - def multiple_zone_surfaces(self, *args, **kwargs): - """ - Create multiple data surfaces at a time. - """ - return PyMenu(self.service, "/display/surface/multiple_zone_surfaces").execute(*args, **kwargs) - def edit_surface(self, *args, **kwargs): - """ - Edit a defined data surface. - """ - return PyMenu(self.service, "/display/surface/edit_surface").execute(*args, **kwargs) + class periodic_displacement_parameters(TUIMenu): + """ + Enters the periodic displacement parameters menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def list_displacements(self, *args, **kwargs): + """ + List Periodic Displacements. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/list_displacements").execute(*args, **kwargs) + def create_displacement(self, *args, **kwargs): + """ + Create Periodic Displacement. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/create_displacement").execute(*args, **kwargs) + def edit_displacement(self, *args, **kwargs): + """ + Edit Periodic Displacement. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/edit_displacement").execute(*args, **kwargs) + def copy_displacement(self, *args, **kwargs): + """ + Copy Periodic Displacement. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/copy_displacement").execute(*args, **kwargs) + def delete_displacement(self, *args, **kwargs): + """ + Delete Periodic Displacement. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/delete_displacement").execute(*args, **kwargs) + def delete_all_displacements(self, *args, **kwargs): + """ + Delete All Periodic Displacements. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/delete_all_displacements").execute(*args, **kwargs) + def create_group(self, *args, **kwargs): + """ + Create Periodic Displacement Group. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/create_group").execute(*args, **kwargs) + def list_groups(self, *args, **kwargs): + """ + List Periodic Displacement Groups. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/list_groups").execute(*args, **kwargs) + def edit_group(self, *args, **kwargs): + """ + Edit Periodic Displacement Group. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/edit_group").execute(*args, **kwargs) + def delete_group(self, *args, **kwargs): + """ + Delete Periodic Displacement Group. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/delete_group").execute(*args, **kwargs) + def delete_all_groups(self, *args, **kwargs): + """ + Delete All Periodic Displacement Groups. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/delete_all_groups").execute(*args, **kwargs) + def set_active_displacement(self, *args, **kwargs): + """ + Set Active Periodic Displacement in Group. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/set_active_displacement").execute(*args, **kwargs) + + class contact_parameters(TUIMenu): + """ + Enters the dynamic mesh contact-parameters menu. This text command is only available when you enable contact detection using the prompts of the define/dynamic-mesh/dynamic-mesh? text command. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.flow_control_parameters = self.__class__.flow_control_parameters(path + [("flow_control_parameters", None)], service) + super().__init__(path, service) + def contact_face_zones(self, *args, **kwargs): + """ + Selects face zones involved in contact detection. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/contact_face_zones").execute(*args, **kwargs) + def contact_udf(self, *args, **kwargs): + """ + Selects the UDF to be invoked when contact is detected. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/contact_udf").execute(*args, **kwargs) + def contact_threshold(self, *args, **kwargs): + """ + Specifies threshold distance for contact detection. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/contact_threshold").execute(*args, **kwargs) + def update_contact_marks(self, *args, **kwargs): + """ + Updates which cells are marked in order to block flow in the contact region as part of the contact marks method. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/update_contact_marks").execute(*args, **kwargs) + def flow_control(self, *args, **kwargs): + """ + Enables/disables flow control in the contact region. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/flow_control").execute(*args, **kwargs) + def contact_method(self, *args, **kwargs): + """ + Selects the method used for flow control in the contact region. Enter 0 for the contact zones method (which restricts the flow using additional cell zones with porous zone properties) or 1 for the contact marks method (which blocks the flow using zero-mass-flux boundaries). + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/contact_method").execute(*args, **kwargs) + def render_contact_cells(self, *args, **kwargs): + """ + Enables/disables the availability of a field variable (contact-cell-mark) that can be used to display contours of cells marked for flow blocking as part of the contact marks method, and allows you to postprocess other field variables on those cells. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/render_contact_cells").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Sets the level of detail printed in the console regarding contact detection. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/verbosity").execute(*args, **kwargs) + + class flow_control_parameters(TUIMenu): + """ + Enters the flow control parameters menu, which provides settings related to controlling the flow in the contact region. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def solution_stabilization(self, *args, **kwargs): + """ + Enables/disables the performance of additional iterations per time step and the application of solution controls to improve the stability of the solver as part of the contact marks method. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/flow_control_parameters/solution_stabilization").execute(*args, **kwargs) + def create_flow_control_zone(self, *args, **kwargs): + """ + Creates a flow control zone as part of the contact zones method. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/flow_control_parameters/create_flow_control_zone").execute(*args, **kwargs) + def delete_flow_control_zone(self, *args, **kwargs): + """ + Deletes a flow control zone as part of the contact zones method. + """ + return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/flow_control_parameters/delete_flow_control_zone").execute(*args, **kwargs) - class post_processing_volume(metaclass=PyMenuMeta): + class events(TUIMenu): """ - Enter post-processing volume menu. + Enters the dynamic mesh events menu. """ def __init__(self, path, service): self.path = path self.service = service - def create_from_file(self, *args, **kwargs): + super().__init__(path, service) + def import_event_file(self, *args, **kwargs): """ - Read post-processing mesh from file. + Imports dynamic mesh event file. """ - return PyMenu(self.service, "/display/surface/post_processing_volume/create_from_file").execute(*args, **kwargs) - def create_octree(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/events/import_event_file").execute(*args, **kwargs) + def export_event_file(self, *args, **kwargs): """ - Create post-processing octree mesh based on current case. + Exports dynamic mesh events to file. """ - return PyMenu(self.service, "/display/surface/post_processing_volume/create_octree").execute(*args, **kwargs) + return PyMenu(self.service, "/define/dynamic_mesh/events/export_event_file").execute(*args, **kwargs) - class query(metaclass=PyMenuMeta): + class zones(TUIMenu): """ - Enter surface query menu. + Enters the dynamic mesh zones menu. """ def __init__(self, path, service): self.path = path self.service = service - def delete_query(self, *args, **kwargs): + super().__init__(path, service) + def create(self, *args, **kwargs): """ - Delete saved query. + Creates or edit a dynamic zone. """ - return PyMenu(self.service, "/display/surface/query/delete_query").execute(*args, **kwargs) - def list_surfaces(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/zones/create").execute(*args, **kwargs) + def delete(self, *args, **kwargs): """ - List surfaces. + Deletes a dynamic zone. """ - return PyMenu(self.service, "/display/surface/query/list_surfaces").execute(*args, **kwargs) - def named_surface_list(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/zones/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): """ - Create named list of surfaces. + Lists the dynamic zones. """ - return PyMenu(self.service, "/display/surface/query/named_surface_list").execute(*args, **kwargs) - def list_named_selection(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/zones/list").execute(*args, **kwargs) + def insert_boundary_layer(self, *args, **kwargs): """ - List named selection of surface type. + Inserts a new cell zone. """ - return PyMenu(self.service, "/display/surface/query/list_named_selection").execute(*args, **kwargs) - def list_queries(self, *args, **kwargs): + return PyMenu(self.service, "/define/dynamic_mesh/zones/insert_boundary_layer").execute(*args, **kwargs) + def remove_boundary_layer(self, *args, **kwargs): """ - List all saved queries. + Removes a cell zone. """ - return PyMenu(self.service, "/display/surface/query/list_queries").execute(*args, **kwargs) + return PyMenu(self.service, "/define/dynamic_mesh/zones/remove_boundary_layer").execute(*args, **kwargs) + def insert_interior_layer(self, *args, **kwargs): + """ + Inserts a new layer cell zone at a specified location. + """ + return PyMenu(self.service, "/define/dynamic_mesh/zones/insert_interior_layer").execute(*args, **kwargs) + def remove_interior_layer(self, *args, **kwargs): + """ + Removes an interior layer cell zone. + """ + return PyMenu(self.service, "/define/dynamic_mesh/zones/remove_interior_layer").execute(*args, **kwargs) + + class actions(TUIMenu): + """ + Enters the dynamic mesh action menu, where you can initiate manual remeshing (that is, remeshing without running a calculation). + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def remesh_cell_zone(self, *args, **kwargs): + """ + Manually remeshes a cell zone with option to remesh adjacent dynamic face zones. + """ + return PyMenu(self.service, "/define/dynamic_mesh/actions/remesh_cell_zone").execute(*args, **kwargs) + + class transient_settings(TUIMenu): + """ + Enters the transient dynamic mesh settings menu. This text command is only available when you enable dynamic mesh using the prompts of the define/dynamic-mesh/dynamic-mesh? text command. Solver time must also be set to Transient. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def verbosity(self, *args, **kwargs): + """ + Enables/disables transient scheme verbosity for dynamic mesh cases. + """ + return PyMenu(self.service, "/define/dynamic_mesh/transient_settings/verbosity").execute(*args, **kwargs) + def allow_second_order(self, *args, **kwargs): + """ + Enables/disables second order transient scheme for dynamic mesh cases. + """ + return PyMenu(self.service, "/define/dynamic_mesh/transient_settings/allow_second_order").execute(*args, **kwargs) - class views(metaclass=PyMenuMeta): + class mesh_interfaces(TUIMenu): """ - Enter the view manipulation menu. + Enters the mesh-interfaces menu. """ def __init__(self, path, service): self.path = path self.service = service - self.camera = self.__class__.camera(path + [("camera", None)], service) - def auto_scale(self, *args, **kwargs): + self.non_conformal_interface_numerics = self.__class__.non_conformal_interface_numerics(path + [("non_conformal_interface_numerics", None)], service) + self.mapped_interface_options = self.__class__.mapped_interface_options(path + [("mapped_interface_options", None)], service) + self.auto_options = self.__class__.auto_options(path + [("auto_options", None)], service) + super().__init__(path, service) + def create(self, *args, **kwargs): """ - Scale and center the current scene. + Creates mesh interfaces. """ - return PyMenu(self.service, "/display/views/auto_scale").execute(*args, **kwargs) - def default_view(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/create").execute(*args, **kwargs) + def turbo_create(self, *args, **kwargs): """ - Reset view to front and center. + Creates a general turbo interface. This text command is only available if the define/turbo-model/enable-turbo-model? text command is enabled. """ - return PyMenu(self.service, "/display/views/default_view").execute(*args, **kwargs) - def delete_view(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/turbo_create").execute(*args, **kwargs) + def edit(self, *args, **kwargs): """ - Remove a view from the list. + Edits attributes of existing mesh interfaces. For one-to-one interfaces, you can edit the name; for many-to-many interfaces, you can edit the interface options and (for a single interface) the name and the list of interface zones assigned to the interface. """ - return PyMenu(self.service, "/display/views/delete_view").execute(*args, **kwargs) - def last_view(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): """ - Return to the camera position before the last manipulation. + Deletes a mesh interface. """ - return PyMenu(self.service, "/display/views/last_view").execute(*args, **kwargs) - def next_view(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/delete").execute(*args, **kwargs) + def display(self, *args, **kwargs): """ - Return to the camera position after the current position in the stack. + Displays the specified mesh interface zone. """ - return PyMenu(self.service, "/display/views/next_view").execute(*args, **kwargs) - def list_views(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/display").execute(*args, **kwargs) + def list(self, *args, **kwargs): """ - List predefined and saved views. + Lists all mesh interfaces. """ - return PyMenu(self.service, "/display/views/list_views").execute(*args, **kwargs) - def restore_view(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/list").execute(*args, **kwargs) + def make_periodic(self, *args, **kwargs): """ - Use a saved view. + Make interface zones periodic. """ - return PyMenu(self.service, "/display/views/restore_view").execute(*args, **kwargs) - def read_views(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/make_periodic").execute(*args, **kwargs) + def make_phaselag_from_boundaries(self, *args, **kwargs): """ - Read views from a view file. + Make interface zones phase lagged. """ - return PyMenu(self.service, "/display/views/read_views").execute(*args, **kwargs) - def save_view(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/make_phaselag_from_boundaries").execute(*args, **kwargs) + def make_phaselag_from_periodic(self, *args, **kwargs): """ - Save the current view to the view list. + Convert periodic interface to phase lagged. """ - return PyMenu(self.service, "/display/views/save_view").execute(*args, **kwargs) - def write_views(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/make_phaselag_from_periodic").execute(*args, **kwargs) + def delete_all(self, *args, **kwargs): """ - Write selected views to a view file. + Deletes all mesh interfaces. """ - return PyMenu(self.service, "/display/views/write_views").execute(*args, **kwargs) + return PyMenu(self.service, "/define/mesh_interfaces/delete_all").execute(*args, **kwargs) + def enforce_continuity_after_bc(self, *args, **kwargs): + """ + Enables/disables continuity across the boundary condition interface for contour plots in postprocessing. + """ + return PyMenu(self.service, "/define/mesh_interfaces/enforce_continuity_after_bc").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Sets the mesh interface verbosity. + """ + return PyMenu(self.service, "/define/mesh_interfaces/verbosity").execute(*args, **kwargs) + def enable_si_with_nodes(self, *args, **kwargs): + """ + Enable sliding interfaces with nodes. + """ + return PyMenu(self.service, "/define/mesh_interfaces/enable_si_with_nodes").execute(*args, **kwargs) + def enforce_coupled_wall_between_solids(self, *args, **kwargs): + """ + Enables/disables automatic definition of solid-solid interfaces as coupled walls. By default this option is disabled and ANSYS Fluent creates interior boundaries at solid-solid interfaces. + """ + return PyMenu(self.service, "/define/mesh_interfaces/enforce_coupled_wall_between_solids").execute(*args, **kwargs) + def improve_quality(self, *args, **kwargs): + """ + Checks the quality of all mapped interfaces. If Fluent finds any mapped interfaces that require improvement it will list them and ask you if you would like to increase the tolerance to improve the interfaces. + """ + return PyMenu(self.service, "/define/mesh_interfaces/improve_quality").execute(*args, **kwargs) + def one_to_one_pairing(self, *args, **kwargs): + """ + Use the default one-to-one interface creation method?. + """ + return PyMenu(self.service, "/define/mesh_interfaces/one_to_one_pairing").execute(*args, **kwargs) + def auto_pairing(self, *args, **kwargs): + """ + Automatically "pairs" some or all of the interface zones, in order to create mesh interfaces. This text command is only available when the define/mesh-interfaces/one-to-one-pairing? text command is disabled. + """ + return PyMenu(self.service, "/define/mesh_interfaces/auto_pairing").execute(*args, **kwargs) + def enable_visualization_of_interfaces(self, *args, **kwargs): + """ + Enables/disables the filling of node coordinates on the zones of mesh interfaces, so that they can be displayed in the graphics window. + """ + return PyMenu(self.service, "/define/mesh_interfaces/enable_visualization_of_interfaces").execute(*args, **kwargs) + def transfer_motion_across_interfaces(self, *args, **kwargs): + """ + Enables/disables the automatic transfer of motion across a mesh interface when only one side is moving as a result of user-defined or system coupling motion. You can specify the method by which the motion is transferred: transfer-displacements (the default) interpolates nodal displacement from the active side of the interface to the passive side, and is recommended when there are gaps and/or penetrations in the mesh interface that must be maintained; project-nodes projects the passive nodes onto the faces of active side, and is recommended when the active side includes significant tangential motion (as only the normal displacement is effectively transferred in this method). + """ + return PyMenu(self.service, "/define/mesh_interfaces/transfer_motion_across_interfaces").execute(*args, **kwargs) + def non_overlapping_zone_name(self, *args, **kwargs): + """ + Get non-overlapping zone name from the associated interface zone. + """ + return PyMenu(self.service, "/define/mesh_interfaces/non_overlapping_zone_name").execute(*args, **kwargs) + def remove_left_handed_interface_faces(self, *args, **kwargs): + """ + Removes left-handed faces (which can cause the mesh to be invalid) during mesh interface creation. + """ + return PyMenu(self.service, "/define/mesh_interfaces/remove_left_handed_interface_faces").execute(*args, **kwargs) - class camera(metaclass=PyMenuMeta): + class non_conformal_interface_numerics(TUIMenu): """ - Enter the camera menu to modify the current viewing parameters. + Setting non-conformal numerics options. """ def __init__(self, path, service): self.path = path self.service = service - def dolly_camera(self, *args, **kwargs): + super().__init__(path, service) + def change_numerics(self, *args, **kwargs): """ - Adjust the camera position and target. + Enable modified non-conformal interface numerics. """ - return PyMenu(self.service, "/display/views/camera/dolly_camera").execute(*args, **kwargs) - def field(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/non_conformal_interface_numerics/change_numerics").execute(*args, **kwargs) + + class mapped_interface_options(TUIMenu): + """ + Enter the mapped-interface-options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def solution_controls(self, *args, **kwargs): """ - Set the field of view (width and height). + Specification of mapped frequency and under-relaxation factor for mapped interfaces. """ - return PyMenu(self.service, "/display/views/camera/field").execute(*args, **kwargs) - def orbit_camera(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/mapped_interface_options/solution_controls").execute(*args, **kwargs) + def tolerance(self, *args, **kwargs): """ - Adjust the camera position without modifying the target. + Specification of mapped interface tolerance. """ - return PyMenu(self.service, "/display/views/camera/orbit_camera").execute(*args, **kwargs) - def pan_camera(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/mapped_interface_options/tolerance").execute(*args, **kwargs) + def convert_to_mapped_interface(self, *args, **kwargs): """ - Adjust the camera target without modifying the position. + Convert non-conformal mesh interface to mapped mesh interfaces. """ - return PyMenu(self.service, "/display/views/camera/pan_camera").execute(*args, **kwargs) - def position(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/mapped_interface_options/convert_to_mapped_interface").execute(*args, **kwargs) + + class auto_options(TUIMenu): + """ + Enters the auto-options menu. This menu is only available when the define/mesh-interfaces/one-to-one-pairing? text command is enabled. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def proximity_tolerance(self, *args, **kwargs): """ - Set the camera position. + Sets the tolerance used as part of the automatic grouping of zones to create mesh interfaces when the define/mesh-interfaces/one-to-one-pairing? text command is disabled. The proximity tolerance is defined relative to the edge lengths in the interface zones, and can range from 0 to 1 (representing the minimum and maximum edge lengths, respectively). """ - return PyMenu(self.service, "/display/views/camera/position").execute(*args, **kwargs) - def projection(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/auto_options/proximity_tolerance").execute(*args, **kwargs) + def naming_option(self, *args, **kwargs): """ - Set the camera projection type. + Specifies whether the name of each new one-to-one mesh interface (as well as existing mesh interfaces, if you so desire) has no additional suffix, or a suffix that includes the names of the associated boundary zones, the IDs of the associated boundary zones, or the names of the adjacent cell zones. """ - return PyMenu(self.service, "/display/views/camera/projection").execute(*args, **kwargs) - def roll_camera(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/auto_options/naming_option").execute(*args, **kwargs) + def set_default_name_prefix(self, *args, **kwargs): """ - Adjust the camera up-vector. + Specifies the default interface name prefix used for one-to-one mesh interfaces. """ - return PyMenu(self.service, "/display/views/camera/roll_camera").execute(*args, **kwargs) - def target(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/auto_options/set_default_name_prefix").execute(*args, **kwargs) + def set_one_to_one_pairing_tolerance(self, *args, **kwargs): """ - Set the point to be the center of the camera view. + Enables/disables the use of adjustable tolerances to determine which of the selected boundary zones can be paired up to make the mesh interfaces, in order to account for gaps, thin layers, and/or complex geometries. """ - return PyMenu(self.service, "/display/views/camera/target").execute(*args, **kwargs) - def up_vector(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/auto_options/set_one_to_one_pairing_tolerance").execute(*args, **kwargs) + def pairing_between_different_cell_zones_only(self, *args, **kwargs): """ - Set the camera up-vector. + Specifies whether the one-to-one mesh interfaces are only created between different cell zones. """ - return PyMenu(self.service, "/display/views/camera/up_vector").execute(*args, **kwargs) - def zoom_camera(self, *args, **kwargs): + return PyMenu(self.service, "/define/mesh_interfaces/auto_options/pairing_between_different_cell_zones_only").execute(*args, **kwargs) + def pairing_between_interface_zones_only(self, *args, **kwargs): """ - Adjust the camera field of view. + Pairing between interface zones only. """ - return PyMenu(self.service, "/display/views/camera/zoom_camera").execute(*args, **kwargs) + return PyMenu(self.service, "/define/mesh_interfaces/auto_options/pairing_between_interface_zones_only").execute(*args, **kwargs) + def keep_empty_interface(self, *args, **kwargs): + """ + Keep empty interfaces during one-to-one mesh interface creation. + """ + return PyMenu(self.service, "/define/mesh_interfaces/auto_options/keep_empty_interface").execute(*args, **kwargs) - class display_states(metaclass=PyMenuMeta): + class gap_model(TUIMenu): """ - Enter the display state manipulation menu. + Enters the gap model menu, where you can define one or more gap regions where the flow is blocked or decelerated when face zones move within a specified proximity threshold of each other. """ def __init__(self, path, service): self.path = path self.service = service - def list(self, *args, **kwargs): + self.advanced_options = self.__class__.advanced_options(path + [("advanced_options", None)], service) + super().__init__(path, service) + def enable(self, *args, **kwargs): """ - Print the names of the available display states to the console. + Enables/disables the gap model. """ - return PyMenu(self.service, "/display/display_states/list").execute(*args, **kwargs) - def apply(self, *args, **kwargs): + return PyMenu(self.service, "/define/gap_model/enable").execute(*args, **kwargs) + def create(self, *args, **kwargs): """ - Apply a display state to the active window. + Creates a single gap region, so that when selected face zones move within a specified proximity threshold of each other, flow blockage / deceleration is applied to the cells that lie within the threshold. """ - return PyMenu(self.service, "/display/display_states/apply").execute(*args, **kwargs) - def delete(self, *args, **kwargs): + return PyMenu(self.service, "/define/gap_model/create").execute(*args, **kwargs) + def edit(self, *args, **kwargs): """ - Delete a display state. + Edits an existing gap region. """ - return PyMenu(self.service, "/display/display_states/delete").execute(*args, **kwargs) - def use_active(self, *args, **kwargs): + return PyMenu(self.service, "/define/gap_model/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): """ - Update an existing display state's settings to match those of the active graphics window. + Deletes an existing gap region. """ - return PyMenu(self.service, "/display/display_states/use_active").execute(*args, **kwargs) - def copy(self, *args, **kwargs): + return PyMenu(self.service, "/define/gap_model/delete").execute(*args, **kwargs) + def delete_all(self, *args, **kwargs): """ - Create a new display state with settings copied from an existing display state. + Deletes all of the existing gap regions. """ - return PyMenu(self.service, "/display/display_states/copy").execute(*args, **kwargs) - def read(self, *args, **kwargs): + return PyMenu(self.service, "/define/gap_model/delete_all").execute(*args, **kwargs) + def list_gap_regions(self, *args, **kwargs): """ - Read display states from a file. + Lists the properties of the gap regions. """ - return PyMenu(self.service, "/display/display_states/read").execute(*args, **kwargs) - def write(self, *args, **kwargs): + return PyMenu(self.service, "/define/gap_model/list_gap_regions").execute(*args, **kwargs) + def list_gap_face_zones(self, *args, **kwargs): """ - Write display states to a file. + Lists the names of the face zones that can be used for creating gap regions. """ - return PyMenu(self.service, "/display/display_states/write").execute(*args, **kwargs) - def edit(self, *args, **kwargs): + return PyMenu(self.service, "/define/gap_model/list_gap_face_zones").execute(*args, **kwargs) + def list_gap_cell_zones(self, *args, **kwargs): """ - Edit a particular display state setting. + Lists the names of the cell zones that can be excluded for individual gap regions (so that such cells are not marked for flow blockage / deceleration). """ - return PyMenu(self.service, "/display/display_states/edit").execute(*args, **kwargs) - def create(self, *args, **kwargs): + return PyMenu(self.service, "/define/gap_model/list_gap_cell_zones").execute(*args, **kwargs) + def render_gap_regions(self, *args, **kwargs): """ - Create a new display state. + Update gap regions for postprocessing. """ - return PyMenu(self.service, "/display/display_states/create").execute(*args, **kwargs) + return PyMenu(self.service, "/define/gap_model/render_gap_regions").execute(*args, **kwargs) + + class advanced_options(TUIMenu): + """ + Enters the advanced options menu for the gap model. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def expert(self, *args, **kwargs): + """ + Enables/disables access to expert-level text commands for the gap model. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/expert").execute(*args, **kwargs) + def alternative_marking(self, *args, **kwargs): + """ + Mark gap regions using an alternative marking algorithm. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/alternative_marking").execute(*args, **kwargs) + def cell_check_distance_factor(self, *args, **kwargs): + """ + Enter value of the cell distance factor. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/cell_check_distance_factor").execute(*args, **kwargs) + def flow_blocking_stabilization_parameters(self, *args, **kwargs): + """ + Adjust stabilization settings for the sponge layer used for blocked gap regions. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/flow_blocking_stabilization_parameters").execute(*args, **kwargs) + def update_gap_regions(self, *args, **kwargs): + """ + Update gap regions and gap model solution information. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/update_gap_regions").execute(*args, **kwargs) + def clear_gap_regions(self, *args, **kwargs): + """ + Clear gap model solution information and marks. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/clear_gap_regions").execute(*args, **kwargs) + def precise_gap_marking(self, *args, **kwargs): + """ + Enables/disables the use of a more accurate search algorithm for marking cells in gap regions. Note that it can be costly, particularly for 3D cases or those with a large number of cells inside the gap regions. This text command is only available if you have enabled the define/gap-model/advanced-options/expert? text command. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/precise_gap_marking").execute(*args, **kwargs) + def render_flow_modeling_gaps(self, *args, **kwargs): + """ + Enables/disables the rendering of the solution in the cells of flow-modeling gap regions during postprocessing. This text command is only available if you have enabled the define/gap-model/advanced-options/expert? text command. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/render_flow_modeling_gaps").execute(*args, **kwargs) + def reduce_gap_regions(self, *args, **kwargs): + """ + Enables/disables a more restrictive algorithm for marking cells in gap regions. This text command is only available if you have enabled the define/gap-model/advanced-options/expert? text command. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/reduce_gap_regions").execute(*args, **kwargs) + def fill_data_in_gap_regions(self, *args, **kwargs): + """ + Enables/disables the interpolation of solution data throughout the gap regions. This text command is only available if you have enabled the define/gap-model/advanced-options/expert? text command. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/fill_data_in_gap_regions").execute(*args, **kwargs) + def enhanced_data_interpolation(self, *args, **kwargs): + """ + Enables/disables the use of enhanced data interpolation when updating information in gap regions. This text command is only available if you have enabled the define/gap-model/advanced-options/expert? text command. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/enhanced_data_interpolation").execute(*args, **kwargs) + def sponge_layer(self, *args, **kwargs): + """ + Allows you to edit the solution stabilization settings for flow-modeling gap regions that have sponge-layer local stabilization enabled. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/sponge_layer").execute(*args, **kwargs) + def solution_stabilization(self, *args, **kwargs): + """ + Sets the global solution stabilization level for the gap regions. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/solution_stabilization").execute(*args, **kwargs) + def include_coupled_walls(self, *args, **kwargs): + """ + Include coupled walls in gap face zones. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/include_coupled_walls").execute(*args, **kwargs) + def check_cfl_condition(self, *args, **kwargs): + """ + Enables/disables the printing of warnings if the time step size is too large based on a Courant (CFL) number automatically determined for your specified solution stability level. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/check_cfl_condition").execute(*args, **kwargs) + def extend_gap_regions(self, *args, **kwargs): + """ + Enables/disables the extending of the gap regions by including additional cells in the vicinity of the gap interfaces during marking. This is useful when the default shape of the marked cells is negatively affecting solution stability or convergence behavior. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/extend_gap_regions").execute(*args, **kwargs) + def revert_controls_to_default(self, *args, **kwargs): + """ + Reverts the global gap stabilization level and any related solver settings to the default. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/revert_controls_to_default").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Sets the verbosity for messages printed in the console related to the gap model. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/verbosity").execute(*args, **kwargs) + def render_gap_interface(self, *args, **kwargs): + """ + Enables/disables the rendering of the mesh surfaces inside the gap regions when displaying the mesh with contours. Note that the solution is still not rendered inside the flow-blocking gap regions. + """ + return PyMenu(self.service, "/define/gap_model/advanced_options/render_gap_interface").execute(*args, **kwargs) - class view_sync(metaclass=PyMenuMeta): + class materials(TUIMenu): """ - Synchronize window views. + Enters the materials menu. """ def __init__(self, path, service): self.path = path self.service = service - def list(self, *args, **kwargs): + self.data_base = self.__class__.data_base(path + [("data_base", None)], service) + super().__init__(path, service) + def change_create(self, *args, **kwargs): """ - Print window ids of open windows. + Changes the properties of a locally-stored material or create a new material. Generally, the properties you enter at the prompts will be filtered according to your case and model settings. However, some of the listed properties may not match the selection choice in the Graphics User Interface. Typically, those excessive properties in the Text User Interface will not be used in your simulation. """ - return PyMenu(self.service, "/display/view_sync/list").execute(*args, **kwargs) - def start(self, *args, **kwargs): + return PyMenu(self.service, "/define/materials/change_create").execute(*args, **kwargs) + def copy(self, *args, **kwargs): """ - Start view synchronization. + Copies a material from the database. """ - return PyMenu(self.service, "/display/view_sync/start").execute(*args, **kwargs) - def stop(self, *args, **kwargs): + return PyMenu(self.service, "/define/materials/copy").execute(*args, **kwargs) + def copy_by_formula(self, *args, **kwargs): """ - Stop view synchronization. + Copies a material from the database by formula. """ - return PyMenu(self.service, "/display/view_sync/stop").execute(*args, **kwargs) - def remove_all(self, *args, **kwargs): + return PyMenu(self.service, "/define/materials/copy_by_formula").execute(*args, **kwargs) + def delete(self, *args, **kwargs): """ - Unsynchronize all windows. + Deletes a material from local storage. """ - return PyMenu(self.service, "/display/view_sync/remove_all").execute(*args, **kwargs) - def add_all(self, *args, **kwargs): + return PyMenu(self.service, "/define/materials/delete").execute(*args, **kwargs) + def list_materials(self, *args, **kwargs): """ - Synchronize all windows. + Lists all locally-stored materials. """ - return PyMenu(self.service, "/display/view_sync/add_all").execute(*args, **kwargs) - def add(self, *args, **kwargs): + return PyMenu(self.service, "/define/materials/list_materials").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): """ - Add list of window ids for synchronization. + Lists the properties of a locally-stored material. """ - return PyMenu(self.service, "/display/view_sync/add").execute(*args, **kwargs) - def remove(self, *args, **kwargs): + return PyMenu(self.service, "/define/materials/list_properties").execute(*args, **kwargs) + + class data_base(TUIMenu): """ - Remove list of window ids from synchronization. + Enters the material database menu. """ - return PyMenu(self.service, "/display/view_sync/remove").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def database_type(self, *args, **kwargs): + """ + Sets the database type (fluent-database, granta-mds, or user-defined). + """ + return PyMenu(self.service, "/define/materials/data_base/database_type").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edits material. + """ + return PyMenu(self.service, "/define/materials/data_base/edit").execute(*args, **kwargs) + def list_materials(self, *args, **kwargs): + """ + Lists all materials in the database. + """ + return PyMenu(self.service, "/define/materials/data_base/list_materials").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + Lists the properties of a material in the database. + """ + return PyMenu(self.service, "/define/materials/data_base/list_properties").execute(*args, **kwargs) + def new(self, *args, **kwargs): + """ + Defines new material. + """ + return PyMenu(self.service, "/define/materials/data_base/new").execute(*args, **kwargs) + def save(self, *args, **kwargs): + """ + Saves user-defined database. + """ + return PyMenu(self.service, "/define/materials/data_base/save").execute(*args, **kwargs) - class update_scene(metaclass=PyMenuMeta): + class mixing_planes(TUIMenu): """ - Enter the scene options menu. + Enters the mixing planes menu. """ def __init__(self, path, service): self.path = path self.service = service - def select_geometry(self, *args, **kwargs): - """ - Select geometry to be updated. - """ - return PyMenu(self.service, "/display/update_scene/select_geometry").execute(*args, **kwargs) - def overlays(self, *args, **kwargs): - """ - Enable/disable the overlays option. - """ - return PyMenu(self.service, "/display/update_scene/overlays").execute(*args, **kwargs) - def draw_frame(self, *args, **kwargs): + self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) + def create(self, *args, **kwargs): """ - Enable/disable drawing of the bounding frame. + Creates a mixing plane. """ - return PyMenu(self.service, "/display/update_scene/draw_frame").execute(*args, **kwargs) + return PyMenu(self.service, "/define/mixing_planes/create").execute(*args, **kwargs) def delete(self, *args, **kwargs): """ - Delete selected geometries. - """ - return PyMenu(self.service, "/display/update_scene/delete").execute(*args, **kwargs) - def display(self, *args, **kwargs): - """ - Display selected geometries. - """ - return PyMenu(self.service, "/display/update_scene/display").execute(*args, **kwargs) - def transform(self, *args, **kwargs): - """ - Apply transformation matrix on selected geometries. - """ - return PyMenu(self.service, "/display/update_scene/transform").execute(*args, **kwargs) - def pathline(self, *args, **kwargs): - """ - Change pathline attributes. - """ - return PyMenu(self.service, "/display/update_scene/pathline").execute(*args, **kwargs) - def iso_sweep(self, *args, **kwargs): - """ - Change iso-sweep values. - """ - return PyMenu(self.service, "/display/update_scene/iso_sweep").execute(*args, **kwargs) - def time(self, *args, **kwargs): - """ - Change time-step value. + Deletes a mixing plane. """ - return PyMenu(self.service, "/display/update_scene/time").execute(*args, **kwargs) - def set_frame(self, *args, **kwargs): + return PyMenu(self.service, "/define/mixing_planes/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): """ - Change frame options. + Lists defined mixing plane(s). """ - return PyMenu(self.service, "/display/update_scene/set_frame").execute(*args, **kwargs) + return PyMenu(self.service, "/define/mixing_planes/list").execute(*args, **kwargs) - class inverse_dft(metaclass=PyMenuMeta): - """ - Reconstruct DFT signal. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def set(self, *args, **kwargs): - """ - Set reconstruction parameters. - """ - return PyMenu(self.service, "/display/inverse_dft/set").execute(*args, **kwargs) - def reconstruct(self, *args, **kwargs): + class set(TUIMenu): """ - Make inverse DFT recontruction. + Sets global parameters relevant to mixing planes. """ - return PyMenu(self.service, "/display/inverse_dft/reconstruct").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + self.conserve_swirl = self.__class__.conserve_swirl(path + [("conserve_swirl", None)], service) + self.conserve_total_enthalpy = self.__class__.conserve_total_enthalpy(path + [("conserve_total_enthalpy", None)], service) + super().__init__(path, service) + def under_relaxation(self, *args, **kwargs): + """ + Sets mixing plane under-relaxation factor. + """ + return PyMenu(self.service, "/define/mixing_planes/set/under_relaxation").execute(*args, **kwargs) + def averaging_method(self, *args, **kwargs): + """ + Sets the mixing plane profile averaging method. + """ + return PyMenu(self.service, "/define/mixing_planes/set/averaging_method").execute(*args, **kwargs) + def fix_pressure_level(self, *args, **kwargs): + """ + Sets fixed pressure level using value based on define/reference-pressure-location. + """ + return PyMenu(self.service, "/define/mixing_planes/set/fix_pressure_level").execute(*args, **kwargs) - class define(metaclass=PyMenuMeta): - """ - Enter the define menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.boundary_conditions = self.__class__.boundary_conditions(path + [("boundary_conditions", None)], service) - self.spectral = self.__class__.spectral(path + [("spectral", None)], service) - self.custom_field_functions = self.__class__.custom_field_functions(path + [("custom_field_functions", None)], service) - self.dynamic_mesh = self.__class__.dynamic_mesh(path + [("dynamic_mesh", None)], service) - self.mesh_interfaces = self.__class__.mesh_interfaces(path + [("mesh_interfaces", None)], service) - self.gap_model = self.__class__.gap_model(path + [("gap_model", None)], service) - self.materials = self.__class__.materials(path + [("materials", None)], service) - self.mixing_planes = self.__class__.mixing_planes(path + [("mixing_planes", None)], service) - self.models = self.__class__.models(path + [("models", None)], service) - self.overset_interfaces = self.__class__.overset_interfaces(path + [("overset_interfaces", None)], service) - self.operating_conditions = self.__class__.operating_conditions(path + [("operating_conditions", None)], service) - self.parameters = self.__class__.parameters(path + [("parameters", None)], service) - self.periodic_conditions = self.__class__.periodic_conditions(path + [("periodic_conditions", None)], service) - self.turbo_model = self.__class__.turbo_model(path + [("turbo_model", None)], service) - self.phases = self.__class__.phases(path + [("phases", None)], service) - self.profiles = self.__class__.profiles(path + [("profiles", None)], service) - self.solution_strategy = self.__class__.solution_strategy(path + [("solution_strategy", None)], service) - self.reference_frames = self.__class__.reference_frames(path + [("reference_frames", None)], service) - self.user_defined = self.__class__.user_defined(path + [("user_defined", None)], service) - self.named_expressions = self.__class__.named_expressions(path + [("named_expressions", None)], service) - self.virtual_boundary = self.__class__.virtual_boundary(path + [("virtual_boundary", None)], service) - self.curvilinear_coordinate_system = self.__class__.curvilinear_coordinate_system(path + [("curvilinear_coordinate_system", None)], service) - def beta_feature_access(self, *args, **kwargs): - """ - Enable access to beta features in the interface. - """ - return PyMenu(self.service, "/define/beta_feature_access").execute(*args, **kwargs) - def physics(self, *args, **kwargs): - """ - Manage Physics-regions. - """ - return PyMenu(self.service, "/define/physics").execute(*args, **kwargs) - def injections(self, *args, **kwargs): - """ - Enters the injections menu. For a description of the items in this menu, see define/models/dpm/injections. - """ - return PyMenu(self.service, "/define/injections").execute(*args, **kwargs) - def enable_mesh_morpher_optimizer(self, *args, **kwargs): - """ - Enables the mesh morpher/optimizer. When the mesh morpher/optimizer is enabled, the define/mesh-morpher-optimizer text command becomes available. - """ - return PyMenu(self.service, "/define/enable_mesh_morpher_optimizer").execute(*args, **kwargs) - def units(self, *args, **kwargs): - """ - Sets unit conversion factors. - """ - return PyMenu(self.service, "/define/units").execute(*args, **kwargs) - def set_unit_system(self, *args, **kwargs): - """ - Applies a standard set of units to all quantities. The options include default,si, british, andcgs. - """ - return PyMenu(self.service, "/define/set_unit_system").execute(*args, **kwargs) + class conserve_swirl(TUIMenu): + """ + Enters the menu to set swirl conservation in mixing plane menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable(self, *args, **kwargs): + """ + Enables/disables swirl conservation in mixing plane. + """ + return PyMenu(self.service, "/define/mixing_planes/set/conserve_swirl/enable").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Enables/disables verbosity in swirl conservation calculations. + """ + return PyMenu(self.service, "/define/mixing_planes/set/conserve_swirl/verbosity").execute(*args, **kwargs) + def report_swirl_integration(self, *args, **kwargs): + """ + Reports swirl integration (Torque) on inflow and outflow zones. + """ + return PyMenu(self.service, "/define/mixing_planes/set/conserve_swirl/report_swirl_integration").execute(*args, **kwargs) + + class conserve_total_enthalpy(TUIMenu): + """ + Enters the menu to set total enthalpy conservation in mixing plane menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable(self, *args, **kwargs): + """ + Enables/disables total enthalpy conservation in mixing plane. + """ + return PyMenu(self.service, "/define/mixing_planes/set/conserve_total_enthalpy/enable").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Enables/disables verbosity in total-enthalpy conservation calculations. + """ + return PyMenu(self.service, "/define/mixing_planes/set/conserve_total_enthalpy/verbosity").execute(*args, **kwargs) - class boundary_conditions(metaclass=PyMenuMeta): + class models(TUIMenu): """ - Enters the boundary conditions menu. + Enters the models menu to configure the solver. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.mass_flow_inlet = self.__class__.mass_flow_inlet(path + [("mass_flow_inlet", None)], None, service) - self.modify_zones = self.__class__.modify_zones(path + [("modify_zones", None)], service) - self.periodic = self.__class__.periodic(path + [("periodic", None)], None, service) - self.pressure_far_field = self.__class__.pressure_far_field(path + [("pressure_far_field", None)], None, service) - self.pressure_inlet = self.__class__.pressure_inlet(path + [("pressure_inlet", None)], None, service) - self.pressure_outlet = self.__class__.pressure_outlet(path + [("pressure_outlet", None)], None, service) - self.symmetry = self.__class__.symmetry(path + [("symmetry", None)], None, service) - self.velocity_inlet = self.__class__.velocity_inlet(path + [("velocity_inlet", None)], None, service) - self.wall = self.__class__.wall(path + [("wall", None)], None, service) - self.non_reflecting_bc = self.__class__.non_reflecting_bc(path + [("non_reflecting_bc", None)], service) - self.rename_zone = self.__class__.rename_zone(path + [("rename_zone", None)], service) - self.bc_settings = self.__class__.bc_settings(path + [("bc_settings", None)], service) - self.perforated_walls = self.__class__.perforated_walls(path + [("perforated_walls", None)], service) - self.set = self.__class__.set(path + [("set", None)], service) - self.impedance_data_fitting = self.__class__.impedance_data_fitting(path + [("impedance_data_fitting", None)], service) - def axis(self, *args, **kwargs): + self.acoustics = self.__class__.acoustics(path + [("acoustics", None)], service) + self.optics = self.__class__.optics(path + [("optics", None)], service) + self.eulerian_wallfilm = self.__class__.eulerian_wallfilm(path + [("eulerian_wallfilm", None)], service) + self.dpm = self.__class__.dpm(path + [("dpm", None)], service) + self.shell_conduction = self.__class__.shell_conduction(path + [("shell_conduction", None)], service) + self.system_coupling_settings = self.__class__.system_coupling_settings(path + [("system_coupling_settings", None)], service) + self.cht = self.__class__.cht(path + [("cht", None)], service) + self.two_temperature = self.__class__.two_temperature(path + [("two_temperature", None)], service) + self.multiphase = self.__class__.multiphase(path + [("multiphase", None)], service) + self.nox_parameters = self.__class__.nox_parameters(path + [("nox_parameters", None)], service) + self.soot_parameters = self.__class__.soot_parameters(path + [("soot_parameters", None)], service) + self.radiation = self.__class__.radiation(path + [("radiation", None)], service) + self.solver = self.__class__.solver(path + [("solver", None)], service) + self.species = self.__class__.species(path + [("species", None)], service) + self.viscous = self.__class__.viscous(path + [("viscous", None)], service) + self.structure = self.__class__.structure(path + [("structure", None)], service) + self.heat_exchanger = self.__class__.heat_exchanger(path + [("heat_exchanger", None)], service) + self.electrolysis_setup = self.__class__.electrolysis_setup(path + [("electrolysis_setup", None)], service) + super().__init__(path, service) + def addon_module(self, *args, **kwargs): """ - Sets boundary conditions for a zone of this type. + Loads addon module. """ - return PyMenu(self.service, "/define/boundary_conditions/axis").execute(*args, **kwargs) - def copy_bc(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/addon_module").execute(*args, **kwargs) + def axisymmetric(self, *args, **kwargs): """ - Copies boundary conditions to other zones. + Specifies whether or not the domain is axisymmetric. """ - return PyMenu(self.service, "/define/boundary_conditions/copy_bc").execute(*args, **kwargs) - def degassing(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/axisymmetric").execute(*args, **kwargs) + def solidification_melting(self, *args, **kwargs): """ - Sets boundary conditions for a zone of this type. + Enables/disables the solidification and melting model. """ - return PyMenu(self.service, "/define/boundary_conditions/degassing").execute(*args, **kwargs) - def exhaust_fan(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/solidification_melting").execute(*args, **kwargs) + def crevice_model(self, *args, **kwargs): """ - Sets boundary conditions for a zone of this type. + Enables/disables the crevice model. """ - return PyMenu(self.service, "/define/boundary_conditions/exhaust_fan").execute(*args, **kwargs) - def fan(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/crevice_model").execute(*args, **kwargs) + def crevice_model_controls(self, *args, **kwargs): """ - Sets boundary conditions for a zone of this type. + Enters the crevice model controls menu. """ - return PyMenu(self.service, "/define/boundary_conditions/fan").execute(*args, **kwargs) - def fluid(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/crevice_model_controls").execute(*args, **kwargs) + def energy(self, *args, **kwargs): """ - Sets boundary conditions for a zone of this type. + Enables/disables the energy model. """ - return PyMenu(self.service, "/define/boundary_conditions/fluid").execute(*args, **kwargs) - def geometry(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/energy").execute(*args, **kwargs) + def noniterative_time_advance(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Enables/disables noniterative time advancement scheme. """ - return PyMenu(self.service, "/define/boundary_conditions/geometry").execute(*args, **kwargs) - def inlet_vent(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/noniterative_time_advance").execute(*args, **kwargs) + def nox(self, *args, **kwargs): """ - Sets boundary conditions for a zone of this type. + Enables/disables the NOx model. """ - return PyMenu(self.service, "/define/boundary_conditions/inlet_vent").execute(*args, **kwargs) - def intake_fan(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/nox").execute(*args, **kwargs) + def soot(self, *args, **kwargs): """ - Sets boundary conditions for a zone of this type. + Enables/disables the soot model. """ - return PyMenu(self.service, "/define/boundary_conditions/intake_fan").execute(*args, **kwargs) - def interface(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/soot").execute(*args, **kwargs) + def steady(self, *args, **kwargs): """ - Sets boundary conditions for a zone of this type. + Enables/disables the steady solution model. """ - return PyMenu(self.service, "/define/boundary_conditions/interface").execute(*args, **kwargs) - def interior(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/steady").execute(*args, **kwargs) + def swirl(self, *args, **kwargs): """ - Sets boundary conditions for a zone of this type. + Enables/disables axisymmetric swirl velocity. """ - return PyMenu(self.service, "/define/boundary_conditions/interior").execute(*args, **kwargs) - def list_zones(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/swirl").execute(*args, **kwargs) + def unsteady_1st_order(self, *args, **kwargs): """ - Prints out the types and IDs of all zones in the console window. You can use your mouse to check a zone ID, following the instructions listed under Zone in the - Boundary Conditions Task Page - section of the User’s Guide. + Selects the first-order implicit formulation for transient simulations. """ - return PyMenu(self.service, "/define/boundary_conditions/list_zones").execute(*args, **kwargs) - def mass_flow_outlet(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/unsteady_1st_order").execute(*args, **kwargs) + def frozen_flux(self, *args, **kwargs): """ - Sets boundary conditions for a zone of this type. + Enables/disables frozen flux formulation for transient flows. """ - return PyMenu(self.service, "/define/boundary_conditions/mass_flow_outlet").execute(*args, **kwargs) - def network(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/frozen_flux").execute(*args, **kwargs) + def unsteady_2nd_order(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Selects the second-order implicit formulation for transient simulations. """ - return PyMenu(self.service, "/define/boundary_conditions/network").execute(*args, **kwargs) - def network_end(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/unsteady_2nd_order").execute(*args, **kwargs) + def unsteady_2nd_order_bounded(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Selects the bounded second-order implicit formulation for transient simulations. """ - return PyMenu(self.service, "/define/boundary_conditions/network_end").execute(*args, **kwargs) - def openchannel_threads(self, *args, **kwargs): - """ - Lists open channel group IDs, names, types and variables. - """ - return PyMenu(self.service, "/define/boundary_conditions/openchannel_threads").execute(*args, **kwargs) - def open_channel_wave_settings(self, *args, **kwargs): - """ - Opens channel wave input analysis. - """ - return PyMenu(self.service, "/define/boundary_conditions/open_channel_wave_settings").execute(*args, **kwargs) - def outflow(self, *args, **kwargs): - """ - Sets boundary conditions for a zone of this type. - """ - return PyMenu(self.service, "/define/boundary_conditions/outflow").execute(*args, **kwargs) - def outlet_vent(self, *args, **kwargs): - """ - Sets boundary conditions for a zone of this type. - """ - return PyMenu(self.service, "/define/boundary_conditions/outlet_vent").execute(*args, **kwargs) - def overset(self, *args, **kwargs): - """ - Set boundary conditions for a zone of this type. - """ - return PyMenu(self.service, "/define/boundary_conditions/overset").execute(*args, **kwargs) - def porous_jump(self, *args, **kwargs): - """ - Sets boundary conditions for a zone of this type. - """ - return PyMenu(self.service, "/define/boundary_conditions/porous_jump").execute(*args, **kwargs) - def radiator(self, *args, **kwargs): - """ - Sets boundary conditions for a zone of this type. - """ - return PyMenu(self.service, "/define/boundary_conditions/radiator").execute(*args, **kwargs) - def rans_les_interface(self, *args, **kwargs): - """ - Sets boundary conditions for a zone of this type. - """ - return PyMenu(self.service, "/define/boundary_conditions/rans_les_interface").execute(*args, **kwargs) - def recirculation_inlet(self, *args, **kwargs): - """ - Sets boundary conditions for a zone of this type. - """ - return PyMenu(self.service, "/define/boundary_conditions/recirculation_inlet").execute(*args, **kwargs) - def recirculation_outlet(self, *args, **kwargs): - """ - Sets boundary conditions for a zone of this type. - """ - return PyMenu(self.service, "/define/boundary_conditions/recirculation_outlet").execute(*args, **kwargs) - def shadow(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/unsteady_2nd_order_bounded").execute(*args, **kwargs) + def unsteady_global_time(self, *args, **kwargs): """ - Sets boundary conditions for a zone of this type. + Selects the explicit transient formulation. This text command is only available for unsteady cases that use the density-based solver with the explicit formulation. """ - return PyMenu(self.service, "/define/boundary_conditions/shadow").execute(*args, **kwargs) - def solid(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/unsteady_global_time").execute(*args, **kwargs) + def unsteady_structure_newmark(self, *args, **kwargs): """ - Sets boundary conditions for a zone of this type. + Selects the Newmark method for the direct time integration of the finite element semi-discrete equation of motion. This text command is only available for transient simulations that use the structural model. """ - return PyMenu(self.service, "/define/boundary_conditions/solid").execute(*args, **kwargs) - def zone_name(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/unsteady_structure_newmark").execute(*args, **kwargs) + def unsteady_structure_euler(self, *args, **kwargs): """ - Gives a zone a new name. + Selects the backward Euler method for the direct time integration of the finite element semi-discrete equation of motion. This text command is only available for transient simulations that use the structural model. """ - return PyMenu(self.service, "/define/boundary_conditions/zone_name").execute(*args, **kwargs) - def zone_type(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/unsteady_structure_euler").execute(*args, **kwargs) + def battery_model(self, *args, **kwargs): """ - Sets the type for a zone or multiple zones of the same category. You will be prompted for the name / ID of the zone to be changed and the new type for that zone. To change multiple zones, you can enter a list (separated by spaces and contained within a pair of parentheses) or use asterisks (*) as wildcards. + Enables the dual potential MSMD battery model. For text commands that become available when the battery model is enabled, refer to Battery Model Text Commands + """ - return PyMenu(self.service, "/define/boundary_conditions/zone_type").execute(*args, **kwargs) - def target_mass_flow_rate_settings(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/battery_model").execute(*args, **kwargs) + def ablation(self, *args, **kwargs): """ - Enters the targeted mass flow rate settings menu. + Enables/disables the ablation model. """ - return PyMenu(self.service, "/define/boundary_conditions/target_mass_flow_rate_settings").execute(*args, **kwargs) - def non_overlapping_zone_name(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/ablation").execute(*args, **kwargs) + def potential_and_li_ion_battery(self, *args, **kwargs): """ - Displays the name of the non-overlapping zone associated with a specified interface zone. This text command is only available after a mesh interface has been created. + Enables/disables the electric-potential model. """ - return PyMenu(self.service, "/define/boundary_conditions/non_overlapping_zone_name").execute(*args, **kwargs) - def knudsen_number_calculator(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/potential_and_li_ion_battery").execute(*args, **kwargs) + + class acoustics(TUIMenu): """ - Computes the Knudsen number based on a characteristic physical length and the area-averaged flow quantities along an incoming-flow boundary. You can use this information to determine flow regime for selecting the appropriate wall boundary treatment. For details, see . + Enters the acoustics menu. """ - return PyMenu(self.service, "/define/boundary_conditions/knudsen_number_calculator").execute(*args, **kwargs) - - class mass_flow_inlet(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.flow_spec = self.__class__.flow_spec(path + [("flow_spec", None)], service) - self.mass_flow = self.__class__.mass_flow(path + [("mass_flow", None)], service) - self.ec_mass_flow = self.__class__.ec_mass_flow(path + [("ec_mass_flow", None)], service) - self.mass_flux = self.__class__.mass_flux(path + [("mass_flux", None)], service) - self.mass_flux_ave = self.__class__.mass_flux_ave(path + [("mass_flux_ave", None)], service) - self.tref = self.__class__.tref(path + [("tref", None)], service) - self.pref = self.__class__.pref(path + [("pref", None)], service) - self.p = self.__class__.p(path + [("p", None)], service) - self.direction_spec = self.__class__.direction_spec(path + [("direction_spec", None)], service) - self.impedance_0 = self.__class__.impedance_0(path + [("impedance_0", None)], service) - self.frame_of_reference = self.__class__.frame_of_reference(path + [("frame_of_reference", None)], service) - self.coordinate_system = self.__class__.coordinate_system(path + [("coordinate_system", None)], service) - self.ni = self.__class__.ni(path + [("ni", None)], service) - self.nj = self.__class__.nj(path + [("nj", None)], service) - self.nk = self.__class__.nk(path + [("nk", None)], service) - self.ni2 = self.__class__.ni2(path + [("ni2", None)], service) - self.nj2 = self.__class__.nj2(path + [("nj2", None)], service) - self.nk2 = self.__class__.nk2(path + [("nk2", None)], service) - self.ai = self.__class__.ai(path + [("ai", None)], service) - self.aj = self.__class__.aj(path + [("aj", None)], service) - self.ak = self.__class__.ak(path + [("ak", None)], service) - self.x_origin = self.__class__.x_origin(path + [("x_origin", None)], service) - self.y_origin = self.__class__.y_origin(path + [("y_origin", None)], service) - self.z_origin = self.__class__.z_origin(path + [("z_origin", None)], service) - self.ke_spec = self.__class__.ke_spec(path + [("ke_spec", None)], service) - self.nut = self.__class__.nut(path + [("nut", None)], service) - self.kl = self.__class__.kl(path + [("kl", None)], service) - self.intermit = self.__class__.intermit(path + [("intermit", None)], service) - self.k = self.__class__.k(path + [("k", None)], service) - self.e = self.__class__.e(path + [("e", None)], service) - self.o = self.__class__.o(path + [("o", None)], service) - self.v2 = self.__class__.v2(path + [("v2", None)], service) - self.turb_intensity = self.__class__.turb_intensity(path + [("turb_intensity", None)], service) - self.turb_length_scale = self.__class__.turb_length_scale(path + [("turb_length_scale", None)], service) - self.turb_hydraulic_diam = self.__class__.turb_hydraulic_diam(path + [("turb_hydraulic_diam", None)], service) - self.turb_viscosity_ratio = self.__class__.turb_viscosity_ratio(path + [("turb_viscosity_ratio", None)], service) - self.turb_viscosity_ratio_profile = self.__class__.turb_viscosity_ratio_profile(path + [("turb_viscosity_ratio_profile", None)], service) - self.rst_spec = self.__class__.rst_spec(path + [("rst_spec", None)], service) - self.uu = self.__class__.uu(path + [("uu", None)], service) - self.vv = self.__class__.vv(path + [("vv", None)], service) - self.ww = self.__class__.ww(path + [("ww", None)], service) - self.uv = self.__class__.uv(path + [("uv", None)], service) - self.vw = self.__class__.vw(path + [("vw", None)], service) - self.uw = self.__class__.uw(path + [("uw", None)], service) - self.ksgs_spec = self.__class__.ksgs_spec(path + [("ksgs_spec", None)], service) - self.ksgs = self.__class__.ksgs(path + [("ksgs", None)], service) - self.sgs_turb_intensity = self.__class__.sgs_turb_intensity(path + [("sgs_turb_intensity", None)], service) - self.swirl_model = self.__class__.swirl_model(path + [("swirl_model", None)], service) - self.swirl_factor = self.__class__.swirl_factor(path + [("swirl_factor", None)], service) - self.x_fan_origin = self.__class__.x_fan_origin(path + [("x_fan_origin", None)], service) - self.y_fan_origin = self.__class__.y_fan_origin(path + [("y_fan_origin", None)], service) - self.z_fan_origin = self.__class__.z_fan_origin(path + [("z_fan_origin", None)], service) - self.wsf = self.__class__.wsf(path + [("wsf", None)], service) - self.wsb = self.__class__.wsb(path + [("wsb", None)], service) - self.wsn = self.__class__.wsn(path + [("wsn", None)], service) - self.slip_velocity = self.__class__.slip_velocity(path + [("slip_velocity", None)], service) - self.velocity_ratio = self.__class__.velocity_ratio(path + [("velocity_ratio", None)], service) - self.volume_frac = self.__class__.volume_frac(path + [("volume_frac", None)], service) - self.granular_temperature = self.__class__.granular_temperature(path + [("granular_temperature", None)], service) - self.ac_options = self.__class__.ac_options(path + [("ac_options", None)], service) - self.ac_wave = self.__class__.ac_wave(path + [("ac_wave", None)], service) - self.t0 = self.__class__.t0(path + [("t0", None)], service) - - class flow_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mass_flow(metaclass=PyMenuMeta): + def __init__(self, path, service): + self.path = path + self.service = service + self.far_field_parameters = self.__class__.far_field_parameters(path + [("far_field_parameters", None)], service) + self.wave_equation_options = self.__class__.wave_equation_options(path + [("wave_equation_options", None)], service) + self.sources_fft = self.__class__.sources_fft(path + [("sources_fft", None)], service) + self.sponge_layers = self.__class__.sponge_layers(path + [("sponge_layers", None)], service) + super().__init__(path, service) + def off(self, *args, **kwargs): """ + Enables/disables the acoustics model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ec_mass_flow(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/off").execute(*args, **kwargs) + def ffowcs_williams(self, *args, **kwargs): """ + Enables/disables the Ffowcs-Williams-and-Hawkings model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mass_flux(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/ffowcs_williams").execute(*args, **kwargs) + def broad_band_noise(self, *args, **kwargs): """ + Enables/disables the broadband noise model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mass_flux_ave(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/broad_band_noise").execute(*args, **kwargs) + def modal_analysis(self, *args, **kwargs): """ + Enable/disable the modal analysis model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class tref(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/modal_analysis").execute(*args, **kwargs) + def wave_equation(self, *args, **kwargs): """ + Enables/disables the wave equation model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class pref(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/wave_equation").execute(*args, **kwargs) + def receivers(self, *args, **kwargs): """ + Sets acoustic receivers. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class p(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/receivers").execute(*args, **kwargs) + def export_source_data(self, *args, **kwargs): """ + Enables/disables the export of acoustic source data in ASD format during the wave equation model run. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class direction_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/export_source_data").execute(*args, **kwargs) + def export_source_data_cgns(self, *args, **kwargs): """ + Enables/disables the export of acoustic source data in CGNS format. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class impedance_0(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/export_source_data_cgns").execute(*args, **kwargs) + def sources(self, *args, **kwargs): """ + Sets acoustic sources. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class frame_of_reference(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/sources").execute(*args, **kwargs) + def read_compute_write(self, *args, **kwargs): """ + Reads acoustic source data files and computes sound pressure. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coordinate_system(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/read_compute_write").execute(*args, **kwargs) + def write_acoustic_signals(self, *args, **kwargs): """ + Writes on-the-fly sound pressure. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ni(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/write_acoustic_signals").execute(*args, **kwargs) + def compute_write(self, *args, **kwargs): """ + Computes sound pressure. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nj(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/compute_write").execute(*args, **kwargs) + def write_centroid_info(self, *args, **kwargs): """ + Writes centroid info. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nk(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/write_centroid_info").execute(*args, **kwargs) + def acoustic_modal_analysis(self, *args, **kwargs): """ + Iterate linear acoustic solver to compute the resonance frequencies and the acoustic modes. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ni2(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/acoustic_modal_analysis").execute(*args, **kwargs) + def export_volumetric_sources(self, *args, **kwargs): """ + Enables/disables the export of fluid zones. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nj2(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/export_volumetric_sources").execute(*args, **kwargs) + def export_volumetric_sources_cgns(self, *args, **kwargs): """ + Enables/disables the export of fluid zones. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nk2(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/export_volumetric_sources_cgns").execute(*args, **kwargs) + def display_flow_time(self, *args, **kwargs): """ + Enables/disables the display of flow time during read-and-compute. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ai(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/display_flow_time").execute(*args, **kwargs) + def cylindrical_export(self, *args, **kwargs): """ + Enables/disables the export of data in cylindrical coordinates. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class aj(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/cylindrical_export").execute(*args, **kwargs) + def auto_prune(self, *args, **kwargs): """ + Enables/disables auto prune of the receiver signal(s) during read-and-compute. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ak(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/auto_prune").execute(*args, **kwargs) + def moving_receiver(self, *args, **kwargs): """ + Enables/disables the moving receiver option. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class x_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/moving_receiver").execute(*args, **kwargs) + def convective_effects(self, *args, **kwargs): """ + Enables/disables the convective effects option. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class y_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/acoustics/convective_effects").execute(*args, **kwargs) + def display_frequencies(self, *args, **kwargs): """ + Display resonance frequencies. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/models/acoustics/display_frequencies").execute(*args, **kwargs) - class z_origin(metaclass=PyMenuMeta): + class far_field_parameters(TUIMenu): """ + Enters the menu to specify the far-field density and speed of sound. Note that this menu is currently available only with the acoustics wave equation model. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def far_field_density(self, *args, **kwargs): + """ + Specifies the far-field density value for the acoustics wave equation model. + """ + return PyMenu(self.service, "/define/models/acoustics/far_field_parameters/far_field_density").execute(*args, **kwargs) + def far_field_sound_speed(self, *args, **kwargs): + """ + Specifies the far-field speed of sound value for the acoustics wave equation model. + """ + return PyMenu(self.service, "/define/models/acoustics/far_field_parameters/far_field_sound_speed").execute(*args, **kwargs) - class ke_spec(metaclass=PyMenuMeta): + class wave_equation_options(TUIMenu): """ + Enters the menu to define the acoustics wave equation model options. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + self.basic_shapes = self.__class__.basic_shapes(path + [("basic_shapes", None)], service) + self.remote_receivers_options = self.__class__.remote_receivers_options(path + [("remote_receivers_options", None)], service) + super().__init__(path, service) + def time_filter_source(self, *args, **kwargs): + """ + Enables/disables a time filter for the sound source. + """ + return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/time_filter_source").execute(*args, **kwargs) + def sponge_layer_factor(self, *args, **kwargs): + """ + Specifies the factor of the artificial viscosity coefficient. + """ + return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/sponge_layer_factor").execute(*args, **kwargs) + def sponge_layer_base_level(self, *args, **kwargs): + """ + Specify artificial viscosity base level applied everywhere. + """ + return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/sponge_layer_base_level").execute(*args, **kwargs) + def source_mask_udf(self, *args, **kwargs): + """ + Specifies the name of a user-defined function, which defines geometry of the source mask. + """ + return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/source_mask_udf").execute(*args, **kwargs) + def sponge_layer_udf(self, *args, **kwargs): + """ + Specifies the name of a user-defined function, which defines geometry of the sponge layer. + """ + return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/sponge_layer_udf").execute(*args, **kwargs) + def remote_receivers(self, *args, **kwargs): + """ + Enables/disables the Kirchhoff integral model. + """ + return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/remote_receivers").execute(*args, **kwargs) - class nut(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class basic_shapes(TUIMenu): + """ + Enters the menu to define the geometry of the source mask and sponge layer using the basic shapes, represented by the cell registers of the type "Region". + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def list_region_registers(self, *args, **kwargs): + """ + List all available cell registers of the type "Region". + """ + return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/basic_shapes/list_region_registers").execute(*args, **kwargs) + def list_source_mask_shapes(self, *args, **kwargs): + """ + List basic shapes, which are currently used in the definition of the source mask geometry. + """ + return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/basic_shapes/list_source_mask_shapes").execute(*args, **kwargs) + def list_sponge_layer_shapes(self, *args, **kwargs): + """ + List basic shapes, which are currently used in the definition of the sponge layer geometry. + """ + return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/basic_shapes/list_sponge_layer_shapes").execute(*args, **kwargs) + def add_source_mask_shape(self, *args, **kwargs): + """ + Adds a basic shape to the definition of the source mask geometry. + """ + return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/basic_shapes/add_source_mask_shape").execute(*args, **kwargs) + def add_sponge_layer_shape(self, *args, **kwargs): + """ + Adds a basic shape to the definition of the sponge layer geometry. + """ + return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/basic_shapes/add_sponge_layer_shape").execute(*args, **kwargs) + def remove_source_mask_shape(self, *args, **kwargs): + """ + Remove a basic shape from the definition of the source mask geometry. + """ + return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/basic_shapes/remove_source_mask_shape").execute(*args, **kwargs) + def remove_sponge_layer_shape(self, *args, **kwargs): + """ + Remove a basic shape from the definition of the sponge layer geometry. + """ + return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/basic_shapes/remove_sponge_layer_shape").execute(*args, **kwargs) - class kl(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class remote_receivers_options(TUIMenu): + """ + Enters the menu to define remote receivers for the Kirchhoff integral model. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def integration_surface(self, *args, **kwargs): + """ + Selects the integration surface for the Kirchhoff model. + """ + return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/remote_receivers_options/integration_surface").execute(*args, **kwargs) + def write_signals(self, *args, **kwargs): + """ + Writes the computed receiver signals to the ASCII files. + """ + return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/remote_receivers_options/write_signals").execute(*args, **kwargs) - class intermit(metaclass=PyMenuMeta): + class sources_fft(TUIMenu): """ + Enters the acoustic sources fast Fourier transform (FFT) menu, to compute Fourier spectra from acoustic source data (ASD) files, create postprocessing variables for the pressure signals, and write CGNS files of the spectrum data. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + self.fft_surface_variables = self.__class__.fft_surface_variables(path + [("fft_surface_variables", None)], service) + super().__init__(path, service) + def read_asd_files(self, *args, **kwargs): + """ + Reads ASD files to perform FFT of the pressure history field. + """ + return PyMenu(self.service, "/define/models/acoustics/sources_fft/read_asd_files").execute(*args, **kwargs) + def compute_fft_fields(self, *args, **kwargs): + """ + Computes FFT of the read pressure histories. The computed spectra replace the pressure histories in memory. + """ + return PyMenu(self.service, "/define/models/acoustics/sources_fft/compute_fft_fields").execute(*args, **kwargs) + def write_cgns_files(self, *args, **kwargs): + """ + Writes surface pressure spectra in CGNS format, which can be used for one-way coupling with Ansys Mechanical in the frequency domain. + """ + return PyMenu(self.service, "/define/models/acoustics/sources_fft/write_cgns_files").execute(*args, **kwargs) + def clean_up_storage_area(self, *args, **kwargs): + """ + De-allocates memory used to store the pressure histories and their Fourier spectra, as well as any created surface variables for the visualization. + """ + return PyMenu(self.service, "/define/models/acoustics/sources_fft/clean_up_storage_area").execute(*args, **kwargs) + + class fft_surface_variables(TUIMenu): + """ + Enters the menu to create surface variables from the computed Fourier spectra for visualization. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def create_octave_bands(self, *args, **kwargs): + """ + Creates either the surface pressure level (SPL) variables or the PSD of dp/dt variables for 17 technical octaves. + """ + return PyMenu(self.service, "/define/models/acoustics/sources_fft/fft_surface_variables/create_octave_bands").execute(*args, **kwargs) + def create_third_bands(self, *args, **kwargs): + """ + Creates either the surface pressure level (SPL) variables or the PSD of dp/dt variables for 54 technical thirds. + """ + return PyMenu(self.service, "/define/models/acoustics/sources_fft/fft_surface_variables/create_third_bands").execute(*args, **kwargs) + def create_constant_width_bands(self, *args, **kwargs): + """ + Selects up to 20 constant width bands and creates either the surface pressures level (SPL) variables or the PSD of dp/dt variables for them. + """ + return PyMenu(self.service, "/define/models/acoustics/sources_fft/fft_surface_variables/create_constant_width_bands").execute(*args, **kwargs) + def create_set_of_modes(self, *args, **kwargs): + """ + Selects up to 20 individual Fourier modes and create variable pairs for them, containing the real and the imaginary parts of the complex Fourier amplitudes. + """ + return PyMenu(self.service, "/define/models/acoustics/sources_fft/fft_surface_variables/create_set_of_modes").execute(*args, **kwargs) + def remove_variables(self, *args, **kwargs): + """ + Removes all variables created in this menu. + """ + return PyMenu(self.service, "/define/models/acoustics/sources_fft/fft_surface_variables/remove_variables").execute(*args, **kwargs) - class k(metaclass=PyMenuMeta): + class sponge_layers(TUIMenu): """ + Manage sponge layers where density is blended to eliminate reflections from boundary zones. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def activate(self, *args, **kwargs): + """ + Activate a sponge object. + """ + return PyMenu(self.service, "/define/models/acoustics/sponge_layers/activate").execute(*args, **kwargs) + def add(self, *args, **kwargs): + """ + Add a new sponge layer definition. + """ + return PyMenu(self.service, "/define/models/acoustics/sponge_layers/add").execute(*args, **kwargs) + def deactivate(self, *args, **kwargs): + """ + Deactivate a sponge layer definition. + """ + return PyMenu(self.service, "/define/models/acoustics/sponge_layers/deactivate").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edits an existing sponge layer. You can revise the fields listed previously for the define/models/acoustics/sponge-layers/add text command. + """ + return PyMenu(self.service, "/define/models/acoustics/sponge_layers/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes an existing sponge layer definition. + """ + return PyMenu(self.service, "/define/models/acoustics/sponge_layers/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Prints a list of the existing sponge layers in the console. + """ + return PyMenu(self.service, "/define/models/acoustics/sponge_layers/list").execute(*args, **kwargs) + def list_active(self, *args, **kwargs): + """ + List the names of the active sponge layer definitions. + """ + return PyMenu(self.service, "/define/models/acoustics/sponge_layers/list_active").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + Prints the properties of an existing sponge layer of your choice in the console. + """ + return PyMenu(self.service, "/define/models/acoustics/sponge_layers/list_properties").execute(*args, **kwargs) - class e(metaclass=PyMenuMeta): + class optics(TUIMenu): + """ + Enter the optics model menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) + def enable(self, *args, **kwargs): """ + Enable/disable optics model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class o(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/optics/enable").execute(*args, **kwargs) + def add_beam(self, *args, **kwargs): """ + Add optical beam grid. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/models/optics/add_beam").execute(*args, **kwargs) - class v2(metaclass=PyMenuMeta): + class set(TUIMenu): """ + Enter the set menu for optics model. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def sampling(self, *args, **kwargs): + """ + Specify when the fluid density field is sampled. + """ + return PyMenu(self.service, "/define/models/optics/set/sampling").execute(*args, **kwargs) + def index_of_refraction(self, *args, **kwargs): + """ + Specify the model parameters of index of refraction. + """ + return PyMenu(self.service, "/define/models/optics/set/index_of_refraction").execute(*args, **kwargs) + def running_average(self, *args, **kwargs): + """ + Setup the running average of the collected density field. + """ + return PyMenu(self.service, "/define/models/optics/set/running_average").execute(*args, **kwargs) - class turb_intensity(metaclass=PyMenuMeta): + class eulerian_wallfilm(TUIMenu): + """ + Enters the Eulerian wall film model menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.coupled_solution = self.__class__.coupled_solution(path + [("coupled_solution", None)], service) + self.implicit_options = self.__class__.implicit_options(path + [("implicit_options", None)], service) + super().__init__(path, service) + def enable_wallfilm_model(self, *args, **kwargs): """ + Enables/disables Eulerian Wall Film Model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_length_scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_hydraulic_diam(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_viscosity_ratio(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_viscosity_ratio_profile(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class rst_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uu(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vv(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ww(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uv(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vw(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/eulerian_wallfilm/enable_wallfilm_model").execute(*args, **kwargs) + def initialize_wallfilm_model(self, *args, **kwargs): """ + Initializes Eulerian Wall Film Model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uw(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/eulerian_wallfilm/initialize_wallfilm_model").execute(*args, **kwargs) + def solve_wallfilm_equation(self, *args, **kwargs): """ + Activates Eulerian Wall Film Equations. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ksgs_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/eulerian_wallfilm/solve_wallfilm_equation").execute(*args, **kwargs) + def model_options(self, *args, **kwargs): """ + Sets Eulerian Wall Film Model Options. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ksgs(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/eulerian_wallfilm/model_options").execute(*args, **kwargs) + def film_material(self, *args, **kwargs): """ + Sets Film Material and Properties. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sgs_turb_intensity(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/eulerian_wallfilm/film_material").execute(*args, **kwargs) + def solution_options(self, *args, **kwargs): """ + Sets Eulerian Wall Film Model Solution Options. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/models/eulerian_wallfilm/solution_options").execute(*args, **kwargs) - class swirl_model(metaclass=PyMenuMeta): + class coupled_solution(TUIMenu): """ + Enters the Coupled-Solution menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def enable_coupled_solution(self, *args, **kwargs): + """ + Enables/disables the coupled solution method. + """ + return PyMenu(self.service, "/define/models/eulerian_wallfilm/coupled_solution/enable_coupled_solution").execute(*args, **kwargs) + def enable_curvature_smoothing(self, *args, **kwargs): + """ + Enables/disables the film curvature smoothing option and sets the smoothing parameters. + """ + return PyMenu(self.service, "/define/models/eulerian_wallfilm/coupled_solution/enable_curvature_smoothing").execute(*args, **kwargs) - class swirl_factor(metaclass=PyMenuMeta): + class implicit_options(TUIMenu): """ + Enter Implicit Scheme Option (beta). """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def new_implicit_scheme(self, *args, **kwargs): + """ + Enable alternative implicit scheme. + """ + return PyMenu(self.service, "/define/models/eulerian_wallfilm/implicit_options/new_implicit_scheme").execute(*args, **kwargs) + def relative_error_residual(self, *args, **kwargs): + """ + Enable relative error residual. + """ + return PyMenu(self.service, "/define/models/eulerian_wallfilm/implicit_options/relative_error_residual").execute(*args, **kwargs) - class x_fan_origin(metaclass=PyMenuMeta): + class dpm(TUIMenu): + """ + Enters the dispersed phase model menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.collisions = self.__class__.collisions(path + [("collisions", None)], service) + self.erosion_dynamic_mesh = self.__class__.erosion_dynamic_mesh(path + [("erosion_dynamic_mesh", None)], service) + self.interaction = self.__class__.interaction(path + [("interaction", None)], service) + self.numerics = self.__class__.numerics(path + [("numerics", None)], service) + self.options = self.__class__.options(path + [("options", None)], service) + self.parallel = self.__class__.parallel(path + [("parallel", None)], service) + self.splash_options = self.__class__.splash_options(path + [("splash_options", None)], service) + self.stripping_options = self.__class__.stripping_options(path + [("stripping_options", None)], service) + super().__init__(path, service) + def clear_particles_from_domain(self, *args, **kwargs): """ + Removes/keeps all particles currently in the domain. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class y_fan_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/dpm/clear_particles_from_domain").execute(*args, **kwargs) + def fill_injection_material_sources(self, *args, **kwargs): """ + Initialize the DPM sources corresponding to each material. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class z_fan_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/dpm/fill_injection_material_sources").execute(*args, **kwargs) + def injections(self, *args, **kwargs): """ + Enters the injections menu. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wsf(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/dpm/injections").execute(*args, **kwargs) + def unsteady_tracking(self, *args, **kwargs): """ + Enables/disables unsteady particle tracking. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wsb(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/dpm/unsteady_tracking").execute(*args, **kwargs) + def spray_model(self, *args, **kwargs): """ + Enters the spray model menu. This command is available only if the breakup model enabled globally. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wsn(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/dpm/spray_model").execute(*args, **kwargs) + def user_defined(self, *args, **kwargs): """ + Sets DPM user-defined functions. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/models/dpm/user_defined").execute(*args, **kwargs) - class slip_velocity(metaclass=PyMenuMeta): + class collisions(TUIMenu): """ + Enters the DEM collisions menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + self.collision_partners = self.__class__.collision_partners(path + [("collision_partners", None)], service) + super().__init__(path, service) + def collision_pair_settings(self, *args, **kwargs): + """ + Supplies settings for collisions to a pair of collision partners. You will be prompted to specify theImpact collision partner and the Target collision partner. + """ + return PyMenu(self.service, "/define/models/dpm/collisions/collision_pair_settings").execute(*args, **kwargs) + def list_all_pair_settings(self, *args, **kwargs): + """ + For each pair of collision partners, lists the collision laws and their parameters. + """ + return PyMenu(self.service, "/define/models/dpm/collisions/list_all_pair_settings").execute(*args, **kwargs) + def dem_collisions(self, *args, **kwargs): + """ + Enables/disables the DEM collision model. + """ + return PyMenu(self.service, "/define/models/dpm/collisions/dem_collisions").execute(*args, **kwargs) + def collision_mesh(self, *args, **kwargs): + """ + Input for the collision mesh. + """ + return PyMenu(self.service, "/define/models/dpm/collisions/collision_mesh").execute(*args, **kwargs) + def max_particle_velocity(self, *args, **kwargs): + """ + Sets the maximum particle velocity that may arise from collisions. + """ + return PyMenu(self.service, "/define/models/dpm/collisions/max_particle_velocity").execute(*args, **kwargs) - class velocity_ratio(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class collision_partners(TUIMenu): + """ + Manages collision partners. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def create(self, *args, **kwargs): + """ + Creates a collision partner. + """ + return PyMenu(self.service, "/define/models/dpm/collisions/collision_partners/create").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes a collision partner. + """ + return PyMenu(self.service, "/define/models/dpm/collisions/collision_partners/delete").execute(*args, **kwargs) + def copy(self, *args, **kwargs): + """ + Copies a collision partner. + """ + return PyMenu(self.service, "/define/models/dpm/collisions/collision_partners/copy").execute(*args, **kwargs) + def rename(self, *args, **kwargs): + """ + Renames a collision partner. + """ + return PyMenu(self.service, "/define/models/dpm/collisions/collision_partners/rename").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Lists all known collision partners. + """ + return PyMenu(self.service, "/define/models/dpm/collisions/collision_partners/list").execute(*args, **kwargs) - class volume_frac(metaclass=PyMenuMeta): + class erosion_dynamic_mesh(TUIMenu): """ + Enters the menu to enable/configure/run the erosion-dynamic mesh interaction. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + self.general_parameters = self.__class__.general_parameters(path + [("general_parameters", None)], service) + self.run_parameters = self.__class__.run_parameters(path + [("run_parameters", None)], service) + super().__init__(path, service) + def enable_erosion_dynamic_mesh_coupling(self, *args, **kwargs): + """ + Enables mesh deformation due to wall erosion. + """ + return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/enable_erosion_dynamic_mesh_coupling").execute(*args, **kwargs) + def run_simulation(self, *args, **kwargs): + """ + Performs a coupled erosion-dynamic mesh simulation. + """ + return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/run_simulation").execute(*args, **kwargs) - class granular_temperature(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class general_parameters(TUIMenu): + """ + Enters the menu for setting erosion coupling with dynamic mesh. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def erosion_settings(self, *args, **kwargs): + """ + Sets parameters for erosion calculations. + """ + return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/general_parameters/erosion_settings").execute(*args, **kwargs) + def dynamic_mesh_settings(self, *args, **kwargs): + """ + Sets parameters for dynamic mesh calculations. + """ + return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/general_parameters/dynamic_mesh_settings").execute(*args, **kwargs) + def participating_walls(self, *args, **kwargs): + """ + Specifies all participating walls. + """ + return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/general_parameters/participating_walls").execute(*args, **kwargs) - class ac_options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class run_parameters(TUIMenu): + """ + Manages erosion-dynamic mesh run settings. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def mesh_motion_time_step(self, *args, **kwargs): + """ + Sets the mesh motion time stepping parameters and method. + """ + return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/run_parameters/mesh_motion_time_step").execute(*args, **kwargs) + def simulation_termination(self, *args, **kwargs): + """ + Sets the total time of erosion. + """ + return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/run_parameters/simulation_termination").execute(*args, **kwargs) + def flow_simulation_control(self, *args, **kwargs): + """ + Sets the number of iterations per flow simulation step. + """ + return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/run_parameters/flow_simulation_control").execute(*args, **kwargs) + def autosave_files(self, *args, **kwargs): + """ + Sets the iteration increment and filename to save data files. + """ + return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/run_parameters/autosave_files").execute(*args, **kwargs) + def autosave_graphics(self, *args, **kwargs): + """ + Sets the iteration increment to save graphics files. + """ + return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/run_parameters/autosave_graphics").execute(*args, **kwargs) - class ac_wave(metaclass=PyMenuMeta): + class interaction(TUIMenu): """ + Sets parameters for coupled discrete phase calculations. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def choice_of_eulerian_phase_for_interaction(self, *args, **kwargs): + """ + Enable/disable the option to choose for every injection the Eulerian phase for the DPM continuous phase interaction. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/choice_of_eulerian_phase_for_interaction").execute(*args, **kwargs) + def coupled_calculations(self, *args, **kwargs): + """ + Selects whether or not to couple continuous and discrete phase calculations. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/coupled_calculations").execute(*args, **kwargs) + def dpm_iteration_interval(self, *args, **kwargs): + """ + Sets the frequency with which the particle trajectory calculations are introduced. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/dpm_iteration_interval").execute(*args, **kwargs) + def underrelaxation_factor(self, *args, **kwargs): + """ + Sets the under-relaxation factor for the discrete phase sources. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/underrelaxation_factor").execute(*args, **kwargs) + def implicit_momentum_coupling(self, *args, **kwargs): + """ + Enables/disables implicit treatment for the DPM momentum source terms. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/implicit_momentum_coupling").execute(*args, **kwargs) + def implicit_source_term_coupling(self, *args, **kwargs): + """ + Enables/disables implicit treatment for all DPM source terms. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/implicit_source_term_coupling").execute(*args, **kwargs) + def linearized_dpm_source_terms(self, *args, **kwargs): + """ + Enables/disables linearization of source terms for the discrete phase. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/linearized_dpm_source_terms").execute(*args, **kwargs) + def replace_dpm_mass_source_by_mixture_fraction(self, *args, **kwargs): + """ + When enabled, recalculates the mixture fraction source terms as a function of the primary mixture fraction. This command is available for non- or partially-premixed combustion cases only. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/replace_dpm_mass_source_by_mixture_fraction").execute(*args, **kwargs) + def linearized_dpm_mixture_fraction_source_terms(self, *args, **kwargs): + """ + Enables/disables linearization of mixture fraction source terms. This command is available only for non- or partially-premixed combustion cases. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/linearized_dpm_mixture_fraction_source_terms").execute(*args, **kwargs) + def linearized_dpm_species_source_terms(self, *args, **kwargs): + """ + Perform linearization of species source terms. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/linearized_dpm_species_source_terms").execute(*args, **kwargs) + def keep_linearized_dpm_source_terms_constant(self, *args, **kwargs): + """ + Keep linearized DPM source terms constant until the next DPM Update. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/keep_linearized_dpm_source_terms_constant").execute(*args, **kwargs) + def linearized_dpm_source_terms_limiter(self, *args, **kwargs): + """ + Relative limit for DPM source linear coefficient with respect to fluid linear Ap coefficient. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/linearized_dpm_source_terms_limiter").execute(*args, **kwargs) + def update_dpm_sources_every_flow_iteration(self, *args, **kwargs): + """ + Enables/disables the update of DPM source terms every flow iteration (if this option is not enabled, the terms will be updated every DPM iteration). + """ + return PyMenu(self.service, "/define/models/dpm/interaction/update_dpm_sources_every_flow_iteration").execute(*args, **kwargs) + def linear_growth_of_dpm_source_term(self, *args, **kwargs): + """ + Enables/disables the linear ramping up of the DPM source terms at every DPM iteration. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/linear_growth_of_dpm_source_term").execute(*args, **kwargs) + def reset_sources_at_timestep(self, *args, **kwargs): + """ + Enable/disable flush of DPM source terms at beginning of every time step. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/reset_sources_at_timestep").execute(*args, **kwargs) + def enable_flow_blocking_by_particles(self, *args, **kwargs): + """ + Enable/disable inclusion of DPM volume fraction in continuous flow. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/enable_flow_blocking_by_particles").execute(*args, **kwargs) + def enable_source_scaling_due_to_flow_blocking(self, *args, **kwargs): + """ + Enable/disable scaling of DPM source terms due to inclusion of DPM volume fraction in continuous flow. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/enable_source_scaling_due_to_flow_blocking").execute(*args, **kwargs) + def enable_drag_scaling_due_to_flow_blocking(self, *args, **kwargs): + """ + Enable/disable scaling of DPM drag coefficient due to inclusion of DPM volume fraction in continuous flow. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/enable_drag_scaling_due_to_flow_blocking").execute(*args, **kwargs) + def max_vf_allowed_for_blocking(self, *args, **kwargs): + """ + Maximum DPM volume fraction used in continuous flow. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/max_vf_allowed_for_blocking").execute(*args, **kwargs) + def min_vf_threshold_for_dpm_src_scaling(self, *args, **kwargs): + """ + Minimum DPM volume fraction below which no DPM source scaling is applied. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/min_vf_threshold_for_dpm_src_scaling").execute(*args, **kwargs) + def ddpm_iad_particle(self, *args, **kwargs): + """ + Enable/disable the non-default interfacial area method IA-particle. + """ + return PyMenu(self.service, "/define/models/dpm/interaction/ddpm_iad_particle").execute(*args, **kwargs) - class t0(metaclass=PyMenuMeta): + class numerics(TUIMenu): """ + Enters the numerics menu to set numerical solution parameters. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + self.high_resolution_tracking = self.__class__.high_resolution_tracking(path + [("high_resolution_tracking", None)], service) + super().__init__(path, service) + def coupled_heat_mass_update(self, *args, **kwargs): + """ + Enables/disables coupled heat and mass update. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/coupled_heat_mass_update").execute(*args, **kwargs) + def minimum_liquid_fraction(self, *args, **kwargs): + """ + A droplet evaporates completely when the remaining mass is below this fraction of the initial droplet mass. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/minimum_liquid_fraction").execute(*args, **kwargs) + def underrelax_film_height(self, *args, **kwargs): + """ + Sets the under-relaxation factor for the film height calculation. The recommended values range between 0.5 (default) and 0.9. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/underrelax_film_height").execute(*args, **kwargs) + def vaporization_limiting_factors(self, *args, **kwargs): + """ + Sets the Vaporization Fractional Change Limits. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/vaporization_limiting_factors").execute(*args, **kwargs) + def tracking_parameters(self, *args, **kwargs): + """ + Sets parameters for the (initial) tracking step length. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/tracking_parameters").execute(*args, **kwargs) + def tracking_scheme(self, *args, **kwargs): + """ + Specifies a tracking scheme. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/tracking_scheme").execute(*args, **kwargs) + def tracking_statistics(self, *args, **kwargs): + """ + Controls the format of the one-line tracking statistics to be printed after every DPM tracking pass. A value of 0 (the default) prints only fates with non-zero values. A value of 1 prints all fates, including fates with zero values. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/tracking_statistics").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Adjust the DPM tracker's verbosity level. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/verbosity").execute(*args, **kwargs) + def error_control(self, *args, **kwargs): + """ + Adapts integration step length based on a maximum error. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/error_control").execute(*args, **kwargs) + def automated_scheme_selection(self, *args, **kwargs): + """ + Enables/disables the adaptation of integration step length based on a maximum error. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/automated_scheme_selection").execute(*args, **kwargs) + def drag_law(self, *args, **kwargs): + """ + Sets the drag law. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/drag_law").execute(*args, **kwargs) + def enable_node_based_averaging(self, *args, **kwargs): + """ + Enables/disables mesh node averaging of DPM quantities. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/enable_node_based_averaging").execute(*args, **kwargs) + def average_source_terms(self, *args, **kwargs): + """ + Enables/disables mesh node averaging of DPM source terms. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/average_source_terms").execute(*args, **kwargs) + def average_DDPM_variables(self, *args, **kwargs): + """ + Enables/disables mesh node averaging of DDPM quantities. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/average_DDPM_variables").execute(*args, **kwargs) + def average_each_step(self, *args, **kwargs): + """ + Enables/disables mesh node averaging during integration time step. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/average_each_step").execute(*args, **kwargs) + def average_kernel(self, *args, **kwargs): + """ + Specifies the averaging kernel to use for mesh node averaging. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/average_kernel").execute(*args, **kwargs) + def gaussian_factor(self, *args, **kwargs): + """ + Specifies the Gaussian constant when using thegaussian kernel for mesh node averaging. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/gaussian_factor").execute(*args, **kwargs) + def mppic_settings(self, *args, **kwargs): + """ + Enable PIC and MPPIC to compute DPM and DDPM source terms. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/mppic_settings").execute(*args, **kwargs) + def enhanced_packing_limit_numerics(self, *args, **kwargs): + """ + Enable enhanced packing limit numerics to avoid exceeding of packing limit for granular phases. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/enhanced_packing_limit_numerics").execute(*args, **kwargs) - class modify_zones(metaclass=PyMenuMeta): - """ - Enters the modify zones menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def activate_cell_zone(self, *args, **kwargs): - """ - Activates cell thread. + class high_resolution_tracking(TUIMenu): + """ + Enters the high resolution tracking menu. See for more information about these options. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.barycentric_interpolation = self.__class__.barycentric_interpolation(path + [("barycentric_interpolation", None)], service) + self.particle_relocation = self.__class__.particle_relocation(path + [("particle_relocation", None)], service) + super().__init__(path, service) + def enable_high_resolution_tracking(self, *args, **kwargs): + """ + Enables/disables high resolution tracking. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/enable_high_resolution_tracking").execute(*args, **kwargs) + def enable_barycentric_intersections(self, *args, **kwargs): + """ + Enables/disables an alternative method of calculating intersections with cell boundaries. Barycentric intersections are linear calculations and are faster than the default intersection algorithm. The default intersection algorithm is second-order for stationary meshes; therefore, using the barycentric intersection may sacrifice accuracy. You must verify that the barycentric intersections provide comparable results to the default intersection method. This option is available only for 3D stationary meshes and the double precision solver. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/enable_barycentric_intersections").execute(*args, **kwargs) + def use_barycentric_sampling(self, *args, **kwargs): + """ + When enabled, this option provides improved accuracy and parallel consistency when sampling particles at planes. This item is available only with the 3D solver. Using the double-precision solver and bounded planes is recommended. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/use_barycentric_sampling").execute(*args, **kwargs) + def use_velocity_based_error_control(self, *args, **kwargs): + """ + Enables/disables an alternative method of timestep adaption. By default, ANSYS Fluent uses the half-step method of timestep adaption with particle integration. This alternative method of controlling the integration timestep based upon velocity changes is faster; however, you need to ensure that the accuracy is comparable for your specific application. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/use_velocity_based_error_control").execute(*args, **kwargs) + def use_quad_face_centroid(self, *args, **kwargs): + """ + Enables/disables using quad face centroids when creating subtets. This option changes the way hexahedral cells are decomposed to avoid creating degenerate subtets. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/use_quad_face_centroid").execute(*args, **kwargs) + def check_subtet_validity(self, *args, **kwargs): + """ + When enabled, checks the validity of a subtet when the particle first enters it. If the subtet is found to be degenerate, the tracking algorithm modifies to accommodate it. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/check_subtet_validity").execute(*args, **kwargs) + def always_use_face_centroid_with_periodics(self, *args, **kwargs): + """ + When enabled, ANSYS Fluent uses quad face centroids when creating subtets in cases with periodic boundaries. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/always_use_face_centroid_with_periodics").execute(*args, **kwargs) + def boundary_layer_tracking(self, *args, **kwargs): + """ + Enables/disables the calculation of the particle time step that considers both the cell aspect ratio and the particle trajectory. This method improves the accuracy of the predictions in boundary layer cells, particularly in layers where flow gradients are large. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/boundary_layer_tracking").execute(*args, **kwargs) + def sliding_interface_crossover_fraction(self, *args, **kwargs): + """ + Specifies the fraction of the distance to the subtet center to move the particle. At non-conformal interfaces, the nodes used for the barycentric interpolation are different on either side of the interface. This may result in incomplete particles due to discontinuities in the variable interpolation. The number of incomplete particles may be reduced by moving the particles slightly off of the sliding interface. Recommended values range between 0 and 0.5. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/sliding_interface_crossover_fraction").execute(*args, **kwargs) + def project_wall_film_particles_to_film(self, *args, **kwargs): + """ + Enables/disables projecting existing particles to Lagrangian wall film to track using high-resolution tracking. When reading in a data file that contains wall film particles previously tracked with the existing ANSYS Fluent tracking method, you need to either clear the particles from the domain or project their positions to the wall film surface using the project-wall-film-particles-to-film? text command prior to using the high-resolution tracking method. After tracking the particles for one timestep, this option can be disabled to improve performance. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/project_wall_film_particles_to_film").execute(*args, **kwargs) + def use_particle_timestep_for_intersection_tolerance(self, *args, **kwargs): + """ + Enables/disables the use of the particle timestep for the subtet intersection tolerance with axisymmetric grids (default: enabled). If disabled, the tolerance will be calculated in the same manner as non-axisymmetric meshes (a scaled value of the tolerance which is set using the define/models/dpm/numerics/high-resolution-tracking/set-subtet-intersection-tolerance text command). + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/use_particle_timestep_for_intersection_tolerance").execute(*args, **kwargs) + def enable_automatic_intersection_tolerance(self, *args, **kwargs): + """ + Enables/disables the automatic calculation of intersection tolerance. By default, the tolerance used in intersection calculations is scaled by the residence time of the particle in the cell to improve robustness. For most cases, the scaled tolerance is sufficient to identify all intersections of the particle trajectory and the subtet faces. You can set the intersection tolerance manually using the set-subtet-intersection-tolerance text command. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/enable_automatic_intersection_tolerance").execute(*args, **kwargs) + def set_film_spreading_parameter(self, *args, **kwargs): + """ + Set the spreading parameter for Lagrangian wallfilm particles. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/set_film_spreading_parameter").execute(*args, **kwargs) + def set_subtet_intersection_tolerance(self, *args, **kwargs): + """ + Specifies the tolerance used in intersection calculations. This tolerance will be scaled by the characteristic cell crossing time of the particle if the enable-automatic-intersection-tolerance? text command is enabled. If that option is disabled, the specified tolerance will be used without scaling. The default intersection tolerance is 10-5. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/set_subtet_intersection_tolerance").execute(*args, **kwargs) + + class barycentric_interpolation(TUIMenu): + """ + Enter the barycentric interpolation menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def interpolate_flow_solution_gradients(self, *args, **kwargs): + """ + When enabled, flow solution gradients are interpolated to the particle position. This can be useful when using physical models that depend on these gradients (for example, the thermophoretic force, pressure-gradient force, or virtual mass force). Interpolating the gradients also improves the accuracy and robustness of the trapezoidal numerics scheme, which is the default method for pathlines. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/interpolate_flow_solution_gradients").execute(*args, **kwargs) + def interpolate_temperature(self, *args, **kwargs): + """ + Enables/disables the barycentric interpolation of temperature to the particle position. The cell temperature is used by default in calculations of heat transfer to/from the particle. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/interpolate_temperature").execute(*args, **kwargs) + def interpolate_flow_density(self, *args, **kwargs): + """ + Enables/disables the barycentric interpolation of the flow density. This option is recommended when the density varies with position to avoid discontinuities in the interpolated variable at cell boundaries. For constant density flows, this option is unnecessary. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/interpolate_flow_density").execute(*args, **kwargs) + def interpolate_flow_cp(self, *args, **kwargs): + """ + Enables/disables the barycentric interpolation of specific heat to the particle position. This option is recommended when the specific heat varies with position to avoid discontinuities in the interpolated variable at cell boundaries. For flows with constant specific heat, this option is unnecessary. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/interpolate_flow_cp").execute(*args, **kwargs) + def interpolate_flow_viscosity(self, *args, **kwargs): + """ + Enables/disables the barycentric interpolation of flow viscosity to the particle position. This option is recommended when the flow viscosity varies with position to avoid discontinuities in the interpolated variable at cell boundaries. For flows with constant viscosity, this option is unnecessary. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/interpolate_flow_viscosity").execute(*args, **kwargs) + def interpolate_wallfilm_properties(self, *args, **kwargs): + """ + When enabled, the wall film properties (film height, film mass, and wall shear) are interpolated to the particle position. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/interpolate_wallfilm_properties").execute(*args, **kwargs) + def precompute_pdf_species(self, *args, **kwargs): + """ + When this option is enabled for premixed or non-premixed combustion simulations, the species composition in each cell is precomputed prior to tracking particles. This approach may improve performance for cases with many particles and relatively few cells. By default, this option is set to no, and ANSYS Fluent calculates the species composition during particle tracking. The solution results will be identical for both methods. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/precompute_pdf_species").execute(*args, **kwargs) + def zero_nodal_velocity_on_walls(self, *args, **kwargs): + """ + When enabled, sets the velocity at wall nodes to zero. (By default, the nodal velocities on walls are first reconstructed from cell and face values and then corrected to ensure that there are no velocity components directed towards the walls). This may be useful if you want to consider particle impingement on the walls. Note that enabling this option will more likely produce incomplete particles as some particles may settle on the walls. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/zero_nodal_velocity_on_walls").execute(*args, **kwargs) + def enable_transient_variable_interpolation(self, *args, **kwargs): + """ + Enable transient variable interpolation. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/enable_transient_variable_interpolation").execute(*args, **kwargs) + def nodal_reconstruction_frequency(self, *args, **kwargs): + """ + Update nodal reconstruction every N'th DPM iteration. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/nodal_reconstruction_frequency").execute(*args, **kwargs) + def user_interpolation_function(self, *args, **kwargs): + """ + Enter user interpolation function. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/user_interpolation_function").execute(*args, **kwargs) + + class particle_relocation(TUIMenu): + """ + Enter the particle relocation menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def wallfilm_relocation_tolerance_scale_factor(self, *args, **kwargs): + """ + Set the relocation tolerance scaling factor for wallfilm particles after remeshing. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/particle_relocation/wallfilm_relocation_tolerance_scale_factor").execute(*args, **kwargs) + def use_legacy_particle_location_method(self, *args, **kwargs): + """ + Enable legacy method of locating particles in cells. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/particle_relocation/use_legacy_particle_location_method").execute(*args, **kwargs) + def load_legacy_particles(self, *args, **kwargs): + """ + Load particles that were tracked without high-resolution tracking enabled. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/particle_relocation/load_legacy_particles").execute(*args, **kwargs) + def enhanced_cell_relocation_method(self, *args, **kwargs): + """ + Enable enhanced method of locating particles in cells. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/particle_relocation/enhanced_cell_relocation_method").execute(*args, **kwargs) + def overset_relocation_robustness_level(self, *args, **kwargs): + """ + Set the robustness level for particle relocation in overset meshes. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/particle_relocation/overset_relocation_robustness_level").execute(*args, **kwargs) + def enhanced_wallfilm_location_method(self, *args, **kwargs): + """ + Enable enhanced method of locating film particles on faces. + """ + return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/particle_relocation/enhanced_wallfilm_location_method").execute(*args, **kwargs) + + class options(TUIMenu): """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/activate_cell_zone").execute(*args, **kwargs) - def append_mesh(self, *args, **kwargs): + Enters the options menu to set optional models. """ - Appends new mesh. + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable_contour_plots(self, *args, **kwargs): + """ + Enables computation of mean and/or RMS values of additional discrete phase variables for postprocessing. + """ + return PyMenu(self.service, "/define/models/dpm/options/enable_contour_plots").execute(*args, **kwargs) + def ensemble_average(self, *args, **kwargs): + """ + Ensembles average cloud properties. + """ + return PyMenu(self.service, "/define/models/dpm/options/ensemble_average").execute(*args, **kwargs) + def particle_radiation(self, *args, **kwargs): + """ + Enables/disables particle radiation. + """ + return PyMenu(self.service, "/define/models/dpm/options/particle_radiation").execute(*args, **kwargs) + def track_in_absolute_frame(self, *args, **kwargs): + """ + Enables/disables tracking in absolute frame. + """ + return PyMenu(self.service, "/define/models/dpm/options/track_in_absolute_frame").execute(*args, **kwargs) + def thermophoretic_force(self, *args, **kwargs): + """ + Enables/disables thermophoretic force. + """ + return PyMenu(self.service, "/define/models/dpm/options/thermophoretic_force").execute(*args, **kwargs) + def convective_film_heat_transfer(self, *args, **kwargs): + """ + Enable/disable convection/conduction film to wall heat transfer model. + """ + return PyMenu(self.service, "/define/models/dpm/options/convective_film_heat_transfer").execute(*args, **kwargs) + def saffman_lift_force(self, *args, **kwargs): + """ + Enables/disables Saffman lift force. + """ + return PyMenu(self.service, "/define/models/dpm/options/saffman_lift_force").execute(*args, **kwargs) + def pressure_gradient_force(self, *args, **kwargs): + """ + Enables/disables inclusion of pressure gradient effects in the particle force balance. + """ + return PyMenu(self.service, "/define/models/dpm/options/pressure_gradient_force").execute(*args, **kwargs) + def virtual_mass_force(self, *args, **kwargs): + """ + Enables/disables inclusion of the virtual mass force in the particle force balance. + """ + return PyMenu(self.service, "/define/models/dpm/options/virtual_mass_force").execute(*args, **kwargs) + def two_way_coupling(self, *args, **kwargs): + """ + Enables/disables calculation of DPM sources in TKE equation. + """ + return PyMenu(self.service, "/define/models/dpm/options/two_way_coupling").execute(*args, **kwargs) + def remove_wall_film_temperature_limiter(self, *args, **kwargs): + """ + Answering yes at the prompt removes the wall temperature limiter for Lagrangian wall-film walls. If you enter no (default), two additional prompts will appear in the console allowing you to define the temperature difference above the boiling point and to enable/disable the reporting of the Leidenfrost temperature on the wall faces. + """ + return PyMenu(self.service, "/define/models/dpm/options/remove_wall_film_temperature_limiter").execute(*args, **kwargs) + def maximum_udf_species(self, *args, **kwargs): + """ + Specifies the maximum number of species that will be accessible from discrete phase model UDFs. Only species with indices up to this value are accessible in discrete phase model UDFs. + """ + return PyMenu(self.service, "/define/models/dpm/options/maximum_udf_species").execute(*args, **kwargs) + def brownian_motion(self, *args, **kwargs): + """ + Enables/disables Brownian motion of particles. + """ + return PyMenu(self.service, "/define/models/dpm/options/brownian_motion").execute(*args, **kwargs) + def stagger_spatially_standard_injections(self, *args, **kwargs): + """ + Enables/disables spatial staggering for standard (non-atomizer and non-solid-cone) injections. + """ + return PyMenu(self.service, "/define/models/dpm/options/stagger_spatially_standard_injections").execute(*args, **kwargs) + def stagger_spatially_atomizer_injections(self, *args, **kwargs): + """ + Enables/disables spatial staggering for atomizer and solid-cone injections. + """ + return PyMenu(self.service, "/define/models/dpm/options/stagger_spatially_atomizer_injections").execute(*args, **kwargs) + def stagger_temporally(self, *args, **kwargs): + """ + Enables/disables temporal staggering. + """ + return PyMenu(self.service, "/define/models/dpm/options/stagger_temporally").execute(*args, **kwargs) + def staggering_factor(self, *args, **kwargs): + """ + S + """ + return PyMenu(self.service, "/define/models/dpm/options/staggering_factor").execute(*args, **kwargs) + def stagger_radius(self, *args, **kwargs): + """ + Specifies the region over which to spatially stagger particles when particle-staggering is enabled for non-atomizer injections. + """ + return PyMenu(self.service, "/define/models/dpm/options/stagger_radius").execute(*args, **kwargs) + def uniform_mass_distribution_for_injections(self, *args, **kwargs): + """ + Specifies a uniform distribution of mass over the cross-section of solid cone and atomizer injections. This can become important when the mesh is smaller than the diameter (or another characteristic size) of the injection. + """ + return PyMenu(self.service, "/define/models/dpm/options/uniform_mass_distribution_for_injections").execute(*args, **kwargs) + def use_absolute_pressure_for_vaporization(self, *args, **kwargs): + """ + Determines whether the absolute pressure or constant operating pressure (specified in define/operating-conditions/operating-pressure) will be used in vaporization rates calculations. + """ + return PyMenu(self.service, "/define/models/dpm/options/use_absolute_pressure_for_vaporization").execute(*args, **kwargs) + def vaporization_options(self, *args, **kwargs): + """ + Sets Vaporization options. + """ + return PyMenu(self.service, "/define/models/dpm/options/vaporization_options").execute(*args, **kwargs) + def vaporization_heat_transfer_averaging(self, *args, **kwargs): + """ + Enables averaging of the Spalding heat transfer term for the convection/diffusion-controlled model. + """ + return PyMenu(self.service, "/define/models/dpm/options/vaporization_heat_transfer_averaging").execute(*args, **kwargs) + def allow_supercritical_pressure_vaporization(self, *args, **kwargs): + """ + Enforces the switching from vaporization to boiling even if the boiling point is not calculated from the vapor pressure data. If the pressure in your model is above critical you must retain the default setting (yes). This options is available only if whenPressure Dependent Boiling is enabled in the Physical Models tab of the Discrete Phase Models dialog box. For more details, see . + """ + return PyMenu(self.service, "/define/models/dpm/options/allow_supercritical_pressure_vaporization").execute(*args, **kwargs) + def treat_multicomponent_saturation_temperature_failure(self, *args, **kwargs): + """ + Enables/disables dumping multicomponent particle mass into the continuous phase if the saturation temperature calculation fails. + """ + return PyMenu(self.service, "/define/models/dpm/options/treat_multicomponent_saturation_temperature_failure").execute(*args, **kwargs) + def set_thermolysis_limit(self, *args, **kwargs): + """ + Sets the limit for the thermolysis model. + """ + return PyMenu(self.service, "/define/models/dpm/options/set_thermolysis_limit").execute(*args, **kwargs) + def lowest_volatiles_mass_fraction(self, *args, **kwargs): + """ + Set the lowest volatiles mass fraction. + """ + return PyMenu(self.service, "/define/models/dpm/options/lowest_volatiles_mass_fraction").execute(*args, **kwargs) + def erosion_accretion(self, *args, **kwargs): + """ + Enables/disables erosion/accretion. + """ + return PyMenu(self.service, "/define/models/dpm/options/erosion_accretion").execute(*args, **kwargs) + def init_erosion_accretion_rate(self, *args, **kwargs): + """ + Initializes the erosion/accretion rates with zero. + """ + return PyMenu(self.service, "/define/models/dpm/options/init_erosion_accretion_rate").execute(*args, **kwargs) + def step_report_sig_figures(self, *args, **kwargs): + """ + Sets significant figures in the step-by-step report. + """ + return PyMenu(self.service, "/define/models/dpm/options/step_report_sig_figures").execute(*args, **kwargs) + def include_lwf_particles_in_dpm_concentration(self, *args, **kwargs): + """ + Include LWF particle mass in DPM Concentration. + """ + return PyMenu(self.service, "/define/models/dpm/options/include_lwf_particles_in_dpm_concentration").execute(*args, **kwargs) + def current_positions_in_sample_file_format(self, *args, **kwargs): + """ + When enabled, generates a file containing particle current positions (step-by-step history report for unsteady tracking) in the sampling file format. + """ + return PyMenu(self.service, "/define/models/dpm/options/current_positions_in_sample_file_format").execute(*args, **kwargs) + def scr_urea_deposition_risk_analysis(self, *args, **kwargs): + """ + Enters the menu for setting up the risk for solids deposit formation for the Selective Catalytic Reduction (SCR) process. For more information, see . + """ + return PyMenu(self.service, "/define/models/dpm/options/scr_urea_deposition_risk_analysis").execute(*args, **kwargs) + + class parallel(TUIMenu): """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/append_mesh").execute(*args, **kwargs) - def append_mesh_data(self, *args, **kwargs): + Enters the parallel menu to set parameters for parallel DPM calculations. """ - Appends new mesh with data. + def __init__(self, path, service): + self.path = path + self.service = service + self.expert = self.__class__.expert(path + [("expert", None)], service) + super().__init__(path, service) + def enable_workpile(self, *args, **kwargs): + """ + Turns on/off particle workpile algorithm. This option is only available when the define/models/dpm/parallel/use-shared-memory option is selected. + """ + return PyMenu(self.service, "/define/models/dpm/parallel/enable_workpile").execute(*args, **kwargs) + def n_threads(self, *args, **kwargs): + """ + Sets the number of processors to use for DPM. This option is only available when the define/models/dpm/parallel/enable-workpile? option is enabled. + """ + return PyMenu(self.service, "/define/models/dpm/parallel/n_threads").execute(*args, **kwargs) + def report(self, *args, **kwargs): + """ + Prints particle workpile statistics. This option is only available when the define/models/dpm/parallel/enable-workpile? option is enabled. + """ + return PyMenu(self.service, "/define/models/dpm/parallel/report").execute(*args, **kwargs) + def use_shared_memory(self, *args, **kwargs): + """ + Specifies that the calculations are performed on shared-memory multiprocessor machines. + """ + return PyMenu(self.service, "/define/models/dpm/parallel/use_shared_memory").execute(*args, **kwargs) + def use_message_passing(self, *args, **kwargs): + """ + Specifies that the calculations are performed using cluster computing or shared-memory machines. With this option, the compute node processes themselves perform the particle work on their local partitions and particle migration to other compute nodes is implemented using message passing primitives. + """ + return PyMenu(self.service, "/define/models/dpm/parallel/use_message_passing").execute(*args, **kwargs) + def use_hybrid(self, *args, **kwargs): + """ + Specifies that the calculations are performed using multicore cluster computing or shared-memory machines. This option works in conjunction withopenmpi for a dynamic load balancing without migration of cells. + """ + return PyMenu(self.service, "/define/models/dpm/parallel/use_hybrid").execute(*args, **kwargs) + def fix_source_term_accumulation_order(self, *args, **kwargs): + """ + Enforce deterministic order of source term accumulation. + """ + return PyMenu(self.service, "/define/models/dpm/parallel/fix_source_term_accumulation_order").execute(*args, **kwargs) + def hybrid_2domain(self, *args, **kwargs): + """ + Enables/disables the use of a second domain for DPM particle tracking. + """ + return PyMenu(self.service, "/define/models/dpm/parallel/hybrid_2domain").execute(*args, **kwargs) + def hybrid_workpile(self, *args, **kwargs): + """ + Optimize multi-thread load balancing within each partition in hybrid-parallel DPM tracking. + """ + return PyMenu(self.service, "/define/models/dpm/parallel/hybrid_workpile").execute(*args, **kwargs) + def hybrid_collision_model(self, *args, **kwargs): + """ + An EXPERIMENTAL feature to allow 'hybrid' DPM parallel tracking with the collision / coalescence model. + """ + return PyMenu(self.service, "/define/models/dpm/parallel/hybrid_collision_model").execute(*args, **kwargs) + def hybrid_collision_unidirectional(self, *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. + """ + return PyMenu(self.service, "/define/models/dpm/parallel/hybrid_collision_unidirectional").execute(*args, **kwargs) + def hybrid_collision_variant(self, *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. + """ + return PyMenu(self.service, "/define/models/dpm/parallel/hybrid_collision_variant").execute(*args, **kwargs) + + class expert(TUIMenu): + """ + Enters the menu for expert DPM parallel text commands. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def partition_method_hybrid_2domain(self, *args, **kwargs): + """ + Enables/disables a partitioning method that is more granular and can yield faster calculations (especially for cases that are running on a low to moderate number of processors). This partitioning method is only applied when you use the DPM domain for the hybrid parallel DPM tracking mode (that is, when you have enabled the define/models/dpm/parallel/hybrid-2domain? text command). + """ + return PyMenu(self.service, "/define/models/dpm/parallel/expert/partition_method_hybrid_2domain").execute(*args, **kwargs) + + class splash_options(TUIMenu): """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/append_mesh_data").execute(*args, **kwargs) - def copy_move_cell_zone(self, *args, **kwargs): + Enters the splash option menu. """ - Creates a copy of a cell zone that is offset from the original either by a translational distance or a rotational angle. In the copied zone, the bounding face zones are all converted to walls, any existing cell data is initialized to a constant value, and non-conformal interfaces and dynamic zones are not copied; otherwise, the model settings are the same as in the original zone. Note that if you want the copied zone to be connected to existing zones, you must either fuse the boundaries (see ) or set up a non-conformal interface (see ). + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def orourke_splash_fraction(self, *args, **kwargs): + """ + Enables/disables the O’Rourke formulation (default for the Lagrangian Wall Film (LWF) model). If the O’Rourke formulation is disabled, the Stanton formulation (default for the Eulerian Wall Film (EWF) model) is used in a simulation. + """ + return PyMenu(self.service, "/define/models/dpm/splash_options/orourke_splash_fraction").execute(*args, **kwargs) + def splash_pdf_limiting(self, *args, **kwargs): + """ + Sets the splash pdf limiting method. Available methods are: the splash pdf tail limiting (default for the LWF model) and the splash pdf peak limiting (default for the EWF model). For the splash pdf peak limiting, you will be prompted to specify the peak limiting value. + """ + return PyMenu(self.service, "/define/models/dpm/splash_options/splash_pdf_limiting").execute(*args, **kwargs) + + class stripping_options(TUIMenu): """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/copy_move_cell_zone").execute(*args, **kwargs) - def create_all_shell_threads(self, *args, **kwargs): + Enters the stripping options menu. """ - Marks all finite thickness walls for shell creation. Shell zones will be created at the start of the iterations. + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def mass_coefficient(self, *args, **kwargs): + """ + Sets the mass coefficient ( in in the Theory Guide) + """ + return PyMenu(self.service, "/define/models/dpm/stripping_options/mass_coefficient").execute(*args, **kwargs) + def diameter_coefficient(self, *args, **kwargs): + """ + Sets the diameter coefficient ( in in the Theory Guide) + """ + return PyMenu(self.service, "/define/models/dpm/stripping_options/diameter_coefficient").execute(*args, **kwargs) + + class shell_conduction(TUIMenu): + """ + Enters the shell conduction models menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def multi_layer_shell(self, *args, **kwargs): """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/create_all_shell_threads").execute(*args, **kwargs) - def deactivate_cell_zone(self, *args, **kwargs): + Enables/disables the ability to define multi-layer shell conduction for walls. Note that the warped-face gradient correction (WFGC) is not supported when multi-layer shells are disabled. """ - Deactivates cell thread. + return PyMenu(self.service, "/define/models/shell_conduction/multi_layer_shell").execute(*args, **kwargs) + def enhanced_encapsulation(self, *args, **kwargs): """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/deactivate_cell_zone").execute(*args, **kwargs) - def recreate_all_shells(self, *args, **kwargs): + Enables/disables an enhanced routine for the encapsulation of coupled walls during mesh partitioning that is enabled by default when shell conduction and/or the surface to surface (S2S) radiation model is used. """ - Recreates shells on all the walls that were deleted using the command delete-all-shells. + return PyMenu(self.service, "/define/models/shell_conduction/enhanced_encapsulation").execute(*args, **kwargs) + def read_csv(self, *args, **kwargs): """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/recreate_all_shells").execute(*args, **kwargs) - def delete_all_shells(self, *args, **kwargs): + Defines the shell conduction settings by reading a CSV file. """ - Deletes all shell zones and switches off shell conduction on all the walls. These zones can be recreated using the command recreate-all-shells. + return PyMenu(self.service, "/define/models/shell_conduction/read_csv").execute(*args, **kwargs) + def write_csv(self, *args, **kwargs): """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/delete_all_shells").execute(*args, **kwargs) - def delete_cell_zone(self, *args, **kwargs): + Writes your saved shell conduction settings to a CSV file. """ - Deletes a cell thread. + return PyMenu(self.service, "/define/models/shell_conduction/write_csv").execute(*args, **kwargs) + def settings(self, *args, **kwargs): """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/delete_cell_zone").execute(*args, **kwargs) - def extrude_face_zone_delta(self, *args, **kwargs): + Enables shell conduction and defines the settings for any wall or group of walls by manually entering the number and properties of the layers. """ - Extrudes a face thread a specified distance based on a list of deltas. + return PyMenu(self.service, "/define/models/shell_conduction/settings").execute(*args, **kwargs) + def save_shell_zones(self, *args, **kwargs): """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/extrude_face_zone_delta").execute(*args, **kwargs) - def extrude_face_zone_para(self, *args, **kwargs): + Enables the saving of shell zones to case files. """ - Extrudes a face thread a specified distance based on a distance and a list of parametric locations between 0 and 1, for example, 0 0.2 0.4 0.8 1.0. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/extrude_face_zone_para").execute(*args, **kwargs) - def fuse_face_zones(self, *args, **kwargs): - """ - Attempts to fuse zones by removing duplicate faces and nodes. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/fuse_face_zones").execute(*args, **kwargs) - def list_zones(self, *args, **kwargs): - """ - Lists zone IDs, types, kinds, and names. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/list_zones").execute(*args, **kwargs) - def make_periodic(self, *args, **kwargs): - """ - Attempts to establish periodic/shadow face zone connectivity. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/make_periodic").execute(*args, **kwargs) - def create_periodic_interface(self, *args, **kwargs): - """ - Creates a conformal or non-conformal periodic interface. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/create_periodic_interface").execute(*args, **kwargs) - def scale_zone(self, *args, **kwargs): - """ - Scales individual cell zones. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/scale_zone").execute(*args, **kwargs) - def rotate_zone(self, *args, **kwargs): - """ - Rotates individual cell zones. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/rotate_zone").execute(*args, **kwargs) - def translate_zone(self, *args, **kwargs): - """ - Translates individual cell zones. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/translate_zone").execute(*args, **kwargs) - def matching_tolerance(self, *args, **kwargs): - """ - Sets normalized tolerance used for finding coincident nodes. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/matching_tolerance").execute(*args, **kwargs) - def merge_zones(self, *args, **kwargs): - """ - Merges zones of same type and condition into one. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/merge_zones").execute(*args, **kwargs) - def mrf_to_sliding_mesh(self, *args, **kwargs): - """ - Changes the motion specification from MRF to moving mesh. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/mrf_to_sliding_mesh").execute(*args, **kwargs) - def convert_all_solid_mrf_to_solid_motion(self, *args, **kwargs): - """ - Converts all solid zones using frame motion to instead use solid motion, copying the motion variable values for origin, axis, and velocities. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/convert_all_solid_mrf_to_solid_motion").execute(*args, **kwargs) - def orient_face_zone(self, *args, **kwargs): - """ - Orients the face zone. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/orient_face_zone").execute(*args, **kwargs) - def replace_zone(self, *args, **kwargs): - """ - Replaces cell zone. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/replace_zone").execute(*args, **kwargs) - def sep_cell_zone_mark(self, *args, **kwargs): - """ - Separates cell zone based on cell marking. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/sep_cell_zone_mark").execute(*args, **kwargs) - def sep_cell_zone_region(self, *args, **kwargs): - """ - Separates cell zone based on contiguous regions. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/sep_cell_zone_region").execute(*args, **kwargs) - def sep_face_zone_angle(self, *args, **kwargs): - """ - Separates face zone based on significant angle. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/sep_face_zone_angle").execute(*args, **kwargs) - def sep_face_zone_face(self, *args, **kwargs): - """ - Separates each face in zone into unique zone. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/sep_face_zone_face").execute(*args, **kwargs) - def sep_face_zone_mark(self, *args, **kwargs): - """ - Separates face zone based on cell marking. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/sep_face_zone_mark").execute(*args, **kwargs) - def sep_face_zone_region(self, *args, **kwargs): - """ - Separates face zone based on contiguous regions. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/sep_face_zone_region").execute(*args, **kwargs) - def slit_periodic(self, *args, **kwargs): - """ - Slits periodic zone into two symmetry zones. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/slit_periodic").execute(*args, **kwargs) - def slit_face_zone(self, *args, **kwargs): - """ - Slits two-sided wall into two connected wall zones. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/slit_face_zone").execute(*args, **kwargs) - def slit_interior_between_diff_solids(self, *args, **kwargs): - """ - Slits the interior zone between solid zones of differing materials to create a coupled wall. You will generally be prompted by Fluent if this is necessary. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/slit_interior_between_diff_solids").execute(*args, **kwargs) - def zone_name(self, *args, **kwargs): - """ - Gives a zone a new name. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/zone_name").execute(*args, **kwargs) - def zone_type(self, *args, **kwargs): - """ - Sets the type for a zone or multiple zones of the same category. You will be prompted for the name / ID of the zone to be changed and the new type for that zone. To change multiple zones, you can enter a list (separated by spaces and contained within a pair of parentheses) or use asterisks (*) as wildcards. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/zone_type").execute(*args, **kwargs) - def copy_mrf_to_mesh_motion(self, *args, **kwargs): - """ - Copies motion variable values for origin, axis, and velocities from Frame Motion to Mesh Motion. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/copy_mrf_to_mesh_motion").execute(*args, **kwargs) - def copy_mesh_to_mrf_motion(self, *args, **kwargs): - """ - Copies motion variable values for origin, axis, and velocities from Mesh Motion to Frame Motion. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/copy_mesh_to_mrf_motion").execute(*args, **kwargs) - def change_zone_state(self, *args, **kwargs): - """ - Sets the state (liquid or vapor) for a specific fluid zone. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/change_zone_state").execute(*args, **kwargs) - def change_zone_phase(self, *args, **kwargs): - """ - Change the realgas phase for a zone. - """ - return PyMenu(self.service, "/define/boundary_conditions/modify_zones/change_zone_phase").execute(*args, **kwargs) - - class periodic(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class pressure_far_field(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.p = self.__class__.p(path + [("p", None)], service) - self.m = self.__class__.m(path + [("m", None)], service) - self.coordinate_system = self.__class__.coordinate_system(path + [("coordinate_system", None)], service) - self.ni = self.__class__.ni(path + [("ni", None)], service) - self.nj = self.__class__.nj(path + [("nj", None)], service) - self.nk = self.__class__.nk(path + [("nk", None)], service) - self.ai = self.__class__.ai(path + [("ai", None)], service) - self.aj = self.__class__.aj(path + [("aj", None)], service) - self.ak = self.__class__.ak(path + [("ak", None)], service) - self.x_origin = self.__class__.x_origin(path + [("x_origin", None)], service) - self.y_origin = self.__class__.y_origin(path + [("y_origin", None)], service) - self.z_origin = self.__class__.z_origin(path + [("z_origin", None)], service) - self.ke_spec = self.__class__.ke_spec(path + [("ke_spec", None)], service) - self.nut = self.__class__.nut(path + [("nut", None)], service) - self.kl = self.__class__.kl(path + [("kl", None)], service) - self.intermit = self.__class__.intermit(path + [("intermit", None)], service) - self.k = self.__class__.k(path + [("k", None)], service) - self.e = self.__class__.e(path + [("e", None)], service) - self.o = self.__class__.o(path + [("o", None)], service) - self.v2 = self.__class__.v2(path + [("v2", None)], service) - self.turb_intensity = self.__class__.turb_intensity(path + [("turb_intensity", None)], service) - self.turb_length_scale = self.__class__.turb_length_scale(path + [("turb_length_scale", None)], service) - self.turb_hydraulic_diam = self.__class__.turb_hydraulic_diam(path + [("turb_hydraulic_diam", None)], service) - self.turb_viscosity_ratio = self.__class__.turb_viscosity_ratio(path + [("turb_viscosity_ratio", None)], service) - self.turb_viscosity_ratio_profile = self.__class__.turb_viscosity_ratio_profile(path + [("turb_viscosity_ratio_profile", None)], service) - self.rst_spec = self.__class__.rst_spec(path + [("rst_spec", None)], service) - self.uu = self.__class__.uu(path + [("uu", None)], service) - self.vv = self.__class__.vv(path + [("vv", None)], service) - self.ww = self.__class__.ww(path + [("ww", None)], service) - self.uv = self.__class__.uv(path + [("uv", None)], service) - self.vw = self.__class__.vw(path + [("vw", None)], service) - self.uw = self.__class__.uw(path + [("uw", None)], service) - self.ksgs_spec = self.__class__.ksgs_spec(path + [("ksgs_spec", None)], service) - self.ksgs = self.__class__.ksgs(path + [("ksgs", None)], service) - self.sgs_turb_intensity = self.__class__.sgs_turb_intensity(path + [("sgs_turb_intensity", None)], service) - self.geom_disable = self.__class__.geom_disable(path + [("geom_disable", None)], service) - self.geom_dir_spec = self.__class__.geom_dir_spec(path + [("geom_dir_spec", None)], service) - self.geom_dir_x = self.__class__.geom_dir_x(path + [("geom_dir_x", None)], service) - self.geom_dir_y = self.__class__.geom_dir_y(path + [("geom_dir_y", None)], service) - self.geom_dir_z = self.__class__.geom_dir_z(path + [("geom_dir_z", None)], service) - self.geom_levels = self.__class__.geom_levels(path + [("geom_levels", None)], service) - self.geom_bgthread = self.__class__.geom_bgthread(path + [("geom_bgthread", None)], service) - self.t = self.__class__.t(path + [("t", None)], service) - self.non_equil_boundary = self.__class__.non_equil_boundary(path + [("non_equil_boundary", None)], service) - self.tve = self.__class__.tve(path + [("tve", None)], service) - - class p(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/models/shell_conduction/save_shell_zones").execute(*args, **kwargs) - class m(metaclass=PyMenuMeta): + class system_coupling_settings(TUIMenu): + """ + Enters the system coupling menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.htc = self.__class__.htc(path + [("htc", None)], service) + super().__init__(path, service) + def use_face_or_element_based_data_transfer(self, *args, **kwargs): """ + Answering yes at the prompt enables Fluent to use element data for mapping surface conservative quantities such as surface forces and heat flows. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coordinate_system(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/system_coupling_settings/use_face_or_element_based_data_transfer").execute(*args, **kwargs) + def update_rigid_body_mesh_motion_before_mesh_transfer(self, *args, **kwargs): """ + SC Enable/disable mesh motion. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ni(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/system_coupling_settings/update_rigid_body_mesh_motion_before_mesh_transfer").execute(*args, **kwargs) + def specify_system_coupling_volumetric_cell_zones(self, *args, **kwargs): """ + Enable/disable volumetric cell zones. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/models/system_coupling_settings/specify_system_coupling_volumetric_cell_zones").execute(*args, **kwargs) - class nj(metaclass=PyMenuMeta): + class htc(TUIMenu): """ + Enter the heat transfer coeficient menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + self.unsteady_statistics = self.__class__.unsteady_statistics(path + [("unsteady_statistics", None)], service) + self.htc_calculation_method = self.__class__.htc_calculation_method(path + [("htc_calculation_method", None)], service) + super().__init__(path, service) - class nk(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class unsteady_statistics(TUIMenu): + """ + Enter the unsteady statistics menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def sc_enable_sub_stepping_option_per_coupling_step(self, *args, **kwargs): + """ + Enable/disable sub stepping option per coupling step. + """ + return PyMenu(self.service, "/define/models/system_coupling_settings/htc/unsteady_statistics/sc_enable_sub_stepping_option_per_coupling_step").execute(*args, **kwargs) - class ai(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class htc_calculation_method(TUIMenu): + """ + Enter the htc calculation menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def use_tref_in_htc_calculation(self, *args, **kwargs): + """ + Enable/disable tref in htc computation. + """ + return PyMenu(self.service, "/define/models/system_coupling_settings/htc/htc_calculation_method/use_tref_in_htc_calculation").execute(*args, **kwargs) + def use_yplus_based_htc_calculation(self, *args, **kwargs): + """ + Enable/disable yplus in htc computation. + """ + return PyMenu(self.service, "/define/models/system_coupling_settings/htc/htc_calculation_method/use_yplus_based_htc_calculation").execute(*args, **kwargs) + def use_wall_function_based_htc(self, *args, **kwargs): + """ + Enable/disable wall function based htc computation. + """ + return PyMenu(self.service, "/define/models/system_coupling_settings/htc/htc_calculation_method/use_wall_function_based_htc").execute(*args, **kwargs) - class aj(metaclass=PyMenuMeta): + class cht(TUIMenu): + """ + Enters the cht (conjugate heat transfer) menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.explicit_time_averaged_coupling = self.__class__.explicit_time_averaged_coupling(path + [("explicit_time_averaged_coupling", None)], service) + super().__init__(path, service) + def read_mi_type_wall(self, *args, **kwargs): """ + Read mapped interface data settings from a csv file. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ak(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/cht/read_mi_type_wall").execute(*args, **kwargs) + def write_mi_type_wall(self, *args, **kwargs): """ + Write mapped interface settings to a scv file. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class x_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/cht/write_mi_type_wall").execute(*args, **kwargs) + def implicit_coupling(self, *args, **kwargs): """ + Enables the implicit mapping scheme for any fluid-solid pair with a mapped mesh interface (only required for cases set up in version 19.2 or earlier). """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/models/cht/implicit_coupling").execute(*args, **kwargs) - class y_origin(metaclass=PyMenuMeta): + class explicit_time_averaged_coupling(TUIMenu): """ + Enters the explicit time averaged thermal coupling menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def conformal_coupled_walls(self, *args, **kwargs): + """ + Select fluid-solid coupled walls (without shell) for explicit coupling using time averaged thermal variables. + """ + return PyMenu(self.service, "/define/models/cht/explicit_time_averaged_coupling/conformal_coupled_walls").execute(*args, **kwargs) + def mapped_interfaces(self, *args, **kwargs): + """ + Select fluid-solid mapped interfaces for explicit coupling using time averaged thermal variables. + """ + return PyMenu(self.service, "/define/models/cht/explicit_time_averaged_coupling/mapped_interfaces").execute(*args, **kwargs) + def coupling_controls(self, *args, **kwargs): + """ + Specify explcit coupling controls. + """ + return PyMenu(self.service, "/define/models/cht/explicit_time_averaged_coupling/coupling_controls").execute(*args, **kwargs) + def fuse_explicit_cht_zones(self, *args, **kwargs): + """ + Fuse slitted conformal coupled walls marked for transient explicit thermal coupling. + """ + return PyMenu(self.service, "/define/models/cht/explicit_time_averaged_coupling/fuse_explicit_cht_zones").execute(*args, **kwargs) - class z_origin(metaclass=PyMenuMeta): + class two_temperature(TUIMenu): + """ + Enters the Two-Temperature model menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable(self, *args, **kwargs): """ + Enables/disables the Two-Temperature model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ke_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/two_temperature/enable").execute(*args, **kwargs) + def robustness_enhancement(self, *args, **kwargs): """ + Enables/disables the robustness enhancement, which is on by default. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nut(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/two_temperature/robustness_enhancement").execute(*args, **kwargs) + def nasa9_enhancement(self, *args, **kwargs): """ + Apply nasa9 robustness enhancements in the two-temperature model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class kl(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/two_temperature/nasa9_enhancement").execute(*args, **kwargs) + def set_verbosity(self, *args, **kwargs): """ + Specifies the level of detail printed in the console about the Two-Temperature model. For a verbosity of one, Fluent will print the number of cells that reach the temperature limit, have an excessive temperature change, or get a negative temperature. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/models/two_temperature/set_verbosity").execute(*args, **kwargs) - class intermit(metaclass=PyMenuMeta): + class multiphase(TUIMenu): + """ + Enters the multiphase model menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.phases = self.__class__.phases(path + [("phases", None)], service) + self.wet_steam = self.__class__.wet_steam(path + [("wet_steam", None)], service) + self.population_balance = self.__class__.population_balance(path + [("population_balance", None)], service) + self.explicit_expert_options = self.__class__.explicit_expert_options(path + [("explicit_expert_options", None)], service) + super().__init__(path, service) + def model(self, *args, **kwargs): """ + Specifies multiphase model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class k(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/multiphase/model").execute(*args, **kwargs) + def number_of_phases(self, *args, **kwargs): """ + Specifies the number of phases. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class e(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/multiphase/number_of_phases").execute(*args, **kwargs) + def regime_transition_modeling(self, *args, **kwargs): """ + Enables the Algebraic Interfacial Area Density (AIAD) model and sets the AIAD secondary continuous phase and the secondary entrained phase. Entering 0 as a phase ID cancels any previous phase selection. Note that you must define the phases in your simulation using the define/phases/ text command prior to using the regime-transition-modeling text command. This option is available only with the Eulerian multiphase model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class o(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/multiphase/regime_transition_modeling").execute(*args, **kwargs) + def eulerian_parameters(self, *args, **kwargs): """ + Specifies Eulerian parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class v2(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/multiphase/eulerian_parameters").execute(*args, **kwargs) + def volume_fraction_parameters(self, *args, **kwargs): """ + Specifies volume fraction parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_intensity(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/multiphase/volume_fraction_parameters").execute(*args, **kwargs) + def boiling_model_options(self, *args, **kwargs): """ + Specifies the boiling model options. You can choose theRPI boiling model,Non-equilibrium boiling, orCritical heat flux. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_length_scale(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/multiphase/boiling_model_options").execute(*args, **kwargs) + def mixture_parameters(self, *args, **kwargs): """ + Specifies mixture parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_hydraulic_diam(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/multiphase/mixture_parameters").execute(*args, **kwargs) + def body_force_formulation(self, *args, **kwargs): """ + Specifies body force formulation. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_viscosity_ratio(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/multiphase/body_force_formulation").execute(*args, **kwargs) + def coupled_level_set(self, *args, **kwargs): """ + Enables coupled level set interface tracking method. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_viscosity_ratio_profile(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/multiphase/coupled_level_set").execute(*args, **kwargs) + def vof_sub_models(self, *args, **kwargs): """ + Enables the Open Channel sub-model and/or the Open Channel Wave Boundary Condition sub-model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class rst_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/multiphase/vof_sub_models").execute(*args, **kwargs) + def interface_modeling_options(self, *args, **kwargs): """ + Specifies interface modeling options. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uu(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/multiphase/interface_modeling_options").execute(*args, **kwargs) + def expert_options(self, *args, **kwargs): """ + Expert Options. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/models/multiphase/expert_options").execute(*args, **kwargs) - class vv(metaclass=PyMenuMeta): + class phases(TUIMenu): """ + Enter the phases menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + self.set_domain_properties = self.__class__.set_domain_properties(path + [("set_domain_properties", None)], service) + self.iac_expert = self.__class__.iac_expert(path + [("iac_expert", None)], service) + super().__init__(path, service) - class ww(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class set_domain_properties(TUIMenu): + """ + Enter the menu to set domain properties. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.interaction_domain = self.__class__.interaction_domain(path + [("interaction_domain", None)], service) + super().__init__(path, service) + def change_phases_names(self, *args, **kwargs): + """ + Change names for all defined phases?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/change_phases_names").execute(*args, **kwargs) + def phase_domains(self, *args, **kwargs): + """ + Enter the menu to select a specific phase domain. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/phase_domains").execute(*args, **kwargs) - class uv(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class interaction_domain(TUIMenu): + """ + Enter the menu to set the interaction domain properties. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.forces = self.__class__.forces(path + [("forces", None)], service) + self.heat_mass_reactions = self.__class__.heat_mass_reactions(path + [("heat_mass_reactions", None)], service) + self.interfacial_area = self.__class__.interfacial_area(path + [("interfacial_area", None)], service) + self.model_transition = self.__class__.model_transition(path + [("model_transition", None)], service) + self.numerics = self.__class__.numerics(path + [("numerics", None)], service) + super().__init__(path, service) - class vw(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class forces(TUIMenu): + """ + Enter the menu to set interfacial forces related models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) + self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) + self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) + self.lift = self.__class__.lift(path + [("lift", None)], service) + self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) + self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) + super().__init__(path, service) + def drag(self, *args, **kwargs): + """ + Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/drag").execute(*args, **kwargs) + def heat_coeff(self, *args, **kwargs): + """ + Specify the heat transfer coefficient function between each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/heat_coeff").execute(*args, **kwargs) + def interfacial_area(self, *args, **kwargs): + """ + Set the interfacial area parameters for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interfacial_area").execute(*args, **kwargs) + def mass_transfer(self, *args, **kwargs): + """ + Specify the mass transfer mechanisms. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/mass_transfer").execute(*args, **kwargs) + def model_transition(self, *args, **kwargs): + """ + Set the model transition mechanism. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/model_transition").execute(*args, **kwargs) + def reactions(self, *args, **kwargs): + """ + Define multiple heterogeneous reactions and stoichiometry. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/reactions").execute(*args, **kwargs) + def restitution(self, *args, **kwargs): + """ + Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/restitution").execute(*args, **kwargs) + def slip_velocity(self, *args, **kwargs): + """ + Specify the slip velocity function for each secondary phase with respect to the primary phase. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/slip_velocity").execute(*args, **kwargs) + def turbulence_interaction(self, *args, **kwargs): + """ + Specify the turbulence interaction model for each primary-secondary phase pair. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/turbulence_interaction").execute(*args, **kwargs) + def turbulent_dispersion(self, *args, **kwargs): + """ + Specify the turbulent dispersion model for each primary-secondary phase pair. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/turbulent_dispersion").execute(*args, **kwargs) + def wall_lubrication(self, *args, **kwargs): + """ + Specify the wall lubrication model for each primary-secondary phase pair. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/wall_lubrication").execute(*args, **kwargs) - class uw(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ksgs_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ksgs(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sgs_turb_intensity(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geom_disable(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geom_dir_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geom_dir_x(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class cavitation(TUIMenu): + """ + Enter the menu to set cavitation models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/wall_adhesion").execute(*args, **kwargs) - class geom_dir_y(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class interphase_discretization(TUIMenu): + """ + Enter the menu to set interphase discretization models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - class geom_dir_z(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class interphase_viscous_dissipation(TUIMenu): + """ + Enter the menu to set interphase viscous dissipation related models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - class geom_levels(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class lift(TUIMenu): + """ + Enter the menu to set lift models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/wall_adhesion").execute(*args, **kwargs) - class geom_bgthread(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class surface_tension(TUIMenu): + """ + Enter the menu to set surface tension models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/wall_adhesion").execute(*args, **kwargs) - class t(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class non_equil_boundary(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class tve(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class pressure_inlet(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.frame_of_reference = self.__class__.frame_of_reference(path + [("frame_of_reference", None)], service) - self.p0 = self.__class__.p0(path + [("p0", None)], service) - self.p = self.__class__.p(path + [("p", None)], service) - self.direction_spec = self.__class__.direction_spec(path + [("direction_spec", None)], service) - self.coordinate_system = self.__class__.coordinate_system(path + [("coordinate_system", None)], service) - self.ni = self.__class__.ni(path + [("ni", None)], service) - self.nj = self.__class__.nj(path + [("nj", None)], service) - self.nk = self.__class__.nk(path + [("nk", None)], service) - self.ni2 = self.__class__.ni2(path + [("ni2", None)], service) - self.nj2 = self.__class__.nj2(path + [("nj2", None)], service) - self.nk2 = self.__class__.nk2(path + [("nk2", None)], service) - self.ai = self.__class__.ai(path + [("ai", None)], service) - self.aj = self.__class__.aj(path + [("aj", None)], service) - self.ak = self.__class__.ak(path + [("ak", None)], service) - self.x_origin = self.__class__.x_origin(path + [("x_origin", None)], service) - self.y_origin = self.__class__.y_origin(path + [("y_origin", None)], service) - self.z_origin = self.__class__.z_origin(path + [("z_origin", None)], service) - self.vm_number_of_vortices = self.__class__.vm_number_of_vortices(path + [("vm_number_of_vortices", None)], service) - self.vm_streamwise_fluct = self.__class__.vm_streamwise_fluct(path + [("vm_streamwise_fluct", None)], service) - self.vm_mass_conservation = self.__class__.vm_mass_conservation(path + [("vm_mass_conservation", None)], service) - self.volumetric_synthetic_turbulence_generator = self.__class__.volumetric_synthetic_turbulence_generator(path + [("volumetric_synthetic_turbulence_generator", None)], service) - self.volumetric_synthetic_turbulence_generator_option = self.__class__.volumetric_synthetic_turbulence_generator_option(path + [("volumetric_synthetic_turbulence_generator_option", None)], service) - self.volumetric_synthetic_turbulence_generator_option_thickness = self.__class__.volumetric_synthetic_turbulence_generator_option_thickness(path + [("volumetric_synthetic_turbulence_generator_option_thickness", None)], service) - self.prevent_reverse_flow = self.__class__.prevent_reverse_flow(path + [("prevent_reverse_flow", None)], service) - self.ke_spec = self.__class__.ke_spec(path + [("ke_spec", None)], service) - self.nut = self.__class__.nut(path + [("nut", None)], service) - self.kl = self.__class__.kl(path + [("kl", None)], service) - self.intermit = self.__class__.intermit(path + [("intermit", None)], service) - self.k = self.__class__.k(path + [("k", None)], service) - self.e = self.__class__.e(path + [("e", None)], service) - self.o = self.__class__.o(path + [("o", None)], service) - self.v2 = self.__class__.v2(path + [("v2", None)], service) - self.turb_intensity = self.__class__.turb_intensity(path + [("turb_intensity", None)], service) - self.turb_length_scale = self.__class__.turb_length_scale(path + [("turb_length_scale", None)], service) - self.turb_hydraulic_diam = self.__class__.turb_hydraulic_diam(path + [("turb_hydraulic_diam", None)], service) - self.turb_viscosity_ratio = self.__class__.turb_viscosity_ratio(path + [("turb_viscosity_ratio", None)], service) - self.turb_viscosity_ratio_profile = self.__class__.turb_viscosity_ratio_profile(path + [("turb_viscosity_ratio_profile", None)], service) - self.rst_spec = self.__class__.rst_spec(path + [("rst_spec", None)], service) - self.uu = self.__class__.uu(path + [("uu", None)], service) - self.vv = self.__class__.vv(path + [("vv", None)], service) - self.ww = self.__class__.ww(path + [("ww", None)], service) - self.uv = self.__class__.uv(path + [("uv", None)], service) - self.vw = self.__class__.vw(path + [("vw", None)], service) - self.uw = self.__class__.uw(path + [("uw", None)], service) - self.ksgs_spec = self.__class__.ksgs_spec(path + [("ksgs_spec", None)], service) - self.ksgs = self.__class__.ksgs(path + [("ksgs", None)], service) - self.sgs_turb_intensity = self.__class__.sgs_turb_intensity(path + [("sgs_turb_intensity", None)], service) - self.les_spec_name = self.__class__.les_spec_name(path + [("les_spec_name", None)], service) - self.wsf = self.__class__.wsf(path + [("wsf", None)], service) - self.wsb = self.__class__.wsb(path + [("wsb", None)], service) - self.wsn = self.__class__.wsn(path + [("wsn", None)], service) - self.ac_options = self.__class__.ac_options(path + [("ac_options", None)], service) - self.ac_wave = self.__class__.ac_wave(path + [("ac_wave", None)], service) - self.impedance_0 = self.__class__.impedance_0(path + [("impedance_0", None)], service) - self.t0 = self.__class__.t0(path + [("t0", None)], service) - - class frame_of_reference(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class p0(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class p(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class direction_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coordinate_system(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ni(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nj(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class virtual_mass(TUIMenu): + """ + Enter the menu to set virtual mass models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/wall_adhesion").execute(*args, **kwargs) - class nk(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class heat_mass_reactions(TUIMenu): + """ + Enter the menu to set heat, mass-transfer, or reaction related models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) + self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) + self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) + self.lift = self.__class__.lift(path + [("lift", None)], service) + self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) + self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) + super().__init__(path, service) + def drag(self, *args, **kwargs): + """ + Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/drag").execute(*args, **kwargs) + def heat_coeff(self, *args, **kwargs): + """ + Specify the heat transfer coefficient function between each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/heat_coeff").execute(*args, **kwargs) + def interfacial_area(self, *args, **kwargs): + """ + Set the interfacial area parameters for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interfacial_area").execute(*args, **kwargs) + def mass_transfer(self, *args, **kwargs): + """ + Specify the mass transfer mechanisms. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/mass_transfer").execute(*args, **kwargs) + def model_transition(self, *args, **kwargs): + """ + Set the model transition mechanism. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/model_transition").execute(*args, **kwargs) + def reactions(self, *args, **kwargs): + """ + Define multiple heterogeneous reactions and stoichiometry. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/reactions").execute(*args, **kwargs) + def restitution(self, *args, **kwargs): + """ + Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/restitution").execute(*args, **kwargs) + def slip_velocity(self, *args, **kwargs): + """ + Specify the slip velocity function for each secondary phase with respect to the primary phase. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/slip_velocity").execute(*args, **kwargs) + def turbulence_interaction(self, *args, **kwargs): + """ + Specify the turbulence interaction model for each primary-secondary phase pair. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/turbulence_interaction").execute(*args, **kwargs) + def turbulent_dispersion(self, *args, **kwargs): + """ + Specify the turbulent dispersion model for each primary-secondary phase pair. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/turbulent_dispersion").execute(*args, **kwargs) + def wall_lubrication(self, *args, **kwargs): + """ + Specify the wall lubrication model for each primary-secondary phase pair. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/wall_lubrication").execute(*args, **kwargs) - class ni2(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class cavitation(TUIMenu): + """ + Enter the menu to set cavitation models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/wall_adhesion").execute(*args, **kwargs) - class nj2(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class interphase_discretization(TUIMenu): + """ + Enter the menu to set interphase discretization models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - class nk2(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class interphase_viscous_dissipation(TUIMenu): + """ + Enter the menu to set interphase viscous dissipation related models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - class ai(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class aj(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ak(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class x_origin(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class y_origin(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class z_origin(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vm_number_of_vortices(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vm_streamwise_fluct(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vm_mass_conservation(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class volumetric_synthetic_turbulence_generator(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class volumetric_synthetic_turbulence_generator_option(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class lift(TUIMenu): + """ + Enter the menu to set lift models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/wall_adhesion").execute(*args, **kwargs) - class volumetric_synthetic_turbulence_generator_option_thickness(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class surface_tension(TUIMenu): + """ + Enter the menu to set surface tension models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/wall_adhesion").execute(*args, **kwargs) - class prevent_reverse_flow(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class virtual_mass(TUIMenu): + """ + Enter the menu to set virtual mass models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/wall_adhesion").execute(*args, **kwargs) - class ke_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class interfacial_area(TUIMenu): + """ + Enter the menu to set interfacial area models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) + self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) + self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) + self.lift = self.__class__.lift(path + [("lift", None)], service) + self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) + self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) + super().__init__(path, service) + def drag(self, *args, **kwargs): + """ + Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/drag").execute(*args, **kwargs) + def heat_coeff(self, *args, **kwargs): + """ + Specify the heat transfer coefficient function between each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/heat_coeff").execute(*args, **kwargs) + def interfacial_area(self, *args, **kwargs): + """ + Set the interfacial area parameters for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interfacial_area").execute(*args, **kwargs) + def mass_transfer(self, *args, **kwargs): + """ + Specify the mass transfer mechanisms. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/mass_transfer").execute(*args, **kwargs) + def model_transition(self, *args, **kwargs): + """ + Set the model transition mechanism. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/model_transition").execute(*args, **kwargs) + def reactions(self, *args, **kwargs): + """ + Define multiple heterogeneous reactions and stoichiometry. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/reactions").execute(*args, **kwargs) + def restitution(self, *args, **kwargs): + """ + Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/restitution").execute(*args, **kwargs) + def slip_velocity(self, *args, **kwargs): + """ + Specify the slip velocity function for each secondary phase with respect to the primary phase. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/slip_velocity").execute(*args, **kwargs) + def turbulence_interaction(self, *args, **kwargs): + """ + Specify the turbulence interaction model for each primary-secondary phase pair. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/turbulence_interaction").execute(*args, **kwargs) + def turbulent_dispersion(self, *args, **kwargs): + """ + Specify the turbulent dispersion model for each primary-secondary phase pair. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/turbulent_dispersion").execute(*args, **kwargs) + def wall_lubrication(self, *args, **kwargs): + """ + Specify the wall lubrication model for each primary-secondary phase pair. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/wall_lubrication").execute(*args, **kwargs) - class nut(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class cavitation(TUIMenu): + """ + Enter the menu to set cavitation models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/wall_adhesion").execute(*args, **kwargs) - class kl(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class intermit(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class k(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class e(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class o(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class v2(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class interphase_discretization(TUIMenu): + """ + Enter the menu to set interphase discretization models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - class turb_intensity(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class interphase_viscous_dissipation(TUIMenu): + """ + Enter the menu to set interphase viscous dissipation related models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - class turb_length_scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class lift(TUIMenu): + """ + Enter the menu to set lift models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/wall_adhesion").execute(*args, **kwargs) - class turb_hydraulic_diam(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class surface_tension(TUIMenu): + """ + Enter the menu to set surface tension models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/wall_adhesion").execute(*args, **kwargs) - class turb_viscosity_ratio(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class virtual_mass(TUIMenu): + """ + Enter the menu to set virtual mass models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/wall_adhesion").execute(*args, **kwargs) - class turb_viscosity_ratio_profile(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class rst_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uu(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vv(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ww(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uv(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vw(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uw(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ksgs_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ksgs(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class model_transition(TUIMenu): + """ + Enter the menu to set model transition mechanisms. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) + self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) + self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) + self.lift = self.__class__.lift(path + [("lift", None)], service) + self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) + self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) + super().__init__(path, service) + def drag(self, *args, **kwargs): + """ + Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/drag").execute(*args, **kwargs) + def heat_coeff(self, *args, **kwargs): + """ + Specify the heat transfer coefficient function between each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/heat_coeff").execute(*args, **kwargs) + def interfacial_area(self, *args, **kwargs): + """ + Set the interfacial area parameters for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interfacial_area").execute(*args, **kwargs) + def mass_transfer(self, *args, **kwargs): + """ + Specify the mass transfer mechanisms. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/mass_transfer").execute(*args, **kwargs) + def model_transition(self, *args, **kwargs): + """ + Set the model transition mechanism. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/model_transition").execute(*args, **kwargs) + def reactions(self, *args, **kwargs): + """ + Define multiple heterogeneous reactions and stoichiometry. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/reactions").execute(*args, **kwargs) + def restitution(self, *args, **kwargs): + """ + Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/restitution").execute(*args, **kwargs) + def slip_velocity(self, *args, **kwargs): + """ + Specify the slip velocity function for each secondary phase with respect to the primary phase. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/slip_velocity").execute(*args, **kwargs) + def turbulence_interaction(self, *args, **kwargs): + """ + Specify the turbulence interaction model for each primary-secondary phase pair. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/turbulence_interaction").execute(*args, **kwargs) + def turbulent_dispersion(self, *args, **kwargs): + """ + Specify the turbulent dispersion model for each primary-secondary phase pair. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/turbulent_dispersion").execute(*args, **kwargs) + def wall_lubrication(self, *args, **kwargs): + """ + Specify the wall lubrication model for each primary-secondary phase pair. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/wall_lubrication").execute(*args, **kwargs) - class sgs_turb_intensity(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class cavitation(TUIMenu): + """ + Enter the menu to set cavitation models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/wall_adhesion").execute(*args, **kwargs) - class les_spec_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class interphase_discretization(TUIMenu): + """ + Enter the menu to set interphase discretization models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - class wsf(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class interphase_viscous_dissipation(TUIMenu): + """ + Enter the menu to set interphase viscous dissipation related models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - class wsb(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class lift(TUIMenu): + """ + Enter the menu to set lift models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/wall_adhesion").execute(*args, **kwargs) - class wsn(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ac_options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ac_wave(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class impedance_0(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class t0(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class pressure_outlet(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.prevent_reverse_flow = self.__class__.prevent_reverse_flow(path + [("prevent_reverse_flow", None)], service) - self.radial = self.__class__.radial(path + [("radial", None)], service) - self.gen_nrbc_spec = self.__class__.gen_nrbc_spec(path + [("gen_nrbc_spec", None)], service) - self.avg_press_spec = self.__class__.avg_press_spec(path + [("avg_press_spec", None)], service) - self.avg_option = self.__class__.avg_option(path + [("avg_option", None)], service) - self.targeted_mf_boundary = self.__class__.targeted_mf_boundary(path + [("targeted_mf_boundary", None)], service) - self.targeted_mf = self.__class__.targeted_mf(path + [("targeted_mf", None)], service) - self.targeted_mf_pmax = self.__class__.targeted_mf_pmax(path + [("targeted_mf_pmax", None)], service) - self.targeted_mf_pmin = self.__class__.targeted_mf_pmin(path + [("targeted_mf_pmin", None)], service) - self.press_spec_gen = self.__class__.press_spec_gen(path + [("press_spec_gen", None)], service) - self.p_backflow_spec = self.__class__.p_backflow_spec(path + [("p_backflow_spec", None)], service) - self.p_backflow_spec_gen = self.__class__.p_backflow_spec_gen(path + [("p_backflow_spec_gen", None)], service) - self.ac_options = self.__class__.ac_options(path + [("ac_options", None)], service) - self.ac_wave = self.__class__.ac_wave(path + [("ac_wave", None)], service) - self.impedance_0 = self.__class__.impedance_0(path + [("impedance_0", None)], service) - self.p = self.__class__.p(path + [("p", None)], service) - self.p_profile_multiplier = self.__class__.p_profile_multiplier(path + [("p_profile_multiplier", None)], service) - self.direction_spec = self.__class__.direction_spec(path + [("direction_spec", None)], service) - self.frame_of_reference = self.__class__.frame_of_reference(path + [("frame_of_reference", None)], service) - self.coordinate_system = self.__class__.coordinate_system(path + [("coordinate_system", None)], service) - self.ni = self.__class__.ni(path + [("ni", None)], service) - self.nj = self.__class__.nj(path + [("nj", None)], service) - self.nk = self.__class__.nk(path + [("nk", None)], service) - self.ai = self.__class__.ai(path + [("ai", None)], service) - self.aj = self.__class__.aj(path + [("aj", None)], service) - self.ak = self.__class__.ak(path + [("ak", None)], service) - self.x_origin = self.__class__.x_origin(path + [("x_origin", None)], service) - self.y_origin = self.__class__.y_origin(path + [("y_origin", None)], service) - self.z_origin = self.__class__.z_origin(path + [("z_origin", None)], service) - self.ke_spec = self.__class__.ke_spec(path + [("ke_spec", None)], service) - self.nut = self.__class__.nut(path + [("nut", None)], service) - self.kl = self.__class__.kl(path + [("kl", None)], service) - self.intermit = self.__class__.intermit(path + [("intermit", None)], service) - self.k = self.__class__.k(path + [("k", None)], service) - self.e = self.__class__.e(path + [("e", None)], service) - self.o = self.__class__.o(path + [("o", None)], service) - self.v2 = self.__class__.v2(path + [("v2", None)], service) - self.turb_intensity = self.__class__.turb_intensity(path + [("turb_intensity", None)], service) - self.turb_length_scale = self.__class__.turb_length_scale(path + [("turb_length_scale", None)], service) - self.turb_hydraulic_diam = self.__class__.turb_hydraulic_diam(path + [("turb_hydraulic_diam", None)], service) - self.turb_viscosity_ratio = self.__class__.turb_viscosity_ratio(path + [("turb_viscosity_ratio", None)], service) - self.turb_viscosity_ratio_profile = self.__class__.turb_viscosity_ratio_profile(path + [("turb_viscosity_ratio_profile", None)], service) - self.rst_spec = self.__class__.rst_spec(path + [("rst_spec", None)], service) - self.uu = self.__class__.uu(path + [("uu", None)], service) - self.vv = self.__class__.vv(path + [("vv", None)], service) - self.ww = self.__class__.ww(path + [("ww", None)], service) - self.uv = self.__class__.uv(path + [("uv", None)], service) - self.vw = self.__class__.vw(path + [("vw", None)], service) - self.uw = self.__class__.uw(path + [("uw", None)], service) - self.ksgs_spec = self.__class__.ksgs_spec(path + [("ksgs_spec", None)], service) - self.ksgs = self.__class__.ksgs(path + [("ksgs", None)], service) - self.sgs_turb_intensity = self.__class__.sgs_turb_intensity(path + [("sgs_turb_intensity", None)], service) - self.wsf = self.__class__.wsf(path + [("wsf", None)], service) - self.wsb = self.__class__.wsb(path + [("wsb", None)], service) - self.wsn = self.__class__.wsn(path + [("wsn", None)], service) - self.t0 = self.__class__.t0(path + [("t0", None)], service) - - class prevent_reverse_flow(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class radial(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class gen_nrbc_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class avg_press_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class avg_option(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class targeted_mf_boundary(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class surface_tension(TUIMenu): + """ + Enter the menu to set surface tension models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/wall_adhesion").execute(*args, **kwargs) - class targeted_mf(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class virtual_mass(TUIMenu): + """ + Enter the menu to set virtual mass models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/wall_adhesion").execute(*args, **kwargs) - class targeted_mf_pmax(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class numerics(TUIMenu): + """ + Enter the menu to set numerics models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) + self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) + self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) + self.lift = self.__class__.lift(path + [("lift", None)], service) + self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) + self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) + super().__init__(path, service) + def drag(self, *args, **kwargs): + """ + Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/drag").execute(*args, **kwargs) + def heat_coeff(self, *args, **kwargs): + """ + Specify the heat transfer coefficient function between each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/heat_coeff").execute(*args, **kwargs) + def interfacial_area(self, *args, **kwargs): + """ + Set the interfacial area parameters for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interfacial_area").execute(*args, **kwargs) + def mass_transfer(self, *args, **kwargs): + """ + Specify the mass transfer mechanisms. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/mass_transfer").execute(*args, **kwargs) + def model_transition(self, *args, **kwargs): + """ + Set the model transition mechanism. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/model_transition").execute(*args, **kwargs) + def reactions(self, *args, **kwargs): + """ + Define multiple heterogeneous reactions and stoichiometry. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/reactions").execute(*args, **kwargs) + def restitution(self, *args, **kwargs): + """ + Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/restitution").execute(*args, **kwargs) + def slip_velocity(self, *args, **kwargs): + """ + Specify the slip velocity function for each secondary phase with respect to the primary phase. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/slip_velocity").execute(*args, **kwargs) + def turbulence_interaction(self, *args, **kwargs): + """ + Specify the turbulence interaction model for each primary-secondary phase pair. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/turbulence_interaction").execute(*args, **kwargs) + def turbulent_dispersion(self, *args, **kwargs): + """ + Specify the turbulent dispersion model for each primary-secondary phase pair. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/turbulent_dispersion").execute(*args, **kwargs) + def wall_lubrication(self, *args, **kwargs): + """ + Specify the wall lubrication model for each primary-secondary phase pair. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/wall_lubrication").execute(*args, **kwargs) - class targeted_mf_pmin(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class cavitation(TUIMenu): + """ + Enter the menu to set cavitation models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/wall_adhesion").execute(*args, **kwargs) - class press_spec_gen(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class interphase_discretization(TUIMenu): + """ + Enter the menu to set interphase discretization models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - class p_backflow_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class p_backflow_spec_gen(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ac_options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ac_wave(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class impedance_0(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class interphase_viscous_dissipation(TUIMenu): + """ + Enter the menu to set interphase viscous dissipation related models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - class p(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class lift(TUIMenu): + """ + Enter the menu to set lift models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/wall_adhesion").execute(*args, **kwargs) - class p_profile_multiplier(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class surface_tension(TUIMenu): + """ + Enter the menu to set surface tension models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/wall_adhesion").execute(*args, **kwargs) - class direction_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class virtual_mass(TUIMenu): + """ + Enter the menu to set virtual mass models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/wall_adhesion").execute(*args, **kwargs) - class frame_of_reference(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class iac_expert(TUIMenu): + """ + Enter the IAC expert setting menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def ishii_kim_model(self, *args, **kwargs): + """ + Set ik model coefficients. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/iac_expert/ishii_kim_model").execute(*args, **kwargs) + def hibiki_ishii_model(self, *args, **kwargs): + """ + Set hi model coefficients. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/iac_expert/hibiki_ishii_model").execute(*args, **kwargs) + def yao_morel_model(self, *args, **kwargs): + """ + Set ym model coefficients. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/iac_expert/yao_morel_model").execute(*args, **kwargs) + def iac_pseudo_time_step(self, *args, **kwargs): + """ + Set iac pseudo-time. + """ + return PyMenu(self.service, "/define/models/multiphase/phases/iac_expert/iac_pseudo_time_step").execute(*args, **kwargs) - class coordinate_system(metaclass=PyMenuMeta): + class wet_steam(TUIMenu): """ + Enters the wet steam model menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) + def enable(self, *args, **kwargs): + """ + Enables/disables the wet steam model. + """ + return PyMenu(self.service, "/define/models/multiphase/wet_steam/enable").execute(*args, **kwargs) + def compile_user_defined_wetsteam_functions(self, *args, **kwargs): + """ + Compiles user-defined wet steam library. + """ + return PyMenu(self.service, "/define/models/multiphase/wet_steam/compile_user_defined_wetsteam_functions").execute(*args, **kwargs) + def load_unload_user_defined_wetsteam_library(self, *args, **kwargs): + """ + Loads or unloads user-defined wet steam library. + """ + return PyMenu(self.service, "/define/models/multiphase/wet_steam/load_unload_user_defined_wetsteam_library").execute(*args, **kwargs) - class ni(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class set(TUIMenu): + """ + Enters the set menu for setting wet steam model options. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def max_liquid_mass_fraction(self, *args, **kwargs): + """ + Sets the maximum limit on the condensed liquid-phase mass-fraction to prevent divergence. + """ + return PyMenu(self.service, "/define/models/multiphase/wet_steam/set/max_liquid_mass_fraction").execute(*args, **kwargs) + def droplet_growth_rate(self, *args, **kwargs): + """ + S formulation (default) or Hill + """ + return PyMenu(self.service, "/define/models/multiphase/wet_steam/set/droplet_growth_rate").execute(*args, **kwargs) + def virial_equation(self, *args, **kwargs): + """ + Sets the equation of state for steam to either Vukalovich formulation (default) or Young formulation. + """ + return PyMenu(self.service, "/define/models/multiphase/wet_steam/set/virial_equation").execute(*args, **kwargs) + def rgp_tables(self, *args, **kwargs): + """ + Sets the RGP (real gas property) table to be used with the Wet Steam model. + """ + return PyMenu(self.service, "/define/models/multiphase/wet_steam/set/rgp_tables").execute(*args, **kwargs) + def stagnation_conditions(self, *args, **kwargs): + """ + Computes stagnation conditions using either gas phase only, or mixture. For details, see . + """ + return PyMenu(self.service, "/define/models/multiphase/wet_steam/set/stagnation_conditions").execute(*args, **kwargs) - class nj(metaclass=PyMenuMeta): + class population_balance(TUIMenu): """ + Enters the population balance models menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + self.phenomena = self.__class__.phenomena(path + [("phenomena", None)], service) + self.expert = self.__class__.expert(path + [("expert", None)], service) + super().__init__(path, service) + def model(self, *args, **kwargs): + """ + Allows you to select the population balance model and set its parameters. + """ + return PyMenu(self.service, "/define/models/multiphase/population_balance/model").execute(*args, **kwargs) + def include_expansion(self, *args, **kwargs): + """ + Set expansion. + """ + return PyMenu(self.service, "/define/models/multiphase/population_balance/include_expansion").execute(*args, **kwargs) + def size_calculator(self, *args, **kwargs): + """ + Gives you recommendations for appropriate bubble sizes and/or droplet size limits. + """ + return PyMenu(self.service, "/define/models/multiphase/population_balance/size_calculator").execute(*args, **kwargs) - class nk(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ai(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class aj(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ak(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class x_origin(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class phenomena(TUIMenu): + """ + Enters the phenomena menu for population balance. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def nucleation(self, *args, **kwargs): + """ + Specifies the nucleation rate. + """ + return PyMenu(self.service, "/define/models/multiphase/population_balance/phenomena/nucleation").execute(*args, **kwargs) + def growth(self, *args, **kwargs): + """ + Specifies the growth rate. + """ + return PyMenu(self.service, "/define/models/multiphase/population_balance/phenomena/growth").execute(*args, **kwargs) + def aggregation(self, *args, **kwargs): + """ + Sets the aggregation kernel. + """ + return PyMenu(self.service, "/define/models/multiphase/population_balance/phenomena/aggregation").execute(*args, **kwargs) + def breakage(self, *args, **kwargs): + """ + Sets the breakage kernel. + """ + return PyMenu(self.service, "/define/models/multiphase/population_balance/phenomena/breakage").execute(*args, **kwargs) + def aggregation_factor(self, *args, **kwargs): + """ + Specifies a factor that controls the intensity of the selected aggregation kernel. + """ + return PyMenu(self.service, "/define/models/multiphase/population_balance/phenomena/aggregation_factor").execute(*args, **kwargs) + def breakage_factor(self, *args, **kwargs): + """ + Specifies a factor that controls the intensity of the selected breakage kernel. + """ + return PyMenu(self.service, "/define/models/multiphase/population_balance/phenomena/breakage_factor").execute(*args, **kwargs) + def breakage_aggregation_vof_cutoff(self, *args, **kwargs): + """ + Specifies a cutoff limit for the volume fraction values for the breakage and aggregation kernels. + """ + return PyMenu(self.service, "/define/models/multiphase/population_balance/phenomena/breakage_aggregation_vof_cutoff").execute(*args, **kwargs) - class y_origin(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class expert(TUIMenu): + """ + Enter the expert menu for quadrature-based population balance method. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.qmom = self.__class__.qmom(path + [("qmom", None)], service) + super().__init__(path, service) - class z_origin(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class qmom(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def retain_qmom_sources_for_low_vof(self, *args, **kwargs): + """ + Retain qmom source calculation for low secondary phase vof. + """ + return PyMenu(self.service, "/define/models/multiphase/population_balance/expert/qmom/retain_qmom_sources_for_low_vof").execute(*args, **kwargs) + def realizable_moments(self, *args, **kwargs): + """ + Set the population balance model. + """ + return PyMenu(self.service, "/define/models/multiphase/population_balance/expert/qmom/realizable_moments").execute(*args, **kwargs) + def print_realizable_moment_warning(self, *args, **kwargs): + """ + Print the information for realizable moments in the population balance model. + """ + return PyMenu(self.service, "/define/models/multiphase/population_balance/expert/qmom/print_realizable_moment_warning").execute(*args, **kwargs) + def inversion_algorithm(self, *args, **kwargs): + """ + Select the inversion algorithm for quadrature-based population balance method. + """ + return PyMenu(self.service, "/define/models/multiphase/population_balance/expert/qmom/inversion_algorithm").execute(*args, **kwargs) - class ke_spec(metaclass=PyMenuMeta): + class explicit_expert_options(TUIMenu): """ + Enters the menu to set explicit VOF expert options. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + self.volume_fraction_filtering = self.__class__.volume_fraction_filtering(path + [("volume_fraction_filtering", None)], service) + super().__init__(path, service) + def sub_time_step_method(self, *args, **kwargs): + """ + Selects the sub-time step method. + """ + return PyMenu(self.service, "/define/models/multiphase/explicit_expert_options/sub_time_step_method").execute(*args, **kwargs) + def solve_vof_every_iter(self, *args, **kwargs): + """ + If you enter yes, the volume fraction equations will be solved every iteration. By default, the volume fraction equations will be solved only once per time step. + """ + return PyMenu(self.service, "/define/models/multiphase/explicit_expert_options/solve_vof_every_iter").execute(*args, **kwargs) - class nut(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class volume_fraction_filtering(TUIMenu): + """ + Enters the volume fraction filtering menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable(self, *args, **kwargs): + """ + Enables/disables the volume fraction filtering treatment. + """ + return PyMenu(self.service, "/define/models/multiphase/explicit_expert_options/volume_fraction_filtering/enable").execute(*args, **kwargs) + def filtering_options(self, *args, **kwargs): + """ + Selects the volume fraction filtering method. This command becomes available once the define/models/multiphase/explicit-expert-options/volume-fraction-filtering/enable? text option has been set to yes. + """ + return PyMenu(self.service, "/define/models/multiphase/explicit_expert_options/volume_fraction_filtering/filtering_options").execute(*args, **kwargs) + def vol_frac_cutoff(self, *args, **kwargs): + """ + Specifies a cut-off value for the volume fraction filtering. This command becomes available after you select the node averaged cutoff method using the define/models/multiphase/explicit-expert-options/volume-fraction-filtering/filtering-options text command. + """ + return PyMenu(self.service, "/define/models/multiphase/explicit_expert_options/volume_fraction_filtering/vol_frac_cutoff").execute(*args, **kwargs) - class kl(metaclass=PyMenuMeta): + class nox_parameters(TUIMenu): + """ + Enters the NOx parameters menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def nox_chemistry(self, *args, **kwargs): """ + Selects NOx chemistry model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class intermit(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/nox_parameters/nox_chemistry").execute(*args, **kwargs) + def nox_turbulence_interaction(self, *args, **kwargs): """ + Sets NOx turbulence interaction model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class k(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/nox_parameters/nox_turbulence_interaction").execute(*args, **kwargs) + def inlet_diffusion(self, *args, **kwargs): """ + Enables/disables inclusion of diffusion at inlets. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class e(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/nox_parameters/inlet_diffusion").execute(*args, **kwargs) + def nox_expert(self, *args, **kwargs): """ + Selects additional NOx equations. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/models/nox_parameters/nox_expert").execute(*args, **kwargs) - class o(metaclass=PyMenuMeta): + class soot_parameters(TUIMenu): + """ + Enters the soot parameters menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def soot_model_parameters(self, *args, **kwargs): """ + Selects soot model parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class v2(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/soot_parameters/soot_model_parameters").execute(*args, **kwargs) + def soot_process_parameters(self, *args, **kwargs): """ + Selects soot process parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_intensity(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/soot_parameters/soot_process_parameters").execute(*args, **kwargs) + def soot_radiation_interaction(self, *args, **kwargs): """ + Enables/disables the soot-radiation interaction model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_length_scale(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/soot_parameters/soot_radiation_interaction").execute(*args, **kwargs) + def soot_turbulence_interaction(self, *args, **kwargs): """ + Sets soot-turbulence interaction model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_hydraulic_diam(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/soot_parameters/soot_turbulence_interaction").execute(*args, **kwargs) + def modify_schmidt_number(self, *args, **kwargs): """ + Changes the turbulent Schmidt number for soot/nuclei equations. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_viscosity_ratio(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/soot_parameters/modify_schmidt_number").execute(*args, **kwargs) + def inlet_diffusion(self, *args, **kwargs): """ + Enables/disables inclusion of diffusion at inlets. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_viscosity_ratio_profile(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/soot_parameters/inlet_diffusion").execute(*args, **kwargs) + def soot_model_udfs(self, *args, **kwargs): """ + User defined functions for soot model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/models/soot_parameters/soot_model_udfs").execute(*args, **kwargs) - class rst_spec(metaclass=PyMenuMeta): + class radiation(TUIMenu): + """ + Enters the radiation models menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.s2s_parameters = self.__class__.s2s_parameters(path + [("s2s_parameters", None)], service) + self.dtrm_parameters = self.__class__.dtrm_parameters(path + [("dtrm_parameters", None)], service) + self.solar_parameters = self.__class__.solar_parameters(path + [("solar_parameters", None)], service) + super().__init__(path, service) + def discrete_ordinates(self, *args, **kwargs): """ + Enables/disables discrete ordinates radiation model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uu(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/discrete_ordinates").execute(*args, **kwargs) + def do_acceleration(self, *args, **kwargs): """ + Enables/disables the acceleration of the discrete ordinates (DO) radiation model calculations. Note that this text command is only available when running on Linux in parallel. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vv(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/do_acceleration").execute(*args, **kwargs) + def non_gray_model_parameters(self, *args, **kwargs): """ + Sets parameters for non-gray model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ww(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/non_gray_model_parameters").execute(*args, **kwargs) + def montecarlo(self, *args, **kwargs): """ + Enables/disables the Monte Carlo radiation model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uv(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/montecarlo").execute(*args, **kwargs) + def target_cells_per_volume_cluster(self, *args, **kwargs): """ + Sets the amount of coarsening of the radiation mesh for the Monte Carlo radiation model. A number greater than one implies coarsening, whereas equal to one implies no coarsening. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vw(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/target_cells_per_volume_cluster").execute(*args, **kwargs) + def s2s(self, *args, **kwargs): """ + Enables/disables S2S radiation model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uw(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/s2s").execute(*args, **kwargs) + def discrete_transfer(self, *args, **kwargs): """ + Enables/disables discrete transfer radiation model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ksgs_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/discrete_transfer").execute(*args, **kwargs) + def p1(self, *args, **kwargs): """ + Enables/disables P1 radiation model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ksgs(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/p1").execute(*args, **kwargs) + def radiation_model_parameters(self, *args, **kwargs): """ + Sets parameters for radiation models. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sgs_turb_intensity(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/radiation_model_parameters").execute(*args, **kwargs) + def radiation_iteration_parameters(self, *args, **kwargs): """ + Sets iteration parameters for radiation models. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wsf(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/radiation_iteration_parameters").execute(*args, **kwargs) + def mc_model_parameters(self, *args, **kwargs): """ + Specifies Monte Carlo model parameters. This text command is available only when the Monte Carlo model is enabled. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wsb(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/mc_model_parameters").execute(*args, **kwargs) + def mc_under_relaxation(self, *args, **kwargs): """ + Sets the under-relaxation factor for Monte Carlo radiation sources used in the energy equation. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wsn(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/mc_under_relaxation").execute(*args, **kwargs) + def rosseland(self, *args, **kwargs): """ + Enables/disables Rosseland radiation model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class t0(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/rosseland").execute(*args, **kwargs) + def solar(self, *args, **kwargs): """ + Enables/disables solar model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class symmetry(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class velocity_inlet(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.vmag = self.__class__.vmag(path + [("vmag", None)], service) - self.p_sup = self.__class__.p_sup(path + [("p_sup", None)], service) - self.velocity_spec = self.__class__.velocity_spec(path + [("velocity_spec", None)], service) - self.wave_velocity_spec = self.__class__.wave_velocity_spec(path + [("wave_velocity_spec", None)], service) - self.wave_vmag = self.__class__.wave_vmag(path + [("wave_vmag", None)], service) - self.wave_u = self.__class__.wave_u(path + [("wave_u", None)], service) - self.wave_v = self.__class__.wave_v(path + [("wave_v", None)], service) - self.wave_w = self.__class__.wave_w(path + [("wave_w", None)], service) - self.ocw_ship_vel_spec = self.__class__.ocw_ship_vel_spec(path + [("ocw_ship_vel_spec", None)], service) - self.ocw_ship_vmag = self.__class__.ocw_ship_vmag(path + [("ocw_ship_vmag", None)], service) - self.ocw_ship_ni = self.__class__.ocw_ship_ni(path + [("ocw_ship_ni", None)], service) - self.ocw_ship_nj = self.__class__.ocw_ship_nj(path + [("ocw_ship_nj", None)], service) - self.ocw_ship_nk = self.__class__.ocw_ship_nk(path + [("ocw_ship_nk", None)], service) - self.ocw_sp_vel_spec = self.__class__.ocw_sp_vel_spec(path + [("ocw_sp_vel_spec", None)], service) - self.ocw_sp_vmag = self.__class__.ocw_sp_vmag(path + [("ocw_sp_vmag", None)], service) - self.ocw_sp_ni = self.__class__.ocw_sp_ni(path + [("ocw_sp_ni", None)], service) - self.ocw_sp_nj = self.__class__.ocw_sp_nj(path + [("ocw_sp_nj", None)], service) - self.ocw_sp_nk = self.__class__.ocw_sp_nk(path + [("ocw_sp_nk", None)], service) - self.ocw_pp_vel_spec = self.__class__.ocw_pp_vel_spec(path + [("ocw_pp_vel_spec", None)], service) - self.ocw_pp_vmag = self.__class__.ocw_pp_vmag(path + [("ocw_pp_vmag", None)], service) - self.ocw_pp_vmag_ref = self.__class__.ocw_pp_vmag_ref(path + [("ocw_pp_vmag_ref", None)], service) - self.ocw_pp_ref_ht = self.__class__.ocw_pp_ref_ht(path + [("ocw_pp_ref_ht", None)], service) - self.ocw_pp_power_coeff = self.__class__.ocw_pp_power_coeff(path + [("ocw_pp_power_coeff", None)], service) - self.ocw_pp_ni = self.__class__.ocw_pp_ni(path + [("ocw_pp_ni", None)], service) - self.ocw_pp_nj = self.__class__.ocw_pp_nj(path + [("ocw_pp_nj", None)], service) - self.ocw_pp_nk = self.__class__.ocw_pp_nk(path + [("ocw_pp_nk", None)], service) - self.p = self.__class__.p(path + [("p", None)], service) - self.omega_swirl = self.__class__.omega_swirl(path + [("omega_swirl", None)], service) - self.turb_intensity = self.__class__.turb_intensity(path + [("turb_intensity", None)], service) - self.turb_length_scale = self.__class__.turb_length_scale(path + [("turb_length_scale", None)], service) - self.turb_hydraulic_diam = self.__class__.turb_hydraulic_diam(path + [("turb_hydraulic_diam", None)], service) - self.turb_viscosity_ratio = self.__class__.turb_viscosity_ratio(path + [("turb_viscosity_ratio", None)], service) - self.turb_viscosity_ratio_profile = self.__class__.turb_viscosity_ratio_profile(path + [("turb_viscosity_ratio_profile", None)], service) - self.frame_of_reference = self.__class__.frame_of_reference(path + [("frame_of_reference", None)], service) - self.coordinate_system = self.__class__.coordinate_system(path + [("coordinate_system", None)], service) - self.ni = self.__class__.ni(path + [("ni", None)], service) - self.nj = self.__class__.nj(path + [("nj", None)], service) - self.nk = self.__class__.nk(path + [("nk", None)], service) - self.u = self.__class__.u(path + [("u", None)], service) - self.v = self.__class__.v(path + [("v", None)], service) - self.w = self.__class__.w(path + [("w", None)], service) - self.ai = self.__class__.ai(path + [("ai", None)], service) - self.aj = self.__class__.aj(path + [("aj", None)], service) - self.ak = self.__class__.ak(path + [("ak", None)], service) - self.x_origin = self.__class__.x_origin(path + [("x_origin", None)], service) - self.y_origin = self.__class__.y_origin(path + [("y_origin", None)], service) - self.z_origin = self.__class__.z_origin(path + [("z_origin", None)], service) - self.vm_number_of_vortices = self.__class__.vm_number_of_vortices(path + [("vm_number_of_vortices", None)], service) - self.vm_streamwise_fluct = self.__class__.vm_streamwise_fluct(path + [("vm_streamwise_fluct", None)], service) - self.vm_mass_conservation = self.__class__.vm_mass_conservation(path + [("vm_mass_conservation", None)], service) - self.volumetric_synthetic_turbulence_generator = self.__class__.volumetric_synthetic_turbulence_generator(path + [("volumetric_synthetic_turbulence_generator", None)], service) - self.volumetric_synthetic_turbulence_generator_option = self.__class__.volumetric_synthetic_turbulence_generator_option(path + [("volumetric_synthetic_turbulence_generator_option", None)], service) - self.volumetric_synthetic_turbulence_generator_option_thickness = self.__class__.volumetric_synthetic_turbulence_generator_option_thickness(path + [("volumetric_synthetic_turbulence_generator_option_thickness", None)], service) - self.ke_spec = self.__class__.ke_spec(path + [("ke_spec", None)], service) - self.nut = self.__class__.nut(path + [("nut", None)], service) - self.kl = self.__class__.kl(path + [("kl", None)], service) - self.intermit = self.__class__.intermit(path + [("intermit", None)], service) - self.k = self.__class__.k(path + [("k", None)], service) - self.e = self.__class__.e(path + [("e", None)], service) - self.o = self.__class__.o(path + [("o", None)], service) - self.v2 = self.__class__.v2(path + [("v2", None)], service) - self.rst_spec = self.__class__.rst_spec(path + [("rst_spec", None)], service) - self.uu = self.__class__.uu(path + [("uu", None)], service) - self.vv = self.__class__.vv(path + [("vv", None)], service) - self.ww = self.__class__.ww(path + [("ww", None)], service) - self.uv = self.__class__.uv(path + [("uv", None)], service) - self.vw = self.__class__.vw(path + [("vw", None)], service) - self.uw = self.__class__.uw(path + [("uw", None)], service) - self.ksgs_spec = self.__class__.ksgs_spec(path + [("ksgs_spec", None)], service) - self.ksgs = self.__class__.ksgs(path + [("ksgs", None)], service) - self.sgs_turb_intensity = self.__class__.sgs_turb_intensity(path + [("sgs_turb_intensity", None)], service) - self.les_spec_name = self.__class__.les_spec_name(path + [("les_spec_name", None)], service) - self.granular_temperature = self.__class__.granular_temperature(path + [("granular_temperature", None)], service) - self.ac_options = self.__class__.ac_options(path + [("ac_options", None)], service) - self.ac_wave = self.__class__.ac_wave(path + [("ac_wave", None)], service) - self.impedance_0 = self.__class__.impedance_0(path + [("impedance_0", None)], service) - self.t = self.__class__.t(path + [("t", None)], service) - self.non_equil_boundary = self.__class__.non_equil_boundary(path + [("non_equil_boundary", None)], service) - self.tve = self.__class__.tve(path + [("tve", None)], service) - - class vmag(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class p_sup(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/solar").execute(*args, **kwargs) + def solar_irradiation(self, *args, **kwargs): """ + Enables/disables the solar irradiation model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class velocity_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/solar_irradiation").execute(*args, **kwargs) + def solar_calculator(self, *args, **kwargs): """ + Calculates sun direction and intensity. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wave_velocity_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/solar_calculator").execute(*args, **kwargs) + def apply_full_solar_irradiation(self, *args, **kwargs): """ + Enables/disables the application of the complete solar load to the first wavelength band only, reverting to the pre-2019 R1 behavior of the Solar Load and Discrete Ordinates models. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wave_vmag(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/apply_full_solar_irradiation").execute(*args, **kwargs) + def wsggm_cell_based(self, *args, **kwargs): """ + Enables/disables WSGGM cell based method. Note that when enabled, the wsggm-cell-based option will become available in theAbsorption Coefficient drop-down list in the Create/Edit Materials dialog box. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wave_u(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/wsggm_cell_based").execute(*args, **kwargs) + def fast_second_order_discrete_ordinate(self, *args, **kwargs): """ + Enables/disables the fast-second-order option for Discrete Ordinate Model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wave_v(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/fast_second_order_discrete_ordinate").execute(*args, **kwargs) + def do_coupling(self, *args, **kwargs): """ + Enables/disables DO/energy coupling. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wave_w(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/do_coupling").execute(*args, **kwargs) + def solution_method_for_do_coupling(self, *args, **kwargs): """ + Enables/disables the solution method for DO/energy coupling. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_ship_vel_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/solution_method_for_do_coupling").execute(*args, **kwargs) + def beta_radiation_features(self, *args, **kwargs): """ + Enable Radiation Models with Non-Iterative Time Advancement (NITA) as Beta features in FL12.0. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_ship_vmag(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/beta_radiation_features").execute(*args, **kwargs) + def method_partially_specular_wall(self, *args, **kwargs): """ + Sets the method for partially specular wall with discrete ordinate model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_ship_ni(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/radiation/method_partially_specular_wall").execute(*args, **kwargs) + def blending_factor(self, *args, **kwargs): """ + Sets numeric option for Discrete Ordinate model. Make sure thatSecond Order Upwind is selected for the Discrete Ordinates spatial discretization for the blending-factor option to appear in the text command list. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/models/radiation/blending_factor").execute(*args, **kwargs) - class ocw_ship_nj(metaclass=PyMenuMeta): + class s2s_parameters(TUIMenu): """ + Enters the S2S parameters menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def compute_vf_only(self, *args, **kwargs): + """ + Computes/writes view factors only. + """ + return PyMenu(self.service, "/define/models/radiation/s2s_parameters/compute_vf_only").execute(*args, **kwargs) + def compute_write_vf(self, *args, **kwargs): + """ + Computes/writes surface clusters and view factors for S2S radiation model. + """ + return PyMenu(self.service, "/define/models/radiation/s2s_parameters/compute_write_vf").execute(*args, **kwargs) + def compute_vf_accelerated(self, *args, **kwargs): + """ + Compute/Write view factors from existing surface clusters. + """ + return PyMenu(self.service, "/define/models/radiation/s2s_parameters/compute_vf_accelerated").execute(*args, **kwargs) + def compute_clusters_and_vf_accelerated(self, *args, **kwargs): + """ + Compute/Write surface cluster first and then view factors. + """ + return PyMenu(self.service, "/define/models/radiation/s2s_parameters/compute_clusters_and_vf_accelerated").execute(*args, **kwargs) + def non_participating_boundary_zones_temperature(self, *args, **kwargs): + """ + Sets temperature for the non-participating boundary zones. + """ + return PyMenu(self.service, "/define/models/radiation/s2s_parameters/non_participating_boundary_zones_temperature").execute(*args, **kwargs) + def read_vf_file(self, *args, **kwargs): + """ + Reads S2S file. + """ + return PyMenu(self.service, "/define/models/radiation/s2s_parameters/read_vf_file").execute(*args, **kwargs) + def set_vf_parameters(self, *args, **kwargs): + """ + Sets the parameters needed for the viewfactor calculations. + """ + return PyMenu(self.service, "/define/models/radiation/s2s_parameters/set_vf_parameters").execute(*args, **kwargs) + def split_angle(self, *args, **kwargs): + """ + Sets split angle for the clustering algorithm. + """ + return PyMenu(self.service, "/define/models/radiation/s2s_parameters/split_angle").execute(*args, **kwargs) + def set_global_faces_per_surface_cluster(self, *args, **kwargs): + """ + Sets global value of faces per surface cluster for all boundary zones. + """ + return PyMenu(self.service, "/define/models/radiation/s2s_parameters/set_global_faces_per_surface_cluster").execute(*args, **kwargs) + def print_thread_clusters(self, *args, **kwargs): + """ + Prints the following for all boundary threads: thread-id, number of faces, faces per surface cluster, and the number of surface clusters. + """ + return PyMenu(self.service, "/define/models/radiation/s2s_parameters/print_thread_clusters").execute(*args, **kwargs) + def print_zonewise_radiation(self, *args, **kwargs): + """ + Prints the zonewise incoming radiation, viewfactors, and average temperature. + """ + return PyMenu(self.service, "/define/models/radiation/s2s_parameters/print_zonewise_radiation").execute(*args, **kwargs) + def use_old_cluster_algorithm(self, *args, **kwargs): + """ + Uses the old surface clustering algorithm. + """ + return PyMenu(self.service, "/define/models/radiation/s2s_parameters/use_old_cluster_algorithm").execute(*args, **kwargs) + def use_new_cluster_algorithm(self, *args, **kwargs): + """ + Uses the new surface clustering algorithm. + """ + return PyMenu(self.service, "/define/models/radiation/s2s_parameters/use_new_cluster_algorithm").execute(*args, **kwargs) + def compute_fpsc_values(self, *args, **kwargs): + """ + Computes only fpsc values based on current settings + """ + return PyMenu(self.service, "/define/models/radiation/s2s_parameters/compute_fpsc_values").execute(*args, **kwargs) + def enable_mesh_interface_clustering(self, *args, **kwargs): + """ + Enables surface clusters on mesh interfaces. + """ + return PyMenu(self.service, "/define/models/radiation/s2s_parameters/enable_mesh_interface_clustering").execute(*args, **kwargs) - class ocw_ship_nk(metaclass=PyMenuMeta): + class dtrm_parameters(TUIMenu): """ + Enters the dtrm parameters menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def controls(self, *args, **kwargs): + """ + Sets dtrm solution controls. + """ + return PyMenu(self.service, "/define/models/radiation/dtrm_parameters/controls").execute(*args, **kwargs) + def make_globs(self, *args, **kwargs): + """ + Makes globs (coarser mesh) for radiation. + """ + return PyMenu(self.service, "/define/models/radiation/dtrm_parameters/make_globs").execute(*args, **kwargs) + def ray_trace(self, *args, **kwargs): + """ + Creates DTRM rays for radiation. + """ + return PyMenu(self.service, "/define/models/radiation/dtrm_parameters/ray_trace").execute(*args, **kwargs) + def check_ray_file(self, *args, **kwargs): + """ + Reads DTRM rays file. + """ + return PyMenu(self.service, "/define/models/radiation/dtrm_parameters/check_ray_file").execute(*args, **kwargs) - class ocw_sp_vel_spec(metaclass=PyMenuMeta): + class solar_parameters(TUIMenu): """ + Enters the solar parameters menu. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_sp_vmag(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def autosave_solar_data(self, *args, **kwargs): + """ + Sets autosave solar data parameters. + """ + return PyMenu(self.service, "/define/models/radiation/solar_parameters/autosave_solar_data").execute(*args, **kwargs) + def autoread_solar_data(self, *args, **kwargs): + """ + Sets autoread solar data parameters. + """ + return PyMenu(self.service, "/define/models/radiation/solar_parameters/autoread_solar_data").execute(*args, **kwargs) + def sun_direction_vector(self, *args, **kwargs): + """ + Sets sun direction vector. + """ + return PyMenu(self.service, "/define/models/radiation/solar_parameters/sun_direction_vector").execute(*args, **kwargs) + def illumination_parameters(self, *args, **kwargs): + """ + Sets illumination parameters. + """ + return PyMenu(self.service, "/define/models/radiation/solar_parameters/illumination_parameters").execute(*args, **kwargs) + def iteration_parameters(self, *args, **kwargs): + """ + Sets update parameters. + """ + return PyMenu(self.service, "/define/models/radiation/solar_parameters/iteration_parameters").execute(*args, **kwargs) + def quad_tree_parameters(self, *args, **kwargs): + """ + Sets quad-tree refinement parameters. + """ + return PyMenu(self.service, "/define/models/radiation/solar_parameters/quad_tree_parameters").execute(*args, **kwargs) + def ground_reflectivity(self, *args, **kwargs): + """ + Sets ground reflectivity parameters. + """ + return PyMenu(self.service, "/define/models/radiation/solar_parameters/ground_reflectivity").execute(*args, **kwargs) + def scattering_fraction(self, *args, **kwargs): + """ + Sets scattering fraction parameters. + """ + return PyMenu(self.service, "/define/models/radiation/solar_parameters/scattering_fraction").execute(*args, **kwargs) + def sol_on_demand(self, *args, **kwargs): + """ + Sets solar load on demand. + """ + return PyMenu(self.service, "/define/models/radiation/solar_parameters/sol_on_demand").execute(*args, **kwargs) + def sol_camera_pos(self, *args, **kwargs): + """ + Sets camera position based on sun direction vector. + """ + return PyMenu(self.service, "/define/models/radiation/solar_parameters/sol_camera_pos").execute(*args, **kwargs) + def sol_adjacent_fluidcells(self, *args, **kwargs): + """ + Sets solar load on for adjacent fluid cells. + """ + return PyMenu(self.service, "/define/models/radiation/solar_parameters/sol_adjacent_fluidcells").execute(*args, **kwargs) + def use_direction_from_sol_calc(self, *args, **kwargs): + """ + Sets direction computed from solar calculator. + """ + return PyMenu(self.service, "/define/models/radiation/solar_parameters/use_direction_from_sol_calc").execute(*args, **kwargs) + def solar_thread_control(self, *args, **kwargs): + """ + Sets the number of threads to run the solar flux calculation. This item appears only when running in parallel with nodes located on a separate machine from the one running the host process andSolar Ray Tracing is enabled. + """ + return PyMenu(self.service, "/define/models/radiation/solar_parameters/solar_thread_control").execute(*args, **kwargs) - class ocw_sp_ni(metaclass=PyMenuMeta): + class solver(TUIMenu): + """ + Enters the menu to select the solver. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def pressure_based(self, *args, **kwargs): """ + Enables/disables the pressure-based solver. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_sp_nj(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/solver/pressure_based").execute(*args, **kwargs) + def density_based_explicit(self, *args, **kwargs): """ + Enables/disables the density-based-explicit solver. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_sp_nk(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/solver/density_based_explicit").execute(*args, **kwargs) + def density_based_implicit(self, *args, **kwargs): """ + Enables/disables the density-based-implicit solver. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_pp_vel_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/solver/density_based_implicit").execute(*args, **kwargs) + def adjust_solver_defaults_based_on_setup(self, *args, **kwargs): """ + Enable/disable adjustment of solver defaults based on setup. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/models/solver/adjust_solver_defaults_based_on_setup").execute(*args, **kwargs) - class ocw_pp_vmag(metaclass=PyMenuMeta): + class species(TUIMenu): + """ + Enters the species models menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.CHEMKIN_CFD_parameters = self.__class__.CHEMKIN_CFD_parameters(path + [("CHEMKIN_CFD_parameters", None)], service) + super().__init__(path, service) + def off(self, *args, **kwargs): """ + Enables/disables solution of species models. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_pp_vmag_ref(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/off").execute(*args, **kwargs) + def species_transport(self, *args, **kwargs): """ + Enables/disables the species transport model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_pp_ref_ht(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/species_transport").execute(*args, **kwargs) + def non_premixed_combustion(self, *args, **kwargs): """ + Enables/disables non-premixed combustion model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_pp_power_coeff(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/non_premixed_combustion").execute(*args, **kwargs) + def premixed_combustion(self, *args, **kwargs): """ + Enables/disables premixed combustion model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_pp_ni(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/premixed_combustion").execute(*args, **kwargs) + def partially_premixed_combustion(self, *args, **kwargs): """ + Enables/disables partially premixed combustion model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_pp_nj(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/partially_premixed_combustion").execute(*args, **kwargs) + def premixed_model(self, *args, **kwargs): """ + Sets premixed combustion model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_pp_nk(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/premixed_model").execute(*args, **kwargs) + def pdf_transport(self, *args, **kwargs): """ + Enables/disables the composition PDF transport combustion model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class p(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/pdf_transport").execute(*args, **kwargs) + def save_gradients(self, *args, **kwargs): """ + Enables/disables storage of species mass fraction gradients. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class omega_swirl(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/save_gradients").execute(*args, **kwargs) + def liquid_energy_diffusion(self, *args, **kwargs): """ + Enable/disable energy diffusion for liquid regime. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_intensity(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/liquid_energy_diffusion").execute(*args, **kwargs) + def volumetric_reactions(self, *args, **kwargs): """ + Enables/disables volumetric reactions. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_length_scale(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/volumetric_reactions").execute(*args, **kwargs) + def species_transport_expert(self, *args, **kwargs): """ + Sets the convergence acceleration expert parameters. This command is only available when the species transport model is enabled. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_hydraulic_diam(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/species_transport_expert").execute(*args, **kwargs) + def coal_calculator(self, *args, **kwargs): """ + Sets up coal modeling inputs. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_viscosity_ratio(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/coal_calculator").execute(*args, **kwargs) + def mixing_model(self, *args, **kwargs): """ + Sets PDF Transport mixing model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_viscosity_ratio_profile(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/mixing_model").execute(*args, **kwargs) + def stiff_chemistry(self, *args, **kwargs): """ + Enables/disables stiff chemistry option. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class frame_of_reference(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/stiff_chemistry").execute(*args, **kwargs) + def liquid_micro_mixing(self, *args, **kwargs): """ + Enables/disables liquid micro mixing. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coordinate_system(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/liquid_micro_mixing").execute(*args, **kwargs) + def epdf_energy(self, *args, **kwargs): """ + Enables/disables EPDF energy option. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ni(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/epdf_energy").execute(*args, **kwargs) + def integration_parameters(self, *args, **kwargs): """ + Sets chemistry ODE integrator parameters. Enables/disables stiff chemistry acceleration methods and set their parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nj(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/integration_parameters").execute(*args, **kwargs) + def clear_isat_table(self, *args, **kwargs): """ + Clears ISAT table. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nk(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/clear_isat_table").execute(*args, **kwargs) + def pdf_transport_expert(self, *args, **kwargs): """ + Enables/disables PDF Transport expert user. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class u(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/pdf_transport_expert").execute(*args, **kwargs) + def set_turb_chem_interaction(self, *args, **kwargs): """ + Sets EDC model constants. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class v(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/set_turb_chem_interaction").execute(*args, **kwargs) + def spark_model(self, *args, **kwargs): """ + Switches between the R15 and R14.5 spark models and sets spark model parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class w(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/spark_model").execute(*args, **kwargs) + def ignition_model(self, *args, **kwargs): """ + Enables/disables the ignition model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ai(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/ignition_model").execute(*args, **kwargs) + def ignition_model_controls(self, *args, **kwargs): """ + Sets ignition model parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class aj(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/ignition_model_controls").execute(*args, **kwargs) + def inert_transport_model(self, *args, **kwargs): """ + Enables/disables the inert transport model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ak(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/inert_transport_model").execute(*args, **kwargs) + def inert_transport_controls(self, *args, **kwargs): """ + Sets inert transport model parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class x_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/inert_transport_controls").execute(*args, **kwargs) + def particle_surface_reactions(self, *args, **kwargs): """ + Enables/disables particle surface reactions. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class y_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/particle_surface_reactions").execute(*args, **kwargs) + def wall_surface_reactions(self, *args, **kwargs): """ + Enables/disables wall surface reactions. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class z_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/wall_surface_reactions").execute(*args, **kwargs) + def heat_of_surface_reactions(self, *args, **kwargs): """ + Enables/disables heat of surface reactions. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vm_number_of_vortices(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/heat_of_surface_reactions").execute(*args, **kwargs) + def mass_deposition_source(self, *args, **kwargs): """ + Enables/disables mass deposition source due to surface reactions. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vm_streamwise_fluct(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/mass_deposition_source").execute(*args, **kwargs) + def electro_chemical_surface_reactions(self, *args, **kwargs): """ + Enables/disables electrochemical surface reactions. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vm_mass_conservation(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/electro_chemical_surface_reactions").execute(*args, **kwargs) + def species_migration(self, *args, **kwargs): """ + Includes species migration in electric field. This command is available only when the electrochemical surface reactions are enabled. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class volumetric_synthetic_turbulence_generator(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/species_migration").execute(*args, **kwargs) + def reaction_diffusion_balance(self, *args, **kwargs): """ + Enables/disables reaction diffusion balance at reacting surface for surface reactions. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class volumetric_synthetic_turbulence_generator_option(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/reaction_diffusion_balance").execute(*args, **kwargs) + def surf_reaction_aggressiveness_factor(self, *args, **kwargs): """ + Sets the surface reaction aggressiveness factor. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class volumetric_synthetic_turbulence_generator_option_thickness(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/surf_reaction_aggressiveness_factor").execute(*args, **kwargs) + def surf_reaction_netm_params(self, *args, **kwargs): """ + Sets the surface reaction parameters for the Non-Equilibrium Thermal Model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ke_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/surf_reaction_netm_params").execute(*args, **kwargs) + def inlet_diffusion(self, *args, **kwargs): """ + Enables/disables inclusion of diffusion at inlets. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nut(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/inlet_diffusion").execute(*args, **kwargs) + def diffusion_energy_source(self, *args, **kwargs): """ + Enables/disables diffusion energy source. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class kl(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/diffusion_energy_source").execute(*args, **kwargs) + def multicomponent_diffusion(self, *args, **kwargs): """ + Enables/disables multicomponent diffusion. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class intermit(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/multicomponent_diffusion").execute(*args, **kwargs) + def thermal_diffusion(self, *args, **kwargs): """ + Enables/disables thermal diffusion. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class k(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/thermal_diffusion").execute(*args, **kwargs) + def CHEMKIN_CFD(self, *args, **kwargs): """ + Enables/disables the Ansys CHEMKIN-CFD solver. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class e(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/CHEMKIN_CFD").execute(*args, **kwargs) + def non_premixed_combustion_parameters(self, *args, **kwargs): """ + Sets PDF parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class o(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/non_premixed_combustion_parameters").execute(*args, **kwargs) + def partially_premixed_combustion_parameters(self, *args, **kwargs): """ + Sets PDF parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class v2(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/partially_premixed_combustion_parameters").execute(*args, **kwargs) + def partially_premixed_properties(self, *args, **kwargs): """ + Sets/changes partially-premixed mixture properties. This command is only available when partially-premixed-combustion? is enabled. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class rst_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/partially_premixed_properties").execute(*args, **kwargs) + def re_calc_par_premix_props(self, *args, **kwargs): """ + Re-calculate partially-premixed properties. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uu(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/re_calc_par_premix_props").execute(*args, **kwargs) + def full_tabulation(self, *args, **kwargs): """ + Enables/disables building of a full 2-mixture fraction table """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vv(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/full_tabulation").execute(*args, **kwargs) + def init_unsteady_flamelet_prob(self, *args, **kwargs): """ + Initializes Unsteady Flamelet Probability. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ww(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/init_unsteady_flamelet_prob").execute(*args, **kwargs) + def import_flamelet_for_restart(self, *args, **kwargs): """ + Imports Flamelet File for Restart. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uv(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/import_flamelet_for_restart").execute(*args, **kwargs) + def non_premixed_combustion_expert(self, *args, **kwargs): """ + Sets PDF expert parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vw(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/non_premixed_combustion_expert").execute(*args, **kwargs) + def partially_premixed_combustion_expert(self, *args, **kwargs): """ + Sets PDF expert parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uw(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/partially_premixed_combustion_expert").execute(*args, **kwargs) + def partially_premixed_combustion_grids(self, *args, **kwargs): """ + Sets values for the grid distribution for PDF table or flamelet parameter. This text command is available only for partially premixed combustion cases with FGM. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ksgs_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/partially_premixed_combustion_grids").execute(*args, **kwargs) + def flamelet_expert(self, *args, **kwargs): """ + Sets flamelet expert parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ksgs(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/flamelet_expert").execute(*args, **kwargs) + def combustion_expert(self, *args, **kwargs): """ + Enables import of the CHEMKIN mechanism transport data. When this option is enabled, you will be prompted for importing CHEMKIN transport property database when setting your combustion case. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sgs_turb_intensity(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/combustion_expert").execute(*args, **kwargs) + def set_premixed_combustion(self, *args, **kwargs): """ + Sets premixed combustion parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class les_spec_name(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/set_premixed_combustion").execute(*args, **kwargs) + def set_multi_regime_fgm(self, *args, **kwargs): """ + Set-multi-regim-fgm-parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class granular_temperature(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/set_multi_regime_fgm").execute(*args, **kwargs) + def relax_to_equil(self, *args, **kwargs): """ + Enables/disables the Relaxation to Chemical Equilibrium model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ac_options(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/relax_to_equil").execute(*args, **kwargs) + def thickened_flame_model(self, *args, **kwargs): """ + Enables/disables the Relaxation to Chemical Equilibrium model """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ac_wave(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/thickened_flame_model").execute(*args, **kwargs) + def decoupled_detailed_chemistry(self, *args, **kwargs): """ + Enables/disables the Decoupled Detailed Chemistry model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class impedance_0(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/decoupled_detailed_chemistry").execute(*args, **kwargs) + def reactor_network_model(self, *args, **kwargs): """ + Enables/disables the Reactor Network Model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class t(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/reactor_network_model").execute(*args, **kwargs) + def reacting_channel_model(self, *args, **kwargs): """ + Enables/disables the Reacting Channel Model. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class non_equil_boundary(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/reacting_channel_model").execute(*args, **kwargs) + def reacting_channel_model_options(self, *args, **kwargs): """ + Sets Reacting Channel Model parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class tve(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/reacting_channel_model_options").execute(*args, **kwargs) + def combustion_numerics(self, *args, **kwargs): """ + Applies optimal solver settings automatically to provide a faster solution time. This command is available only for transient non-premixed and partially premixed combustion models. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wall(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class non_reflecting_bc(metaclass=PyMenuMeta): - """ - Enters the non-reflecting boundary condition menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.general_nrbc = self.__class__.general_nrbc(path + [("general_nrbc", None)], service) - self.turbo_specific_nrbc = self.__class__.turbo_specific_nrbc(path + [("turbo_specific_nrbc", None)], service) + return PyMenu(self.service, "/define/models/species/combustion_numerics").execute(*args, **kwargs) - class general_nrbc(metaclass=PyMenuMeta): + class CHEMKIN_CFD_parameters(TUIMenu): """ - Setting for general non-reflecting b.c. + Enters the expert CHEMKIN-CFD parameters menu. """ def __init__(self, path, service): self.path = path self.service = service - self.set = self.__class__.set(path + [("set", None)], service) - - class set(metaclass=PyMenuMeta): + super().__init__(path, service) + def basic_options(self, *args, **kwargs): """ - Enters the setup menu for general non-reflecting b.c.’s. + Sets basic parameter options. """ - def __init__(self, path, service): - self.path = path - self.service = service - def sigma(self, *args, **kwargs): - """ - Sets NRBC sigma factor (default value 0.15). - """ - return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/general_nrbc/set/sigma").execute(*args, **kwargs) - def sigma2(self, *args, **kwargs): - """ - Sets NRBC sigma2 factor (default value 5.0). - """ - return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/general_nrbc/set/sigma2").execute(*args, **kwargs) - def relax(self, *args, **kwargs): - """ - Set NRBC relaxation factor (default value 0.5). - """ - return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/general_nrbc/set/relax").execute(*args, **kwargs) - def tangential_source(self, *args, **kwargs): - """ - Include or not NRBC tangential source (default value #t). - """ - return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/general_nrbc/set/tangential_source").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Enables/disables nrbc verbosity scheme output. - """ - return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/general_nrbc/set/verbosity").execute(*args, **kwargs) - - class turbo_specific_nrbc(metaclass=PyMenuMeta): - """ - Enters the turbo specific nrbc menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.set = self.__class__.set(path + [("set", None)], service) - def enable(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/species/CHEMKIN_CFD_parameters/basic_options").execute(*args, **kwargs) + def advanced_options(self, *args, **kwargs): """ - Enables/disables non-reflecting b.c.’s. + Sets advanced parameter options. """ - return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/turbo_specific_nrbc/enable").execute(*args, **kwargs) - def initialize(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/species/CHEMKIN_CFD_parameters/advanced_options").execute(*args, **kwargs) + def add_cell_monitor(self, *args, **kwargs): """ - Initializes non-reflecting b.c.’s. + Monitors cell for debug output. """ - return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/turbo_specific_nrbc/initialize").execute(*args, **kwargs) - def show_status(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/species/CHEMKIN_CFD_parameters/add_cell_monitor").execute(*args, **kwargs) + def list_cell_monitors(self, *args, **kwargs): """ - Shows current status of non-reflecting b.c.’s. + Lists cell monitors. """ - return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/turbo_specific_nrbc/show_status").execute(*args, **kwargs) - - class set(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/species/CHEMKIN_CFD_parameters/list_cell_monitors").execute(*args, **kwargs) + def delete_cell_monitors(self, *args, **kwargs): """ - Enters the set menu for non-reflecting b.c. parameters. + Deletes cell monitors. """ - def __init__(self, path, service): - self.path = path - self.service = service - def discretization(self, *args, **kwargs): - """ - Enables use of higher-order reconstruction at boundaries if available. - """ - return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/turbo_specific_nrbc/set/discretization").execute(*args, **kwargs) - def under_relaxation(self, *args, **kwargs): - """ - Sets non-reflecting b.c. under-relaxation factor. - """ - return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/turbo_specific_nrbc/set/under_relaxation").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Sets non-reflecting b.c. verbosity level. 0 : silent, 1 : basic information (default), 2 : detailed information for debugging. - """ - return PyMenu(self.service, "/define/boundary_conditions/non_reflecting_bc/turbo_specific_nrbc/set/verbosity").execute(*args, **kwargs) + return PyMenu(self.service, "/define/models/species/CHEMKIN_CFD_parameters/delete_cell_monitors").execute(*args, **kwargs) - class rename_zone(metaclass=PyMenuMeta): + class viscous(TUIMenu): """ - Enter the menu for renaming cell and face zones based on adjacency, adding suffixes or prefixes to names, and renaming zones based on the Fluent naming conventions. + Enters the viscous model menu. """ def __init__(self, path, service): self.path = path self.service = service - def rename_by_adjacency(self, *args, **kwargs): + self.near_wall_treatment = self.__class__.near_wall_treatment(path + [("near_wall_treatment", None)], service) + self.multiphase_turbulence = self.__class__.multiphase_turbulence(path + [("multiphase_turbulence", None)], service) + self.turbulence_expert = self.__class__.turbulence_expert(path + [("turbulence_expert", None)], service) + self.geko_options = self.__class__.geko_options(path + [("geko_options", None)], service) + self.transition_model_options = self.__class__.transition_model_options(path + [("transition_model_options", None)], service) + super().__init__(path, service) + def inviscid(self, *args, **kwargs): """ - Append the name of the adjacent cell zone to the specified face zone. For example, if fluid is the adjacent cell zone, and you select a face zone named interior, the resulting name of the face zone would be interior-fluid. + Enables/disables inviscid flow model. """ - return PyMenu(self.service, "/define/boundary_conditions/rename_zone/rename_by_adjacency").execute(*args, **kwargs) - def rename_to_default(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/inviscid").execute(*args, **kwargs) + def laminar(self, *args, **kwargs): """ - Rename a zone to use the Fluent naming convention. + Enables/disables laminar flow model. """ - return PyMenu(self.service, "/define/boundary_conditions/rename_zone/rename_to_default").execute(*args, **kwargs) - def add_suffix_or_prefix(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/laminar").execute(*args, **kwargs) + def low_pressure_boundary_slip(self, *args, **kwargs): """ - Add a suffix or prefix to one or more zones. + Enables/disables the slip boundary formulation for low-pressure gas systems. """ - return PyMenu(self.service, "/define/boundary_conditions/rename_zone/add_suffix_or_prefix").execute(*args, **kwargs) - - class bc_settings(metaclass=PyMenuMeta): - """ - Enters the boundary conditions settings menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.pressure_far_field = self.__class__.pressure_far_field(path + [("pressure_far_field", None)], service) - def mass_flow(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/low_pressure_boundary_slip").execute(*args, **kwargs) + def mixing_length(self, *args, **kwargs): """ - Selects method for setting the mass flow rate. + Enables/disables mixing-length (algebraic) turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/bc_settings/mass_flow").execute(*args, **kwargs) - def pressure_outlet(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/mixing_length").execute(*args, **kwargs) + def zero_equation_hvac(self, *args, **kwargs): """ - Sets advanced options for pressure outlet boundaries. + Enables/disables zero-equation HVAC turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/bc_settings/pressure_outlet").execute(*args, **kwargs) - - class pressure_far_field(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/viscous/zero_equation_hvac").execute(*args, **kwargs) + def spalart_allmaras(self, *args, **kwargs): """ - Sets advanced options for pressure far field boundaries. + Enables/disables Spalart-Allmaras turbulence model. """ - def __init__(self, path, service): - self.path = path - self.service = service - def riemann_invariants_tangency_correction(self, *args, **kwargs): - """ - Enables/disables the Riemann-invariant tangency correction as described in . - """ - return PyMenu(self.service, "/define/boundary_conditions/bc_settings/pressure_far_field/riemann_invariants_tangency_correction").execute(*args, **kwargs) - def type(self, *args, **kwargs): - """ - Choose pressure-far-field boundary-condition type. - """ - return PyMenu(self.service, "/define/boundary_conditions/bc_settings/pressure_far_field/type").execute(*args, **kwargs) - - class perforated_walls(metaclass=PyMenuMeta): - """ - Enters the perforated walls menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def read_input_file(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/spalart_allmaras").execute(*args, **kwargs) + def ke1e(self, *args, **kwargs): """ - Reads an input file for perforated walls. + Enable/disable the KE1E turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/perforated_walls/read_input_file").execute(*args, **kwargs) - def model_setup(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/ke1e").execute(*args, **kwargs) + def sa_enhanced_wall_treatment(self, *args, **kwargs): """ - Sets up the perforated wall model for each effusion surface. + Enables/disables 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 Fluent 14. """ - return PyMenu(self.service, "/define/boundary_conditions/perforated_walls/model_setup").execute(*args, **kwargs) - - class set(metaclass=PyMenuMeta): - """ - Allows you to define one or more settings at single or multiple boundaries/cell zones of a given type at once. Enter q to exit the define/boundary-conditions/set/ command. For a description of the items in this menu, see corresponding define/boundary-conditions/. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def axis(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/sa_enhanced_wall_treatment").execute(*args, **kwargs) + def sa_alternate_prod(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables strain/vorticity production in Spalart-Allmaras model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/axis").execute(*args, **kwargs) - def degassing(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/sa_alternate_prod").execute(*args, **kwargs) + def sa_damping(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables full low-Reynolds number form of Spalart-Allmaras model. This option is only available if your response wasno to sa-enhanced-wall-treatment?. """ - return PyMenu(self.service, "/define/boundary_conditions/set/degassing").execute(*args, **kwargs) - def exhaust_fan(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/sa_damping").execute(*args, **kwargs) + def ke_standard(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the standard - turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/exhaust_fan").execute(*args, **kwargs) - def fan(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/ke_standard").execute(*args, **kwargs) + def ke_easm(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the EASM - turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/fan").execute(*args, **kwargs) - def fluid(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/ke_easm").execute(*args, **kwargs) + def ke_realizable(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the realizable - turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/fluid").execute(*args, **kwargs) - def geometry(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/ke_realizable").execute(*args, **kwargs) + def ke_rng(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the RNG - turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/geometry").execute(*args, **kwargs) - def inlet_vent(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/ke_rng").execute(*args, **kwargs) + def rng_differential_visc(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the differential-viscosity model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/inlet_vent").execute(*args, **kwargs) - def intake_fan(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/rng_differential_visc").execute(*args, **kwargs) + def rng_swirl_model(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables swirl corrections for rng-model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/intake_fan").execute(*args, **kwargs) - def interface(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/rng_swirl_model").execute(*args, **kwargs) + def kw_standard(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the standard - turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/interface").execute(*args, **kwargs) - def interior(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/kw_standard").execute(*args, **kwargs) + def kw_easm(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the EASM - turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/interior").execute(*args, **kwargs) - def mass_flow_inlet(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/kw_easm").execute(*args, **kwargs) + def kw_bsl(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the baseline (BSL) - turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/mass_flow_inlet").execute(*args, **kwargs) - def mass_flow_outlet(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/kw_bsl").execute(*args, **kwargs) + def kw_geko(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the generalized - (GEKO) turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/mass_flow_outlet").execute(*args, **kwargs) - def network(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/kw_geko").execute(*args, **kwargs) + def kw_sst(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the SST - turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/network").execute(*args, **kwargs) - def network_end(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/kw_sst").execute(*args, **kwargs) + def kw_wj_bsl_earsm(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enable/disable the EASM k-omega turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/network_end").execute(*args, **kwargs) - def outflow(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/kw_wj_bsl_earsm").execute(*args, **kwargs) + def kw_low_re_correction(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the - low Re option. """ - return PyMenu(self.service, "/define/boundary_conditions/set/outflow").execute(*args, **kwargs) - def outlet_vent(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/kw_low_re_correction").execute(*args, **kwargs) + def kw_shear_correction(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the - shear-flow correction option. This text command is only available for the standard - model and the stress-omega RSM model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/outlet_vent").execute(*args, **kwargs) - def overset(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/kw_shear_correction").execute(*args, **kwargs) + def turb_compressibility(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the compressibility correction option. """ - return PyMenu(self.service, "/define/boundary_conditions/set/overset").execute(*args, **kwargs) - def periodic(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/turb_compressibility").execute(*args, **kwargs) + def k_kl_w(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the k-kl- turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/periodic").execute(*args, **kwargs) - def porous_jump(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/k_kl_w").execute(*args, **kwargs) + def transition_sst(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the transition SST turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/porous_jump").execute(*args, **kwargs) - def pressure_far_field(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/transition_sst").execute(*args, **kwargs) + def v2f(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables V2F turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/pressure_far_field").execute(*args, **kwargs) - def pressure_inlet(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/v2f").execute(*args, **kwargs) + def reynolds_stress_model(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the Reynolds-stress turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/pressure_inlet").execute(*args, **kwargs) - def pressure_outlet(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/reynolds_stress_model").execute(*args, **kwargs) + def rsm_solve_tke(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the solution of T.K.E. in RSM model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/pressure_outlet").execute(*args, **kwargs) - def radiator(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/rsm_solve_tke").execute(*args, **kwargs) + def rsm_wall_echo(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables wall-echo effects in RSM model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/radiator").execute(*args, **kwargs) - def rans_les_interface(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/rsm_wall_echo").execute(*args, **kwargs) + def rsm_linear_pressure_strain(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the linear pressure-strain model in RSM. """ - return PyMenu(self.service, "/define/boundary_conditions/set/rans_les_interface").execute(*args, **kwargs) - def recirculation_inlet(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/rsm_linear_pressure_strain").execute(*args, **kwargs) + def rsm_ssg_pressure_strain(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables quadratic pressure-strain model in RSM. """ - return PyMenu(self.service, "/define/boundary_conditions/set/recirculation_inlet").execute(*args, **kwargs) - def recirculation_outlet(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/rsm_ssg_pressure_strain").execute(*args, **kwargs) + def rsm_omega_based(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the stress-omega Reynolds stress model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/recirculation_outlet").execute(*args, **kwargs) - def shadow(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/rsm_omega_based").execute(*args, **kwargs) + def rsm_bsl_based(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables the stress-BSL Reynolds stress model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/shadow").execute(*args, **kwargs) - def solid(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/rsm_bsl_based").execute(*args, **kwargs) + def sas(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables Scale-Adaptive Simulation (SAS) in combination with the SST - turbulence model. """ - return PyMenu(self.service, "/define/boundary_conditions/set/solid").execute(*args, **kwargs) - def symmetry(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/sas").execute(*args, **kwargs) + def detached_eddy_simulation(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables detached eddy simulation. """ - return PyMenu(self.service, "/define/boundary_conditions/set/symmetry").execute(*args, **kwargs) - def velocity_inlet(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/detached_eddy_simulation").execute(*args, **kwargs) + def des_limiter_option(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Selects the DES limiter option (none, F1, F2, Delayed DES, or Improved Delayed DES). """ - return PyMenu(self.service, "/define/boundary_conditions/set/velocity_inlet").execute(*args, **kwargs) - def wall(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/des_limiter_option").execute(*args, **kwargs) + def large_eddy_simulation(self, *args, **kwargs): """ - Set boundary conditions for a zone or multiple zones of this type. + Enables/disables large eddy simulation. """ - return PyMenu(self.service, "/define/boundary_conditions/set/wall").execute(*args, **kwargs) - - class impedance_data_fitting(metaclass=PyMenuMeta): - """ - Enters the impedance data fitting menu, which provides text commands that can be helpful when you are using the impedance boundary condition (IBC). - """ - def __init__(self, path, service): - self.path = path - self.service = service - def impedance_data(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/large_eddy_simulation").execute(*args, **kwargs) + def les_subgrid_smagorinsky(self, *args, **kwargs): """ - Reads an input file with experimental specific impedance data in the frequency domain and then computes the terms needed for an approximation of the reflection coefficient as a series of poles / residues in the time domain. The resulting terms are printed in the console, and can be written to a pole / residue file (which can be imported and the impedance parameters applied to a boundary condition using the define/boundary-conditions/impedance-data-fitting/import-parameters text command). You can also write a file with fitted frequency / impedance data, which can be compared to the input data to evaluate how well it fits. + Enables/disables the Smagorinsky-Lilly subgrid-scale model. """ - return PyMenu(self.service, "/define/boundary_conditions/impedance_data_fitting/impedance_data").execute(*args, **kwargs) - def reflection_data(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/les_subgrid_smagorinsky").execute(*args, **kwargs) + def les_dynamic_energy_flux(self, *args, **kwargs): """ - Reads an input file with experimental reflection coefficient data in the frequency domain and then computes the terms needed for an approximation of the reflection coefficient as a series of poles / residues in the time domain. The resulting terms are printed in the console, and can be written to a pole / residue file (which can be imported and the impedance parameters applied to a boundary condition using the define/boundary-conditions/impedance-data-fitting/import-parameters text command). You can also write a file with fitted frequency / impedance data, which can be compared to the input data to evaluate how well it fits. + Enables/disables the dynamic sub-grid scale turbulent Prandtl Number. """ - return PyMenu(self.service, "/define/boundary_conditions/impedance_data_fitting/reflection_data").execute(*args, **kwargs) - def absorption_data(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/les_dynamic_energy_flux").execute(*args, **kwargs) + def les_dynamic_scalar_flux(self, *args, **kwargs): """ - Reads an input file with experimental absorption coefficient data in the frequency domain and then computes the terms needed for an approximation of the reflection coefficient as a series of poles / residues in the time domain. The resulting terms are printed in the console, and can be written to a pole / residue file (which can be imported and the impedance parameters applied to a boundary condition using the define/boundary-conditions/impedance-data-fitting/import-parameters text command). You can also write a file with fitted frequency / impedance data, which can be compared to the input data to evaluate how well it fits. + Enables/disables the dynamic sub-grid scale turbulent Schmidt Number. """ - return PyMenu(self.service, "/define/boundary_conditions/impedance_data_fitting/absorption_data").execute(*args, **kwargs) - def iterations(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/les_dynamic_scalar_flux").execute(*args, **kwargs) + def les_subgrid_dynamic_fvar(self, *args, **kwargs): """ - Sets the number of internal iterations used for the calculations performed from the define/boundary-conditions/impedance-data-fitting/ text command menu. By default, the number of iterations is set to 20. + Enables/disables the dynamic subgrid-scale mixture fraction variance model. """ - return PyMenu(self.service, "/define/boundary_conditions/impedance_data_fitting/iterations").execute(*args, **kwargs) - def convergence_tolerance(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/les_subgrid_dynamic_fvar").execute(*args, **kwargs) + def les_subgrid_rng(self, *args, **kwargs): """ - Sets the convergence tolerance, which is an accuracy that is used for completing the iterative fitting procedure in the calculations performed from the define/boundary-conditions/impedance-data-fitting/ text command menu. By default, the tolerance is set to 1e-6. + Enable/disable the RNG subgrid-scale model. """ - return PyMenu(self.service, "/define/boundary_conditions/impedance_data_fitting/convergence_tolerance").execute(*args, **kwargs) - def residue_tolerance(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/les_subgrid_rng").execute(*args, **kwargs) + def les_subgrid_wale(self, *args, **kwargs): """ - Sets the residue tolerance, which is the minimum value of residues that are kept in the fitting performed from the define/boundary-conditions/impedance-data-fitting/ text command menu. This residue check helps to eliminate parasitic poles. By default, the tolerance is set to 1e-6. + Enables/disables WALE subgrid-scale model. """ - return PyMenu(self.service, "/define/boundary_conditions/impedance_data_fitting/residue_tolerance").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/les_subgrid_wale").execute(*args, **kwargs) + def les_subgrid_wmles(self, *args, **kwargs): """ - Sets the verbosity of the progress messages during the fitting performed from the define/boundary-conditions/impedance-data-fitting/ text command menu. Setting this to 1 results in messages being printed in the console as the fitting calculation progresses. The default value of 0 suppresses this output. + Enables/disables the WMLES subgrid-scale model. """ - return PyMenu(self.service, "/define/boundary_conditions/impedance_data_fitting/verbosity").execute(*args, **kwargs) - def import_parameters(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/les_subgrid_wmles").execute(*args, **kwargs) + def les_subgrid_wmles_s_minus_omega(self, *args, **kwargs): """ - Reads a pole / residue file with impedance parameters in the time domain and applies them to a specified boundary condition. + Enables/disables the WMLES - subgrid-scale model. """ - return PyMenu(self.service, "/define/boundary_conditions/impedance_data_fitting/import_parameters").execute(*args, **kwargs) + return PyMenu(self.service, "/define/models/viscous/les_subgrid_wmles_s_minus_omega").execute(*args, **kwargs) + def les_subgrid_tke(self, *args, **kwargs): + """ + Enables/disables kinetic energy transport subgrid-scale model. + """ + return PyMenu(self.service, "/define/models/viscous/les_subgrid_tke").execute(*args, **kwargs) + def turb_buoyancy_effects(self, *args, **kwargs): + """ + Enables/disables effects of buoyancy on turbulence. + """ + return PyMenu(self.service, "/define/models/viscous/turb_buoyancy_effects").execute(*args, **kwargs) + def curvature_correction(self, *args, **kwargs): + """ + Enables/disables the curvature correction. + """ + return PyMenu(self.service, "/define/models/viscous/curvature_correction").execute(*args, **kwargs) + def curvature_correction_ccurv(self, *args, **kwargs): + """ + Sets the strength of the curvature correction term. The default value is 1. This is available after the curvature-correction? option is enabled. + """ + return PyMenu(self.service, "/define/models/viscous/curvature_correction_ccurv").execute(*args, **kwargs) + def corner_flow_correction(self, *args, **kwargs): + """ + Enables/disables the corner flow correction. + """ + return PyMenu(self.service, "/define/models/viscous/corner_flow_correction").execute(*args, **kwargs) + def corner_flow_correction_ccorner(self, *args, **kwargs): + """ + Sets the strength of the quadratic term of the corner flow correction. The default value is 1. This is available after the corner-flow-correction? option is enabled. + """ + return PyMenu(self.service, "/define/models/viscous/corner_flow_correction_ccorner").execute(*args, **kwargs) + def rsm_or_earsm_geko_option(self, *args, **kwargs): + """ + Enables/disables the RSM version of the GEKO model. + """ + return PyMenu(self.service, "/define/models/viscous/rsm_or_earsm_geko_option").execute(*args, **kwargs) + def add_transition_model(self, *args, **kwargs): + """ + Sets Transition model to account for transitional effects. The default is none, however you can select gamma-algebraic or gamma-transport-eqn. After a transition model has been enabled, you have additional options in the submenu transition-model-options. + """ + return PyMenu(self.service, "/define/models/viscous/add_transition_model").execute(*args, **kwargs) + def user_defined(self, *args, **kwargs): + """ + Selects user-defined functions to define the turbulent viscosity and the turbulent Prandtl and Schmidt numbers. + """ + return PyMenu(self.service, "/define/models/viscous/user_defined").execute(*args, **kwargs) + def user_defined_transition(self, *args, **kwargs): + """ + Sets user-defined transition correlations. + """ + return PyMenu(self.service, "/define/models/viscous/user_defined_transition").execute(*args, **kwargs) + def trans_sst_roughness_correlation(self, *args, **kwargs): + """ + Enables/disables the Transition-SST roughness correlation option. + """ + return PyMenu(self.service, "/define/models/viscous/trans_sst_roughness_correlation").execute(*args, **kwargs) - class spectral(metaclass=PyMenuMeta): - """ - Enter the Spectral menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def calculate_fourier_coefficients(self, *args, **kwargs): - """ - Calculates Fourier coefficient data. - """ - return PyMenu(self.service, "/define/spectral/calculate_fourier_coefficients").execute(*args, **kwargs) - def delete_fourier_coefficients(self, *args, **kwargs): - """ - Deletes Fourier coefficient data. - """ - return PyMenu(self.service, "/define/spectral/delete_fourier_coefficients").execute(*args, **kwargs) - def calculate_harmonic_exports(self, *args, **kwargs): - """ - Calculates Harmonic Export data. - """ - return PyMenu(self.service, "/define/spectral/calculate_harmonic_exports").execute(*args, **kwargs) - def delete_harmonic_exports(self, *args, **kwargs): - """ - Deletes Harmonic Export data. - """ - return PyMenu(self.service, "/define/spectral/delete_harmonic_exports").execute(*args, **kwargs) - - class custom_field_functions(metaclass=PyMenuMeta): - """ - Enters the custom field functions menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def define(self, *args, **kwargs): - """ - Defines a custom field function. - """ - return PyMenu(self.service, "/define/custom_field_functions/define").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes a custom field function. - """ - return PyMenu(self.service, "/define/custom_field_functions/delete").execute(*args, **kwargs) - def save(self, *args, **kwargs): - """ - Saves a custom field function. - """ - return PyMenu(self.service, "/define/custom_field_functions/save").execute(*args, **kwargs) - def load(self, *args, **kwargs): - """ - Loads a custom field function. - """ - return PyMenu(self.service, "/define/custom_field_functions/load").execute(*args, **kwargs) - def list_valid_cell_function_names(self, *args, **kwargs): - """ - Lists the names of cell functions that can be used in a custom field function. - """ - return PyMenu(self.service, "/define/custom_field_functions/list_valid_cell_function_names").execute(*args, **kwargs) - def example_cff_definitions(self, *args, **kwargs): - """ - Lists example custom field functions. - """ - return PyMenu(self.service, "/define/custom_field_functions/example_cff_definitions").execute(*args, **kwargs) - - class dynamic_mesh(metaclass=PyMenuMeta): - """ - Enters the dynamic mesh menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.controls = self.__class__.controls(path + [("controls", None)], service) - self.events = self.__class__.events(path + [("events", None)], service) - self.zones = self.__class__.zones(path + [("zones", None)], service) - self.actions = self.__class__.actions(path + [("actions", None)], service) - self.transient_settings = self.__class__.transient_settings(path + [("transient_settings", None)], service) - def dynamic_mesh(self, *args, **kwargs): - """ - Enables/disables the dynamic mesh solver. - """ - return PyMenu(self.service, "/define/dynamic_mesh/dynamic_mesh").execute(*args, **kwargs) - - class controls(metaclass=PyMenuMeta): - """ - Enters the dynamic mesh controls menu. This text command is only available when the define/dynamic-mesh/dynamic-mesh? text command is enabled. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.smoothing_parameters = self.__class__.smoothing_parameters(path + [("smoothing_parameters", None)], service) - self.layering_parameters = self.__class__.layering_parameters(path + [("layering_parameters", None)], service) - self.remeshing_parameters = self.__class__.remeshing_parameters(path + [("remeshing_parameters", None)], service) - self.in_cylinder_parameters = self.__class__.in_cylinder_parameters(path + [("in_cylinder_parameters", None)], service) - self.implicit_update_parameters = self.__class__.implicit_update_parameters(path + [("implicit_update_parameters", None)], service) - self.six_dof_parameters = self.__class__.six_dof_parameters(path + [("six_dof_parameters", None)], service) - self.periodic_displacement_parameters = self.__class__.periodic_displacement_parameters(path + [("periodic_displacement_parameters", None)], service) - self.contact_parameters = self.__class__.contact_parameters(path + [("contact_parameters", None)], service) - def in_cylinder_output(self, *args, **kwargs): - """ - Enables/disables in-cylinder output. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_output").execute(*args, **kwargs) - def smoothing(self, *args, **kwargs): - """ - Enables/disables smoothing in cell zones. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing").execute(*args, **kwargs) - def layering(self, *args, **kwargs): + class near_wall_treatment(TUIMenu): """ - Enables/disables dynamic-layering in quad/hex cell zones. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/layering").execute(*args, **kwargs) - def remeshing(self, *args, **kwargs): - """ - Enables/disables local remeshing in tri/tet and mixed cell zones. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing").execute(*args, **kwargs) - def steady_pseudo_time_control(self, *args, **kwargs): - """ - Enables/disables the pseudo time step control in the graphical user interface. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/steady_pseudo_time_control").execute(*args, **kwargs) - - class smoothing_parameters(metaclass=PyMenuMeta): - """ - Enters the dynamic mesh smoothing-parameters menu. + Enters the near wall treatment menu. """ def __init__(self, path, service): self.path = path self.service = service - def smoothing_method(self, *args, **kwargs): - """ - Specify the smoothing method used by the dynamic mesh model. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/smoothing_method").execute(*args, **kwargs) - def constant_factor(self, *args, **kwargs): - """ - Sets the spring constant relaxation factor. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/constant_factor").execute(*args, **kwargs) - def bnd_node_relaxation(self, *args, **kwargs): - """ - The boundary node relaxation is used by spring smoothing. The boundary node relaxation allows you to relax the update of the node positions at deforming boundaries. A value of 0 prevents deforming boundary nodes from moving and a value of 1 indicates no under-relaxation. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/bnd_node_relaxation").execute(*args, **kwargs) - def bnd_stiffness_factor(self, *args, **kwargs): - """ - Sets the stiffness factor for springs connected to boundary nodes. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/bnd_stiffness_factor").execute(*args, **kwargs) - def convergence_tolerance(self, *args, **kwargs): - """ - Sets the convergence tolerance for spring-based solver. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/convergence_tolerance").execute(*args, **kwargs) - def max_iter(self, *args, **kwargs): - """ - Set the maximum number of iterations for spring-based solver. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/max_iter").execute(*args, **kwargs) - def spring_on_all_elements(self, *args, **kwargs): - """ - Enables/disables spring-based smoothing for all cell shapes; if disabled, the spring-based smoothing is applied based on the setting of the define/dynamic-mesh/controls/smoothing-parameters/spring-on-simplex-shapes? text command. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/spring_on_all_elements").execute(*args, **kwargs) - def spring_on_simplex_elements(self, *args, **kwargs): - """ - Enable/disable spring-based smoothing for tri/tet elements in mixed element zones. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/spring_on_simplex_elements").execute(*args, **kwargs) - def skew_smooth_niter(self, *args, **kwargs): - """ - Sets the number of skewness-based smoothing cycles. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/skew_smooth_niter").execute(*args, **kwargs) - def skew_smooth_cell_skew_max(self, *args, **kwargs): - """ - Sets the skewness threshold, above which cells will be smoothed using the skewness method. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/skew_smooth_cell_skew_max").execute(*args, **kwargs) - def skew_smooth_face_skew_max(self, *args, **kwargs): - """ - Sets the skewness threshold, above which faces will be smoothed using the skewness method. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/skew_smooth_face_skew_max").execute(*args, **kwargs) - def skew_smooth_all_deforming_boundaries(self, *args, **kwargs): - """ - Enables/disables skewness smoothing for all deforming dynamic boundary zones. This is enabled by default. If disabled, skewness smoothing is only applied to the deforming dynamic boundary zones that have smoothing explicitly enabled or use local face remeshing. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/skew_smooth_all_deforming_boundaries").execute(*args, **kwargs) - def laplace_node_relaxation(self, *args, **kwargs): - """ - Set the Laplace boundary node relaxation factor. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/laplace_node_relaxation").execute(*args, **kwargs) - def diffusion_coeff_function(self, *args, **kwargs): - """ - Specifies whether the diffusion coefficient for diffusion-based smoothing is based on the boundary distance or the cell volume. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/diffusion_coeff_function").execute(*args, **kwargs) - def diffusion_coeff_parameter(self, *args, **kwargs): + super().__init__(path, service) + def non_equilibrium_wall_fn(self, *args, **kwargs): """ - Sets the diffusion coefficient parameter used for diffusion-based smoothing. + Enables/disables non-equilibrium wall functions. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/diffusion_coeff_parameter").execute(*args, **kwargs) - def diffusion_fvm(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/near_wall_treatment/non_equilibrium_wall_fn").execute(*args, **kwargs) + def enhanced_wall_treatment(self, *args, **kwargs): """ - Answering yes at the prompt changes the diffusion-based smoothing method to the cell-based finite volume approach that was the default in releases prior to Fluent 15.0. Answering no at the prompt changes the diffusion-based smoothing method to the default node-based finite element method. + Enables/disables enhanced wall functions. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/diffusion_fvm").execute(*args, **kwargs) - def poisson_ratio(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/near_wall_treatment/enhanced_wall_treatment").execute(*args, **kwargs) + def menter_lechner(self, *args, **kwargs): """ - Sets the Poisson’s ratio used for smoothing based on the linearly elastic solid model. + Enables/disables the Menter-Lechner near-wall treatment. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/poisson_ratio").execute(*args, **kwargs) - def smooth_from_reference_position(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/near_wall_treatment/menter_lechner").execute(*args, **kwargs) + def scalable_wall_functions(self, *args, **kwargs): """ - Enables/disables smoothing from a reference position. Such smoothing may produce greater mesh quality consistency for stationary or moving meshes with periodic or quasi-periodic motion, and is only available when the smoothing method is based on diffusion or the linearly elastic solid model. + Enables/disables scalable wall functions. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/smooth_from_reference_position").execute(*args, **kwargs) - def relative_convergence_tolerance(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/near_wall_treatment/scalable_wall_functions").execute(*args, **kwargs) + def user_defined_wall_functions(self, *args, **kwargs): """ - Sets the relative residual convergence tolerance for smoothing based on diffusion or the linearly elastic solid model. + Enables/disables user-defined wall functions. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/relative_convergence_tolerance").execute(*args, **kwargs) - def amg_stabilization(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/near_wall_treatment/user_defined_wall_functions").execute(*args, **kwargs) + def werner_wengle_wall_fn(self, *args, **kwargs): """ - Set the AMG stabilization method for mesh smoothing (FEM). + Enables/disables Werner-Wengle wall functions. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/amg_stabilization").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/near_wall_treatment/werner_wengle_wall_fn").execute(*args, **kwargs) + def wf_pressure_gradient_effects(self, *args, **kwargs): """ - Set the verbosity for spring smoothing. + Enables/disables wall function pressure- gradient effects. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/verbosity").execute(*args, **kwargs) - def boundary_distance_method(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/near_wall_treatment/wf_pressure_gradient_effects").execute(*args, **kwargs) + def wf_thermal_effects(self, *args, **kwargs): """ - Sets the method used to evaluate the boundary distance for the diffusion coefficient calculation, when diffusion-based smoothing is enabled. + Enables/disables wall function thermal effects. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/smoothing_parameters/boundary_distance_method").execute(*args, **kwargs) + return PyMenu(self.service, "/define/models/viscous/near_wall_treatment/wf_thermal_effects").execute(*args, **kwargs) - class layering_parameters(metaclass=PyMenuMeta): + class multiphase_turbulence(TUIMenu): """ - Enters the dynamic mesh layering menu. + Enters the multiphase turbulence menu. """ def __init__(self, path, service): self.path = path self.service = service - def split_factor(self, *args, **kwargs): + super().__init__(path, service) + def multiphase_options(self, *args, **kwargs): """ - Sets the factor determining when to split dynamic layers. + Enables/disables multiphase options. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/layering_parameters/split_factor").execute(*args, **kwargs) - def collapse_factor(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/multiphase_turbulence/multiphase_options").execute(*args, **kwargs) + def turbulence_multiphase_models(self, *args, **kwargs): """ - Sets the factor determining when to collapse dynamic layers. + Selects - multiphase model. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/layering_parameters/collapse_factor").execute(*args, **kwargs) - def constant_height(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/multiphase_turbulence/turbulence_multiphase_models").execute(*args, **kwargs) + def rsm_multiphase_models(self, *args, **kwargs): """ - Enables/disables layering based on constant height, else layering based on constant ratio. + Selects Reynolds Stress multiphase model. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/layering_parameters/constant_height").execute(*args, **kwargs) + return PyMenu(self.service, "/define/models/viscous/multiphase_turbulence/rsm_multiphase_models").execute(*args, **kwargs) + def subgrid_turbulence_contribution_aiad(self, *args, **kwargs): + """ + Enable/disable the Subgrid Turbulence Contribution for the AIAD model. + """ + return PyMenu(self.service, "/define/models/viscous/multiphase_turbulence/subgrid_turbulence_contribution_aiad").execute(*args, **kwargs) - class remeshing_parameters(metaclass=PyMenuMeta): + class turbulence_expert(TUIMenu): """ - Enters the dynamic mesh remeshing menu to set parameters for all remeshing methods. + Enters the turbulence expert menu. """ def __init__(self, path, service): self.path = path self.service = service - self.prism_controls = self.__class__.prism_controls(path + [("prism_controls", None)], service) - self.sizing_controls = self.__class__.sizing_controls(path + [("sizing_controls", None)], service) - self.prism_layer_parameters = self.__class__.prism_layer_parameters(path + [("prism_layer_parameters", None)], service) - def unified_remeshing(self, *args, **kwargs): + super().__init__(path, service) + def low_re_ke(self, *args, **kwargs): """ - Enables/disables unified remeshing, which specifies that an algorithm is used that combines aspects of a variety of remeshing methods. It is applied to triangular or tetrahedral cells and can produce wedge cells in 3D boundary layer meshes. Unified remeshing simplifies the remeshing setup and can provide increased robustness compared to methods-based remeshing, especially for parallel simulations. + Enables/disables the low-Re - turbulence model. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/unified_remeshing").execute(*args, **kwargs) - def retain_size_distribution(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/low_re_ke").execute(*args, **kwargs) + def low_re_ke_index(self, *args, **kwargs): """ - Enables/disables the use of local size criteria when marking cells for unified remeshing (in an attempt to maintain the initial mesh size distribution even as the mesh moves), rather than marking cells based on the minimum and maximum length scale values of the cell zone in the initial mesh. Either marking can be overridden if more restrictive values are specified using the define/dynamic-mesh/controls/remeshing-parameters/length-min and define/dynamic-mesh/controls/remeshing-parameters/length-max text commands. + Specifies which low-Reynolds-number - model is to be used. Six models are available: + + + + + + Index + Model + + + + + 0 + Abid + + + 1 + Lam-Bremhorst + + + 2 + Launder-Sharma + + + 3 + Yang-Shih + + + 4 + Abe-Kondoh-Nagano + + + 5 + Chang-Hsieh-Chen + + + + Contact your Ansys, Inc. technical support engineer for more details. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/retain_size_distribution").execute(*args, **kwargs) - def poly_remeshing(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/low_re_ke_index").execute(*args, **kwargs) + def kato_launder_model(self, *args, **kwargs): """ - Enable/disable poly remeshing. + Enables/disables Kato-Launder modification. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/poly_remeshing").execute(*args, **kwargs) - def remeshing_methods(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/kato_launder_model").execute(*args, **kwargs) + def production_limiter(self, *args, **kwargs): """ - Enables/disables individual remeshing options as part of methods-based remeshing. + Enables/disables Production Limiter modification. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/remeshing_methods").execute(*args, **kwargs) - def zone_remeshing(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/production_limiter").execute(*args, **kwargs) + def kw_vorticity_based_production(self, *args, **kwargs): """ - Enables/disables the cell zone remeshing method as part of methods-based remeshing. + Enables/disables vorticity-based production. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/zone_remeshing").execute(*args, **kwargs) - def length_min(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/kw_vorticity_based_production").execute(*args, **kwargs) + def kw_add_sas(self, *args, **kwargs): """ - Sets the length threshold below which cells will be remeshed. + Enables/disables Scale-Adaptive Simulation (SAS) in combination with the currently selected -based URANS turbulence model. This text command is only available for transient cases. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/length_min").execute(*args, **kwargs) - def length_max(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/kw_add_sas").execute(*args, **kwargs) + def kw_add_des(self, *args, **kwargs): """ - Sets the length threshold above which cells will be remeshed. + Enables/disables Detached Eddy Simulation (DES) in combination with the currently selected BSL - model or transition SST model. This text command is only available for transient cases. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/length_max").execute(*args, **kwargs) - def cell_skew_max(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/kw_add_des").execute(*args, **kwargs) + def turb_add_sbes_sdes(self, *args, **kwargs): """ - Sets the cell skewness threshold above which cells will be remeshed. + Enables/disables the Stress-Blended Eddy Simulation (SBES) model or Shielded Detached Eddy Simulation (SDES) model. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/cell_skew_max").execute(*args, **kwargs) - def face_skew_max(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/turb_add_sbes_sdes").execute(*args, **kwargs) + def sbes_sdes_hybrid_model(self, *args, **kwargs): """ - Sets the face skewness threshold above which faces will be remeshed. + Selects the hybrid model, to specify whether you want to apply the Shielded Detached Eddy Simulation (SDES) model, Stress-Blended Eddy Simulation (SBES), or SBES with a user-defined function. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/face_skew_max").execute(*args, **kwargs) - def size_remesh_interval(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/sbes_sdes_hybrid_model").execute(*args, **kwargs) + def sbes_update_interval_k_omega(self, *args, **kwargs): """ - Sets the interval (in time steps) when remeshing based on size is done for methods-based remeshing. + Sets the number of time steps between updates of the k-ω part of the SBES model. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/size_remesh_interval").execute(*args, **kwargs) - def sizing_function(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/sbes_update_interval_k_omega").execute(*args, **kwargs) + def sbes_sgs_option(self, *args, **kwargs): """ - Enables/disables the sizing function as part of methods-based remeshing. + Selects the subgrid-scale model for the LES portion of your Stress-Blended Eddy Simulation (SBES). """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_function").execute(*args, **kwargs) - def sizing_funct_defaults(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/sbes_sgs_option").execute(*args, **kwargs) + def sbes_les_subgrid_dynamic_fvar(self, *args, **kwargs): """ - Sets sizing function defaults. + Enable/disable the dynamic subgrid-scale mixture fraction variance model. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_funct_defaults").execute(*args, **kwargs) - def sizing_funct_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/sbes_les_subgrid_dynamic_fvar").execute(*args, **kwargs) + def turbulence_damping(self, *args, **kwargs): """ - Sets the sizing function resolution with respect to shortest boundary. + Enables/disables turbulence damping and sets turbulence damping parameters. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_funct_resolution").execute(*args, **kwargs) - def sizing_funct_variation(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/turbulence_damping").execute(*args, **kwargs) + def rke_cmu_rotation_term(self, *args, **kwargs): """ - Sets the maximum sizing function increase/decrease in the interior. + Modifies the definition for the realizable - model. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_funct_variation").execute(*args, **kwargs) - def sizing_funct_rate(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/rke_cmu_rotation_term").execute(*args, **kwargs) + def turb_non_newtonian(self, *args, **kwargs): """ - Determines how far from the boundary the increase/decrease happens. + Enables/disables turbulence for non-Newtonian fluids. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_funct_rate").execute(*args, **kwargs) - def parallel_remeshing(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/turb_non_newtonian").execute(*args, **kwargs) + def non_newtonian_modification(self, *args, **kwargs): """ - Disables/enables parallel remeshing as part of methods-based remeshing.. + Enables/disables non-Newtonian modification for Lam-Bremhorst model. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/parallel_remeshing").execute(*args, **kwargs) - def remeshing_after_moving(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/non_newtonian_modification").execute(*args, **kwargs) + def turb_pk_compressible(self, *args, **kwargs): """ - Enables a second round of remeshing based on the skewness parameters after the boundary has moved as part of methods-based remeshing. + Enables/disables turbulent production due to compressible divergence. """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/remeshing_after_moving").execute(*args, **kwargs) - - class prism_controls(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/turb_pk_compressible").execute(*args, **kwargs) + def thermal_p_function(self, *args, **kwargs): """ - Enters the dynamic mesh prism controls menu, which provides text commands that can be useful when you want to modify the algorithm that attempts to retain the size distribution during unified remeshing. Each prism control definition is applied to one or more boundary zones, and then affects the height distribution and number of layers of the wedge cells in the adjacent boundary layers. + Enables/disables Jayatilleke P function. """ - def __init__(self, path, service): - self.path = path - self.service = service - def add(self, *args, **kwargs): - """ - Adds a new prism controls definition. After being prompted for a name, you can enter the following to complete the definition: - - - - first-height Sets the height of the first layer of wedge cells in the boundary layer adjacent to the specified zones. - - - - growth-method Specifies the method used to determine the increase in height of the wedge cell layers beyond the first layer. The only available option is geometric, so that the height of each layer is the height of the previous layer multiplied by the rate. - - - - name Specifies the name of the prism controls definition. - - - - nlayers Sets the number of layers of wedge cells in the boundary layer adjacent to the specified zones. - - - - rate Sets the coefficient for the growth-method used to determine the increase in height of the wedge cell layers beyond the first layer. - - - - zones Specifies all of the boundary zones on which this prism controls definition is applied. - - - Enter q when the definition is complete to return to the text command menu. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/prism_controls/add").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edits an existing prism controls definition. You can revise the fields listed previously for the define/dynamic-mesh/controls/remeshing-parameters/prism-controls/add text command. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/prism_controls/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes an existing prism controls definition. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/prism_controls/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Prints a list of the existing prism controls definitions in the console. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/prism_controls/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): - """ - Prints the properties of an existing prism controls definition of your choice in the console. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/prism_controls/list_properties").execute(*args, **kwargs) - - class sizing_controls(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/thermal_p_function").execute(*args, **kwargs) + def restore_sst_v61(self, *args, **kwargs): """ - Enters the dynamic mesh sizing controls menu, which provides text commands that can be useful when you want to modify the algorithm that attempts to retain the size distribution during unified remeshing. Each sizing control definition is applied to one or more boundary zones, and then affects the size of the cells throughout the mesh based on their distance from those boundary zone(s) and your settings in the definition. + Enables/disables SST formulation of v6.1. """ - def __init__(self, path, service): - self.path = path - self.service = service - def add(self, *args, **kwargs): - """ - Adds a new sizing controls definition. After being prompted for a name, you can enter the following to complete the definition: - - - - growth-rate Sets the growth rate of the sizing controls definition. - - - - max-length Sets a maximum length threshold that is used when the type is set to auto or soft. - - - - min-length Sets a maximum length threshold that is used when the type is set to auto. - - - - motion Determines whether the size control definition affects the remeshing based on whether the mesh undergoes motion: auto specifies that it is applied whether or not there is motion; and static specifies that it is only applied if there is no motion. - - - - name Specifies the name of the sizing controls definition. - - - - type Specifies how the sizing is affected by the selected boundary zones: auto specifies that the default size distribution (rather than the initial size distribution in your selected boundary zones) is used, along with your specified max-length and min-length values; soft specifies that the maximum length scale of your selected boundary zones is used, along with your specified min-length value; and meshed specifies that the maximum and minimum length scales of your selected boundary zones are used, in order to respect their initial size distribution. This setting is only relevant if you have more than one sizing controls definition. - - - - zones Specifies all of the boundary zones on which the sizing controls definition is applied. - - - Enter q when the definition is complete to return to the text command menu. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_controls/add").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edits an existing sizing controls definition. You can revise the fields listed previously for the define/dynamic-mesh/controls/remeshing-parameters/sizing-controls/add text command. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_controls/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes an existing sizing controls definition. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_controls/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Prints a list of the existing sizing controls definitions in the console. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_controls/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): - """ - Prints the properties of an existing sizing controls definition of your choice in the console. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/sizing_controls/list_properties").execute(*args, **kwargs) - - class prism_layer_parameters(metaclass=PyMenuMeta): - """ - Enters the dynamic mesh prism layer parameters menu, where you can define the parameters of the prism layers as part of methods-based remeshing. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def first_height(self, *args, **kwargs): - """ - Sets the first cell height in the prism layer. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/prism_layer_parameters/first_height").execute(*args, **kwargs) - def growth_rate(self, *args, **kwargs): - """ - Sets the geometric growth rate of the prism layer. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/prism_layer_parameters/growth_rate").execute(*args, **kwargs) - def number_of_layers(self, *args, **kwargs): - """ - Sets the number of elements in the prism layer. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/remeshing_parameters/prism_layer_parameters/number_of_layers").execute(*args, **kwargs) - - class in_cylinder_parameters(metaclass=PyMenuMeta): - """ - Enters the dynamic mesh in-cylinder menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def starting_crank_angle(self, *args, **kwargs): - """ - Specifies the initial value for the crank angle. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/starting_crank_angle").execute(*args, **kwargs) - def crank_angle_step(self, *args, **kwargs): - """ - Specifies crank angle step size. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/crank_angle_step").execute(*args, **kwargs) - def crank_period(self, *args, **kwargs): - """ - Specifies the crank period. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/crank_period").execute(*args, **kwargs) - def max_crank_angle_step(self, *args, **kwargs): - """ - Specifies maximum crank angle step size. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/max_crank_angle_step").execute(*args, **kwargs) - def piston_data(self, *args, **kwargs): - """ - Specifies the crank radius and connecting rod length. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/piston_data").execute(*args, **kwargs) - def piston_stroke_cutoff(self, *args, **kwargs): - """ - Specifies the cut off point for in-cylinder piston. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/piston_stroke_cutoff").execute(*args, **kwargs) - def minimum_lift(self, *args, **kwargs): - """ - Specifies minimum lift for in-cylinder valves. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/minimum_lift").execute(*args, **kwargs) - def print_plot_lift(self, *args, **kwargs): - """ - Prints or plot valve lift curve. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/print_plot_lift").execute(*args, **kwargs) - def modify_lift(self, *args, **kwargs): - """ - Modifies lift curve (shift or scale). - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/modify_lift").execute(*args, **kwargs) - def position_starting_mesh(self, *args, **kwargs): - """ - Moves mesh from top dead center to starting crank angle. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/in_cylinder_parameters/position_starting_mesh").execute(*args, **kwargs) - - class implicit_update_parameters(metaclass=PyMenuMeta): - """ - Enters the dynamic mesh implicit update menu. This text command is only available when you enable implicit mesh updating using the prompts of the define/dynamic-mesh/dynamic-mesh? text command. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def update_interval(self, *args, **kwargs): - """ - Specifies the update interval (that is, the frequency in iterations) at which the mesh is updated within a time step. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/implicit_update_parameters/update_interval").execute(*args, **kwargs) - def motion_relaxation(self, *args, **kwargs): - """ - Specifies a value (within the range of 0 to 1) for the motion relaxation, which is applied during the implicit mesh update. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/implicit_update_parameters/motion_relaxation").execute(*args, **kwargs) - def residual_criteria(self, *args, **kwargs): - """ - Specifies the relative residual threshold that is used to check the motion convergence during the implicit mesh update. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/implicit_update_parameters/residual_criteria").execute(*args, **kwargs) - - class six_dof_parameters(metaclass=PyMenuMeta): - """ - Enters the dynamic mesh six degrees of freedom (DOF) solver menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def create_properties(self, *args, **kwargs): - """ - Creates/edits a set of six DOF properties for rigid body motion. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/create_properties").execute(*args, **kwargs) - def delete_properties(self, *args, **kwargs): - """ - Deletes a set of six DOF properties for rigid body motion. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/delete_properties").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): - """ - Prints summaries of the existing sets of six DOF properties for rigid body motion. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/list_properties").execute(*args, **kwargs) - def x_component_of_gravity(self, *args, **kwargs): - """ - Specifies x-component of gravity. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/x_component_of_gravity").execute(*args, **kwargs) - def y_component_of_gravity(self, *args, **kwargs): - """ - Specifies y-component of gravity. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/y_component_of_gravity").execute(*args, **kwargs) - def z_component_of_gravity(self, *args, **kwargs): - """ - Specifies z-component of gravity. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/z_component_of_gravity").execute(*args, **kwargs) - def second_order(self, *args, **kwargs): - """ - Enables/disables the second order six degrees of freedom solver. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/second_order").execute(*args, **kwargs) - def motion_history(self, *args, **kwargs): - """ - Enables/disables writing position/orientation of six DOF zones to file. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/motion_history").execute(*args, **kwargs) - def motion_history_file_name(self, *args, **kwargs): - """ - Specifies the name and location of the six DOF motion history file. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/six_dof_parameters/motion_history_file_name").execute(*args, **kwargs) - - class periodic_displacement_parameters(metaclass=PyMenuMeta): - """ - Enters the periodic displacement parameters menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def list_displacements(self, *args, **kwargs): - """ - List Periodic Displacements. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/list_displacements").execute(*args, **kwargs) - def create_displacement(self, *args, **kwargs): - """ - Create Periodic Displacement. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/create_displacement").execute(*args, **kwargs) - def edit_displacement(self, *args, **kwargs): - """ - Edit Periodic Displacement. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/edit_displacement").execute(*args, **kwargs) - def copy_displacement(self, *args, **kwargs): - """ - Copy Periodic Displacement. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/copy_displacement").execute(*args, **kwargs) - def delete_displacement(self, *args, **kwargs): - """ - Delete Periodic Displacement. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/delete_displacement").execute(*args, **kwargs) - def delete_all_displacements(self, *args, **kwargs): - """ - Delete All Periodic Displacements. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/delete_all_displacements").execute(*args, **kwargs) - def create_group(self, *args, **kwargs): - """ - Create Periodic Displacement Group. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/create_group").execute(*args, **kwargs) - def list_groups(self, *args, **kwargs): - """ - List Periodic Displacement Groups. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/list_groups").execute(*args, **kwargs) - def edit_group(self, *args, **kwargs): - """ - Edit Periodic Displacement Group. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/edit_group").execute(*args, **kwargs) - def delete_group(self, *args, **kwargs): - """ - Delete Periodic Displacement Group. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/delete_group").execute(*args, **kwargs) - def delete_all_groups(self, *args, **kwargs): - """ - Delete All Periodic Displacement Groups. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/delete_all_groups").execute(*args, **kwargs) - def set_active_displacement(self, *args, **kwargs): - """ - Set Active Periodic Displacement in Group. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/periodic_displacement_parameters/set_active_displacement").execute(*args, **kwargs) - - class contact_parameters(metaclass=PyMenuMeta): - """ - Enters the dynamic mesh contact-parameters menu. This text command is only available when you enable contact detection using the prompts of the define/dynamic-mesh/dynamic-mesh? text command. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.flow_control_parameters = self.__class__.flow_control_parameters(path + [("flow_control_parameters", None)], service) - def contact_face_zones(self, *args, **kwargs): - """ - Selects face zones involved in contact detection. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/contact_face_zones").execute(*args, **kwargs) - def contact_udf(self, *args, **kwargs): - """ - Selects the UDF to be invoked when contact is detected. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/contact_udf").execute(*args, **kwargs) - def contact_threshold(self, *args, **kwargs): - """ - Specifies threshold distance for contact detection. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/contact_threshold").execute(*args, **kwargs) - def update_contact_marks(self, *args, **kwargs): - """ - Updates which cells are marked in order to block flow in the contact region as part of the contact marks method. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/update_contact_marks").execute(*args, **kwargs) - def flow_control(self, *args, **kwargs): - """ - Enables/disables flow control in the contact region. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/flow_control").execute(*args, **kwargs) - def contact_method(self, *args, **kwargs): - """ - Selects the method used for flow control in the contact region. Enter 0 for the contact zones method (which restricts the flow using additional cell zones with porous zone properties) or 1 for the contact marks method (which blocks the flow using zero-mass-flux boundaries). - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/contact_method").execute(*args, **kwargs) - def render_contact_cells(self, *args, **kwargs): - """ - Enables/disables the availability of a field variable (contact-cell-mark) that can be used to display contours of cells marked for flow blocking as part of the contact marks method, and allows you to postprocess other field variables on those cells. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/render_contact_cells").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Sets the level of detail printed in the console regarding contact detection. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/verbosity").execute(*args, **kwargs) - - class flow_control_parameters(metaclass=PyMenuMeta): - """ - Enters the flow control parameters menu, which provides settings related to controlling the flow in the contact region. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def solution_stabilization(self, *args, **kwargs): - """ - Enables/disables the performance of additional iterations per time step and the application of solution controls to improve the stability of the solver as part of the contact marks method. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/flow_control_parameters/solution_stabilization").execute(*args, **kwargs) - def create_flow_control_zone(self, *args, **kwargs): - """ - Creates a flow control zone as part of the contact zones method. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/flow_control_parameters/create_flow_control_zone").execute(*args, **kwargs) - def delete_flow_control_zone(self, *args, **kwargs): - """ - Deletes a flow control zone as part of the contact zones method. - """ - return PyMenu(self.service, "/define/dynamic_mesh/controls/contact_parameters/flow_control_parameters/delete_flow_control_zone").execute(*args, **kwargs) - - class events(metaclass=PyMenuMeta): - """ - Enters the dynamic mesh events menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def import_event_file(self, *args, **kwargs): - """ - Imports dynamic mesh event file. - """ - return PyMenu(self.service, "/define/dynamic_mesh/events/import_event_file").execute(*args, **kwargs) - def export_event_file(self, *args, **kwargs): - """ - Exports dynamic mesh events to file. - """ - return PyMenu(self.service, "/define/dynamic_mesh/events/export_event_file").execute(*args, **kwargs) - - class zones(metaclass=PyMenuMeta): - """ - Enters the dynamic mesh zones menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def create(self, *args, **kwargs): - """ - Creates or edit a dynamic zone. - """ - return PyMenu(self.service, "/define/dynamic_mesh/zones/create").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes a dynamic zone. - """ - return PyMenu(self.service, "/define/dynamic_mesh/zones/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Lists the dynamic zones. - """ - return PyMenu(self.service, "/define/dynamic_mesh/zones/list").execute(*args, **kwargs) - def insert_boundary_layer(self, *args, **kwargs): - """ - Inserts a new cell zone. - """ - return PyMenu(self.service, "/define/dynamic_mesh/zones/insert_boundary_layer").execute(*args, **kwargs) - def remove_boundary_layer(self, *args, **kwargs): - """ - Removes a cell zone. - """ - return PyMenu(self.service, "/define/dynamic_mesh/zones/remove_boundary_layer").execute(*args, **kwargs) - def insert_interior_layer(self, *args, **kwargs): - """ - Inserts a new layer cell zone at a specified location. - """ - return PyMenu(self.service, "/define/dynamic_mesh/zones/insert_interior_layer").execute(*args, **kwargs) - def remove_interior_layer(self, *args, **kwargs): - """ - Removes an interior layer cell zone. - """ - return PyMenu(self.service, "/define/dynamic_mesh/zones/remove_interior_layer").execute(*args, **kwargs) - - class actions(metaclass=PyMenuMeta): - """ - Enters the dynamic mesh action menu, where you can initiate manual remeshing (that is, remeshing without running a calculation). - """ - def __init__(self, path, service): - self.path = path - self.service = service - def remesh_cell_zone(self, *args, **kwargs): - """ - Manually remeshes a cell zone with option to remesh adjacent dynamic face zones. - """ - return PyMenu(self.service, "/define/dynamic_mesh/actions/remesh_cell_zone").execute(*args, **kwargs) - - class transient_settings(metaclass=PyMenuMeta): - """ - Enters the transient dynamic mesh settings menu. This text command is only available when you enable dynamic mesh using the prompts of the define/dynamic-mesh/dynamic-mesh? text command. Solver time must also be set to Transient. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def verbosity(self, *args, **kwargs): - """ - Enables/disables transient scheme verbosity for dynamic mesh cases. - """ - return PyMenu(self.service, "/define/dynamic_mesh/transient_settings/verbosity").execute(*args, **kwargs) - def allow_second_order(self, *args, **kwargs): - """ - Enables/disables second order transient scheme for dynamic mesh cases. - """ - return PyMenu(self.service, "/define/dynamic_mesh/transient_settings/allow_second_order").execute(*args, **kwargs) - - class mesh_interfaces(metaclass=PyMenuMeta): - """ - Enters the mesh-interfaces menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.non_conformal_interface_numerics = self.__class__.non_conformal_interface_numerics(path + [("non_conformal_interface_numerics", None)], service) - self.mapped_interface_options = self.__class__.mapped_interface_options(path + [("mapped_interface_options", None)], service) - self.auto_options = self.__class__.auto_options(path + [("auto_options", None)], service) - def create(self, *args, **kwargs): - """ - Creates mesh interfaces. - """ - return PyMenu(self.service, "/define/mesh_interfaces/create").execute(*args, **kwargs) - def turbo_create(self, *args, **kwargs): - """ - Creates a general turbo interface. This text command is only available if the define/turbo-model/enable-turbo-model? text command is enabled. - """ - return PyMenu(self.service, "/define/mesh_interfaces/turbo_create").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edits attributes of existing mesh interfaces. For one-to-one interfaces, you can edit the name; for many-to-many interfaces, you can edit the interface options and (for a single interface) the name and the list of interface zones assigned to the interface. - """ - return PyMenu(self.service, "/define/mesh_interfaces/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes a mesh interface. - """ - return PyMenu(self.service, "/define/mesh_interfaces/delete").execute(*args, **kwargs) - def display(self, *args, **kwargs): - """ - Displays the specified mesh interface zone. - """ - return PyMenu(self.service, "/define/mesh_interfaces/display").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Lists all mesh interfaces. - """ - return PyMenu(self.service, "/define/mesh_interfaces/list").execute(*args, **kwargs) - def make_periodic(self, *args, **kwargs): - """ - Make interface zones periodic. - """ - return PyMenu(self.service, "/define/mesh_interfaces/make_periodic").execute(*args, **kwargs) - def make_phaselag_from_boundaries(self, *args, **kwargs): - """ - Make interface zones phase lagged. - """ - return PyMenu(self.service, "/define/mesh_interfaces/make_phaselag_from_boundaries").execute(*args, **kwargs) - def make_phaselag_from_periodic(self, *args, **kwargs): - """ - Convert periodic interface to phase lagged. - """ - return PyMenu(self.service, "/define/mesh_interfaces/make_phaselag_from_periodic").execute(*args, **kwargs) - def delete_all(self, *args, **kwargs): - """ - Deletes all mesh interfaces. - """ - return PyMenu(self.service, "/define/mesh_interfaces/delete_all").execute(*args, **kwargs) - def enforce_continuity_after_bc(self, *args, **kwargs): - """ - Enables/disables continuity across the boundary condition interface for contour plots in postprocessing. - """ - return PyMenu(self.service, "/define/mesh_interfaces/enforce_continuity_after_bc").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Sets the mesh interface verbosity. - """ - return PyMenu(self.service, "/define/mesh_interfaces/verbosity").execute(*args, **kwargs) - def enable_si_with_nodes(self, *args, **kwargs): - """ - Enable sliding interfaces with nodes. - """ - return PyMenu(self.service, "/define/mesh_interfaces/enable_si_with_nodes").execute(*args, **kwargs) - def enforce_coupled_wall_between_solids(self, *args, **kwargs): - """ - Enables/disables automatic definition of solid-solid interfaces as coupled walls. By default this option is disabled and ANSYS Fluent creates interior boundaries at solid-solid interfaces. - """ - return PyMenu(self.service, "/define/mesh_interfaces/enforce_coupled_wall_between_solids").execute(*args, **kwargs) - def improve_quality(self, *args, **kwargs): - """ - Checks the quality of all mapped interfaces. If Fluent finds any mapped interfaces that require improvement it will list them and ask you if you would like to increase the tolerance to improve the interfaces. - """ - return PyMenu(self.service, "/define/mesh_interfaces/improve_quality").execute(*args, **kwargs) - def one_to_one_pairing(self, *args, **kwargs): - """ - Use the default one-to-one interface creation method?. - """ - return PyMenu(self.service, "/define/mesh_interfaces/one_to_one_pairing").execute(*args, **kwargs) - def auto_pairing(self, *args, **kwargs): - """ - Automatically "pairs" some or all of the interface zones, in order to create mesh interfaces. This text command is only available when the define/mesh-interfaces/one-to-one-pairing? text command is disabled. - """ - return PyMenu(self.service, "/define/mesh_interfaces/auto_pairing").execute(*args, **kwargs) - def enable_visualization_of_interfaces(self, *args, **kwargs): - """ - Enables/disables the filling of node coordinates on the zones of mesh interfaces, so that they can be displayed in the graphics window. - """ - return PyMenu(self.service, "/define/mesh_interfaces/enable_visualization_of_interfaces").execute(*args, **kwargs) - def transfer_motion_across_interfaces(self, *args, **kwargs): - """ - Enables/disables the automatic transfer of motion across a mesh interface when only one side is moving as a result of user-defined or system coupling motion. You can specify the method by which the motion is transferred: transfer-displacements (the default) interpolates nodal displacement from the active side of the interface to the passive side, and is recommended when there are gaps and/or penetrations in the mesh interface that must be maintained; project-nodes projects the passive nodes onto the faces of active side, and is recommended when the active side includes significant tangential motion (as only the normal displacement is effectively transferred in this method). - """ - return PyMenu(self.service, "/define/mesh_interfaces/transfer_motion_across_interfaces").execute(*args, **kwargs) - def non_overlapping_zone_name(self, *args, **kwargs): - """ - Get non-overlapping zone name from the associated interface zone. - """ - return PyMenu(self.service, "/define/mesh_interfaces/non_overlapping_zone_name").execute(*args, **kwargs) - def remove_left_handed_interface_faces(self, *args, **kwargs): - """ - Removes left-handed faces (which can cause the mesh to be invalid) during mesh interface creation. - """ - return PyMenu(self.service, "/define/mesh_interfaces/remove_left_handed_interface_faces").execute(*args, **kwargs) - - class non_conformal_interface_numerics(metaclass=PyMenuMeta): - """ - Setting non-conformal numerics options. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def change_numerics(self, *args, **kwargs): - """ - Enable modified non-conformal interface numerics. - """ - return PyMenu(self.service, "/define/mesh_interfaces/non_conformal_interface_numerics/change_numerics").execute(*args, **kwargs) - - class mapped_interface_options(metaclass=PyMenuMeta): - """ - Enter the mapped-interface-options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def solution_controls(self, *args, **kwargs): - """ - Specification of mapped frequency and under-relaxation factor for mapped interfaces. - """ - return PyMenu(self.service, "/define/mesh_interfaces/mapped_interface_options/solution_controls").execute(*args, **kwargs) - def tolerance(self, *args, **kwargs): - """ - Specification of mapped interface tolerance. - """ - return PyMenu(self.service, "/define/mesh_interfaces/mapped_interface_options/tolerance").execute(*args, **kwargs) - def convert_to_mapped_interface(self, *args, **kwargs): - """ - Convert non-conformal mesh interface to mapped mesh interfaces. - """ - return PyMenu(self.service, "/define/mesh_interfaces/mapped_interface_options/convert_to_mapped_interface").execute(*args, **kwargs) - - class auto_options(metaclass=PyMenuMeta): - """ - Enters the auto-options menu. This menu is only available when the define/mesh-interfaces/one-to-one-pairing? text command is enabled. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def proximity_tolerance(self, *args, **kwargs): - """ - Sets the tolerance used as part of the automatic grouping of zones to create mesh interfaces when the define/mesh-interfaces/one-to-one-pairing? text command is disabled. The proximity tolerance is defined relative to the edge lengths in the interface zones, and can range from 0 to 1 (representing the minimum and maximum edge lengths, respectively). - """ - return PyMenu(self.service, "/define/mesh_interfaces/auto_options/proximity_tolerance").execute(*args, **kwargs) - def naming_option(self, *args, **kwargs): - """ - Specifies whether the name of each new one-to-one mesh interface (as well as existing mesh interfaces, if you so desire) has no additional suffix, or a suffix that includes the names of the associated boundary zones, the IDs of the associated boundary zones, or the names of the adjacent cell zones. - """ - return PyMenu(self.service, "/define/mesh_interfaces/auto_options/naming_option").execute(*args, **kwargs) - def set_default_name_prefix(self, *args, **kwargs): - """ - Specifies the default interface name prefix used for one-to-one mesh interfaces. - """ - return PyMenu(self.service, "/define/mesh_interfaces/auto_options/set_default_name_prefix").execute(*args, **kwargs) - def set_one_to_one_pairing_tolerance(self, *args, **kwargs): - """ - Enables/disables the use of adjustable tolerances to determine which of the selected boundary zones can be paired up to make the mesh interfaces, in order to account for gaps, thin layers, and/or complex geometries. - """ - return PyMenu(self.service, "/define/mesh_interfaces/auto_options/set_one_to_one_pairing_tolerance").execute(*args, **kwargs) - def pairing_between_different_cell_zones_only(self, *args, **kwargs): - """ - Specifies whether the one-to-one mesh interfaces are only created between different cell zones. - """ - return PyMenu(self.service, "/define/mesh_interfaces/auto_options/pairing_between_different_cell_zones_only").execute(*args, **kwargs) - def pairing_between_interface_zones_only(self, *args, **kwargs): - """ - Pairing between interface zones only. - """ - return PyMenu(self.service, "/define/mesh_interfaces/auto_options/pairing_between_interface_zones_only").execute(*args, **kwargs) - def keep_empty_interface(self, *args, **kwargs): - """ - Keep empty interfaces during one-to-one mesh interface creation. - """ - return PyMenu(self.service, "/define/mesh_interfaces/auto_options/keep_empty_interface").execute(*args, **kwargs) - - class gap_model(metaclass=PyMenuMeta): - """ - Enters the gap model menu, where you can define one or more gap regions where the flow is blocked or decelerated when face zones move within a specified proximity threshold of each other. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.advanced_options = self.__class__.advanced_options(path + [("advanced_options", None)], service) - def enable(self, *args, **kwargs): - """ - Enables/disables the gap model. - """ - return PyMenu(self.service, "/define/gap_model/enable").execute(*args, **kwargs) - def create(self, *args, **kwargs): - """ - Creates a single gap region, so that when selected face zones move within a specified proximity threshold of each other, flow blockage / deceleration is applied to the cells that lie within the threshold. - """ - return PyMenu(self.service, "/define/gap_model/create").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edits an existing gap region. - """ - return PyMenu(self.service, "/define/gap_model/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes an existing gap region. - """ - return PyMenu(self.service, "/define/gap_model/delete").execute(*args, **kwargs) - def delete_all(self, *args, **kwargs): - """ - Deletes all of the existing gap regions. - """ - return PyMenu(self.service, "/define/gap_model/delete_all").execute(*args, **kwargs) - def list_gap_regions(self, *args, **kwargs): - """ - Lists the properties of the gap regions. - """ - return PyMenu(self.service, "/define/gap_model/list_gap_regions").execute(*args, **kwargs) - def list_gap_face_zones(self, *args, **kwargs): - """ - Lists the names of the face zones that can be used for creating gap regions. - """ - return PyMenu(self.service, "/define/gap_model/list_gap_face_zones").execute(*args, **kwargs) - def list_gap_cell_zones(self, *args, **kwargs): - """ - Lists the names of the cell zones that can be excluded for individual gap regions (so that such cells are not marked for flow blockage / deceleration). - """ - return PyMenu(self.service, "/define/gap_model/list_gap_cell_zones").execute(*args, **kwargs) - def render_gap_regions(self, *args, **kwargs): - """ - Update gap regions for postprocessing. - """ - return PyMenu(self.service, "/define/gap_model/render_gap_regions").execute(*args, **kwargs) - - class advanced_options(metaclass=PyMenuMeta): - """ - Enters the advanced options menu for the gap model. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def expert(self, *args, **kwargs): - """ - Enables/disables access to expert-level text commands for the gap model. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/expert").execute(*args, **kwargs) - def alternative_marking(self, *args, **kwargs): - """ - Mark gap regions using an alternative marking algorithm. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/alternative_marking").execute(*args, **kwargs) - def cell_check_distance_factor(self, *args, **kwargs): - """ - Enter value of the cell distance factor. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/cell_check_distance_factor").execute(*args, **kwargs) - def flow_blocking_stabilization_parameters(self, *args, **kwargs): - """ - Adjust stabilization settings for the sponge layer used for blocked gap regions. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/flow_blocking_stabilization_parameters").execute(*args, **kwargs) - def update_gap_regions(self, *args, **kwargs): - """ - Update gap regions and gap model solution information. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/update_gap_regions").execute(*args, **kwargs) - def clear_gap_regions(self, *args, **kwargs): - """ - Clear gap model solution information and marks. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/clear_gap_regions").execute(*args, **kwargs) - def precise_gap_marking(self, *args, **kwargs): - """ - Enables/disables the use of a more accurate search algorithm for marking cells in gap regions. Note that it can be costly, particularly for 3D cases or those with a large number of cells inside the gap regions. This text command is only available if you have enabled the define/gap-model/advanced-options/expert? text command. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/precise_gap_marking").execute(*args, **kwargs) - def render_flow_modeling_gaps(self, *args, **kwargs): - """ - Enables/disables the rendering of the solution in the cells of flow-modeling gap regions during postprocessing. This text command is only available if you have enabled the define/gap-model/advanced-options/expert? text command. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/render_flow_modeling_gaps").execute(*args, **kwargs) - def reduce_gap_regions(self, *args, **kwargs): - """ - Enables/disables a more restrictive algorithm for marking cells in gap regions. This text command is only available if you have enabled the define/gap-model/advanced-options/expert? text command. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/reduce_gap_regions").execute(*args, **kwargs) - def fill_data_in_gap_regions(self, *args, **kwargs): - """ - Enables/disables the interpolation of solution data throughout the gap regions. This text command is only available if you have enabled the define/gap-model/advanced-options/expert? text command. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/fill_data_in_gap_regions").execute(*args, **kwargs) - def enhanced_data_interpolation(self, *args, **kwargs): - """ - Enables/disables the use of enhanced data interpolation when updating information in gap regions. This text command is only available if you have enabled the define/gap-model/advanced-options/expert? text command. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/enhanced_data_interpolation").execute(*args, **kwargs) - def sponge_layer(self, *args, **kwargs): - """ - Allows you to edit the solution stabilization settings for flow-modeling gap regions that have sponge-layer local stabilization enabled. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/sponge_layer").execute(*args, **kwargs) - def solution_stabilization(self, *args, **kwargs): - """ - Sets the global solution stabilization level for the gap regions. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/solution_stabilization").execute(*args, **kwargs) - def include_coupled_walls(self, *args, **kwargs): - """ - Include coupled walls in gap face zones. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/include_coupled_walls").execute(*args, **kwargs) - def check_cfl_condition(self, *args, **kwargs): - """ - Enables/disables the printing of warnings if the time step size is too large based on a Courant (CFL) number automatically determined for your specified solution stability level. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/check_cfl_condition").execute(*args, **kwargs) - def extend_gap_regions(self, *args, **kwargs): - """ - Enables/disables the extending of the gap regions by including additional cells in the vicinity of the gap interfaces during marking. This is useful when the default shape of the marked cells is negatively affecting solution stability or convergence behavior. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/extend_gap_regions").execute(*args, **kwargs) - def revert_controls_to_default(self, *args, **kwargs): - """ - Reverts the global gap stabilization level and any related solver settings to the default. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/revert_controls_to_default").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Sets the verbosity for messages printed in the console related to the gap model. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/verbosity").execute(*args, **kwargs) - def render_gap_interface(self, *args, **kwargs): - """ - Enables/disables the rendering of the mesh surfaces inside the gap regions when displaying the mesh with contours. Note that the solution is still not rendered inside the flow-blocking gap regions. - """ - return PyMenu(self.service, "/define/gap_model/advanced_options/render_gap_interface").execute(*args, **kwargs) - - class materials(metaclass=PyMenuMeta): - """ - Enters the materials menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.data_base = self.__class__.data_base(path + [("data_base", None)], service) - def change_create(self, *args, **kwargs): - """ - Changes the properties of a locally-stored material or create a new material. Generally, the properties you enter at the prompts will be filtered according to your case and model settings. However, some of the listed properties may not match the selection choice in the Graphics User Interface. Typically, those excessive properties in the Text User Interface will not be used in your simulation. - """ - return PyMenu(self.service, "/define/materials/change_create").execute(*args, **kwargs) - def copy(self, *args, **kwargs): - """ - Copies a material from the database. - """ - return PyMenu(self.service, "/define/materials/copy").execute(*args, **kwargs) - def copy_by_formula(self, *args, **kwargs): - """ - Copies a material from the database by formula. - """ - return PyMenu(self.service, "/define/materials/copy_by_formula").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes a material from local storage. - """ - return PyMenu(self.service, "/define/materials/delete").execute(*args, **kwargs) - def list_materials(self, *args, **kwargs): - """ - Lists all locally-stored materials. - """ - return PyMenu(self.service, "/define/materials/list_materials").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): - """ - Lists the properties of a locally-stored material. - """ - return PyMenu(self.service, "/define/materials/list_properties").execute(*args, **kwargs) - - class data_base(metaclass=PyMenuMeta): - """ - Enters the material database menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def database_type(self, *args, **kwargs): - """ - Sets the database type (fluent-database, granta-mds, or user-defined). - """ - return PyMenu(self.service, "/define/materials/data_base/database_type").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edits material. - """ - return PyMenu(self.service, "/define/materials/data_base/edit").execute(*args, **kwargs) - def list_materials(self, *args, **kwargs): - """ - Lists all materials in the database. - """ - return PyMenu(self.service, "/define/materials/data_base/list_materials").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): - """ - Lists the properties of a material in the database. - """ - return PyMenu(self.service, "/define/materials/data_base/list_properties").execute(*args, **kwargs) - def new(self, *args, **kwargs): - """ - Defines new material. - """ - return PyMenu(self.service, "/define/materials/data_base/new").execute(*args, **kwargs) - def save(self, *args, **kwargs): - """ - Saves user-defined database. - """ - return PyMenu(self.service, "/define/materials/data_base/save").execute(*args, **kwargs) - - class mixing_planes(metaclass=PyMenuMeta): - """ - Enters the mixing planes menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.set = self.__class__.set(path + [("set", None)], service) - def create(self, *args, **kwargs): - """ - Creates a mixing plane. - """ - return PyMenu(self.service, "/define/mixing_planes/create").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes a mixing plane. - """ - return PyMenu(self.service, "/define/mixing_planes/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Lists defined mixing plane(s). - """ - return PyMenu(self.service, "/define/mixing_planes/list").execute(*args, **kwargs) - - class set(metaclass=PyMenuMeta): - """ - Sets global parameters relevant to mixing planes. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.conserve_swirl = self.__class__.conserve_swirl(path + [("conserve_swirl", None)], service) - self.conserve_total_enthalpy = self.__class__.conserve_total_enthalpy(path + [("conserve_total_enthalpy", None)], service) - def under_relaxation(self, *args, **kwargs): - """ - Sets mixing plane under-relaxation factor. - """ - return PyMenu(self.service, "/define/mixing_planes/set/under_relaxation").execute(*args, **kwargs) - def averaging_method(self, *args, **kwargs): - """ - Sets the mixing plane profile averaging method. - """ - return PyMenu(self.service, "/define/mixing_planes/set/averaging_method").execute(*args, **kwargs) - def fix_pressure_level(self, *args, **kwargs): - """ - Sets fixed pressure level using value based on define/reference-pressure-location. - """ - return PyMenu(self.service, "/define/mixing_planes/set/fix_pressure_level").execute(*args, **kwargs) - - class conserve_swirl(metaclass=PyMenuMeta): - """ - Enters the menu to set swirl conservation in mixing plane menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable(self, *args, **kwargs): - """ - Enables/disables swirl conservation in mixing plane. - """ - return PyMenu(self.service, "/define/mixing_planes/set/conserve_swirl/enable").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Enables/disables verbosity in swirl conservation calculations. - """ - return PyMenu(self.service, "/define/mixing_planes/set/conserve_swirl/verbosity").execute(*args, **kwargs) - def report_swirl_integration(self, *args, **kwargs): - """ - Reports swirl integration (Torque) on inflow and outflow zones. - """ - return PyMenu(self.service, "/define/mixing_planes/set/conserve_swirl/report_swirl_integration").execute(*args, **kwargs) - - class conserve_total_enthalpy(metaclass=PyMenuMeta): - """ - Enters the menu to set total enthalpy conservation in mixing plane menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable(self, *args, **kwargs): - """ - Enables/disables total enthalpy conservation in mixing plane. - """ - return PyMenu(self.service, "/define/mixing_planes/set/conserve_total_enthalpy/enable").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Enables/disables verbosity in total-enthalpy conservation calculations. - """ - return PyMenu(self.service, "/define/mixing_planes/set/conserve_total_enthalpy/verbosity").execute(*args, **kwargs) - - class models(metaclass=PyMenuMeta): - """ - Enters the models menu to configure the solver. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.acoustics = self.__class__.acoustics(path + [("acoustics", None)], service) - self.optics = self.__class__.optics(path + [("optics", None)], service) - self.eulerian_wallfilm = self.__class__.eulerian_wallfilm(path + [("eulerian_wallfilm", None)], service) - self.dpm = self.__class__.dpm(path + [("dpm", None)], service) - self.shell_conduction = self.__class__.shell_conduction(path + [("shell_conduction", None)], service) - self.system_coupling_settings = self.__class__.system_coupling_settings(path + [("system_coupling_settings", None)], service) - self.cht = self.__class__.cht(path + [("cht", None)], service) - self.two_temperature = self.__class__.two_temperature(path + [("two_temperature", None)], service) - self.multiphase = self.__class__.multiphase(path + [("multiphase", None)], service) - self.nox_parameters = self.__class__.nox_parameters(path + [("nox_parameters", None)], service) - self.soot_parameters = self.__class__.soot_parameters(path + [("soot_parameters", None)], service) - self.radiation = self.__class__.radiation(path + [("radiation", None)], service) - self.solver = self.__class__.solver(path + [("solver", None)], service) - self.species = self.__class__.species(path + [("species", None)], service) - self.viscous = self.__class__.viscous(path + [("viscous", None)], service) - self.structure = self.__class__.structure(path + [("structure", None)], service) - self.heat_exchanger = self.__class__.heat_exchanger(path + [("heat_exchanger", None)], service) - self.electrolysis_setup = self.__class__.electrolysis_setup(path + [("electrolysis_setup", None)], service) - def addon_module(self, *args, **kwargs): - """ - Loads addon module. - """ - return PyMenu(self.service, "/define/models/addon_module").execute(*args, **kwargs) - def axisymmetric(self, *args, **kwargs): - """ - Specifies whether or not the domain is axisymmetric. - """ - return PyMenu(self.service, "/define/models/axisymmetric").execute(*args, **kwargs) - def solidification_melting(self, *args, **kwargs): - """ - Enables/disables the solidification and melting model. - """ - return PyMenu(self.service, "/define/models/solidification_melting").execute(*args, **kwargs) - def crevice_model(self, *args, **kwargs): - """ - Enables/disables the crevice model. - """ - return PyMenu(self.service, "/define/models/crevice_model").execute(*args, **kwargs) - def crevice_model_controls(self, *args, **kwargs): - """ - Enters the crevice model controls menu. - """ - return PyMenu(self.service, "/define/models/crevice_model_controls").execute(*args, **kwargs) - def energy(self, *args, **kwargs): - """ - Enables/disables the energy model. - """ - return PyMenu(self.service, "/define/models/energy").execute(*args, **kwargs) - def noniterative_time_advance(self, *args, **kwargs): - """ - Enables/disables noniterative time advancement scheme. - """ - return PyMenu(self.service, "/define/models/noniterative_time_advance").execute(*args, **kwargs) - def nox(self, *args, **kwargs): - """ - Enables/disables the NOx model. - """ - return PyMenu(self.service, "/define/models/nox").execute(*args, **kwargs) - def soot(self, *args, **kwargs): - """ - Enables/disables the soot model. - """ - return PyMenu(self.service, "/define/models/soot").execute(*args, **kwargs) - def steady(self, *args, **kwargs): - """ - Enables/disables the steady solution model. - """ - return PyMenu(self.service, "/define/models/steady").execute(*args, **kwargs) - def swirl(self, *args, **kwargs): - """ - Enables/disables axisymmetric swirl velocity. - """ - return PyMenu(self.service, "/define/models/swirl").execute(*args, **kwargs) - def unsteady_1st_order(self, *args, **kwargs): - """ - Selects the first-order implicit formulation for transient simulations. - """ - return PyMenu(self.service, "/define/models/unsteady_1st_order").execute(*args, **kwargs) - def frozen_flux(self, *args, **kwargs): - """ - Enables/disables frozen flux formulation for transient flows. - """ - return PyMenu(self.service, "/define/models/frozen_flux").execute(*args, **kwargs) - def unsteady_2nd_order(self, *args, **kwargs): - """ - Selects the second-order implicit formulation for transient simulations. - """ - return PyMenu(self.service, "/define/models/unsteady_2nd_order").execute(*args, **kwargs) - def unsteady_2nd_order_bounded(self, *args, **kwargs): - """ - Selects the bounded second-order implicit formulation for transient simulations. - """ - return PyMenu(self.service, "/define/models/unsteady_2nd_order_bounded").execute(*args, **kwargs) - def unsteady_global_time(self, *args, **kwargs): - """ - Selects the explicit transient formulation. This text command is only available for unsteady cases that use the density-based solver with the explicit formulation. - """ - return PyMenu(self.service, "/define/models/unsteady_global_time").execute(*args, **kwargs) - def unsteady_structure_newmark(self, *args, **kwargs): - """ - Selects the Newmark method for the direct time integration of the finite element semi-discrete equation of motion. This text command is only available for transient simulations that use the structural model. - """ - return PyMenu(self.service, "/define/models/unsteady_structure_newmark").execute(*args, **kwargs) - def unsteady_structure_euler(self, *args, **kwargs): - """ - Selects the backward Euler method for the direct time integration of the finite element semi-discrete equation of motion. This text command is only available for transient simulations that use the structural model. - """ - return PyMenu(self.service, "/define/models/unsteady_structure_euler").execute(*args, **kwargs) - def battery_model(self, *args, **kwargs): - """ - Enables the dual potential MSMD battery model. For text commands that become available when the battery model is enabled, refer to Battery Model Text Commands - - """ - return PyMenu(self.service, "/define/models/battery_model").execute(*args, **kwargs) - def ablation(self, *args, **kwargs): - """ - Enables/disables the ablation model. - """ - return PyMenu(self.service, "/define/models/ablation").execute(*args, **kwargs) - def potential_and_li_ion_battery(self, *args, **kwargs): - """ - Enables/disables the electric-potential model. - """ - return PyMenu(self.service, "/define/models/potential_and_li_ion_battery").execute(*args, **kwargs) - - class acoustics(metaclass=PyMenuMeta): - """ - Enters the acoustics menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.far_field_parameters = self.__class__.far_field_parameters(path + [("far_field_parameters", None)], service) - self.wave_equation_options = self.__class__.wave_equation_options(path + [("wave_equation_options", None)], service) - self.sources_fft = self.__class__.sources_fft(path + [("sources_fft", None)], service) - self.sponge_layers = self.__class__.sponge_layers(path + [("sponge_layers", None)], service) - def off(self, *args, **kwargs): - """ - Enables/disables the acoustics model. - """ - return PyMenu(self.service, "/define/models/acoustics/off").execute(*args, **kwargs) - def ffowcs_williams(self, *args, **kwargs): - """ - Enables/disables the Ffowcs-Williams-and-Hawkings model. - """ - return PyMenu(self.service, "/define/models/acoustics/ffowcs_williams").execute(*args, **kwargs) - def broad_band_noise(self, *args, **kwargs): - """ - Enables/disables the broadband noise model. - """ - return PyMenu(self.service, "/define/models/acoustics/broad_band_noise").execute(*args, **kwargs) - def modal_analysis(self, *args, **kwargs): - """ - Enable/disable the modal analysis model. - """ - return PyMenu(self.service, "/define/models/acoustics/modal_analysis").execute(*args, **kwargs) - def wave_equation(self, *args, **kwargs): - """ - Enables/disables the wave equation model. - """ - return PyMenu(self.service, "/define/models/acoustics/wave_equation").execute(*args, **kwargs) - def receivers(self, *args, **kwargs): - """ - Sets acoustic receivers. - """ - return PyMenu(self.service, "/define/models/acoustics/receivers").execute(*args, **kwargs) - def export_source_data(self, *args, **kwargs): - """ - Enables/disables the export of acoustic source data in ASD format during the wave equation model run. - """ - return PyMenu(self.service, "/define/models/acoustics/export_source_data").execute(*args, **kwargs) - def export_source_data_cgns(self, *args, **kwargs): - """ - Enables/disables the export of acoustic source data in CGNS format. - """ - return PyMenu(self.service, "/define/models/acoustics/export_source_data_cgns").execute(*args, **kwargs) - def sources(self, *args, **kwargs): - """ - Sets acoustic sources. - """ - return PyMenu(self.service, "/define/models/acoustics/sources").execute(*args, **kwargs) - def read_compute_write(self, *args, **kwargs): - """ - Reads acoustic source data files and computes sound pressure. - """ - return PyMenu(self.service, "/define/models/acoustics/read_compute_write").execute(*args, **kwargs) - def write_acoustic_signals(self, *args, **kwargs): - """ - Writes on-the-fly sound pressure. - """ - return PyMenu(self.service, "/define/models/acoustics/write_acoustic_signals").execute(*args, **kwargs) - def compute_write(self, *args, **kwargs): - """ - Computes sound pressure. - """ - return PyMenu(self.service, "/define/models/acoustics/compute_write").execute(*args, **kwargs) - def write_centroid_info(self, *args, **kwargs): - """ - Writes centroid info. - """ - return PyMenu(self.service, "/define/models/acoustics/write_centroid_info").execute(*args, **kwargs) - def acoustic_modal_analysis(self, *args, **kwargs): - """ - Iterate linear acoustic solver to compute the resonance frequencies and the acoustic modes. - """ - return PyMenu(self.service, "/define/models/acoustics/acoustic_modal_analysis").execute(*args, **kwargs) - def export_volumetric_sources(self, *args, **kwargs): - """ - Enables/disables the export of fluid zones. - """ - return PyMenu(self.service, "/define/models/acoustics/export_volumetric_sources").execute(*args, **kwargs) - def export_volumetric_sources_cgns(self, *args, **kwargs): - """ - Enables/disables the export of fluid zones. - """ - return PyMenu(self.service, "/define/models/acoustics/export_volumetric_sources_cgns").execute(*args, **kwargs) - def display_flow_time(self, *args, **kwargs): - """ - Enables/disables the display of flow time during read-and-compute. - """ - return PyMenu(self.service, "/define/models/acoustics/display_flow_time").execute(*args, **kwargs) - def cylindrical_export(self, *args, **kwargs): - """ - Enables/disables the export of data in cylindrical coordinates. - """ - return PyMenu(self.service, "/define/models/acoustics/cylindrical_export").execute(*args, **kwargs) - def auto_prune(self, *args, **kwargs): - """ - Enables/disables auto prune of the receiver signal(s) during read-and-compute. - """ - return PyMenu(self.service, "/define/models/acoustics/auto_prune").execute(*args, **kwargs) - def moving_receiver(self, *args, **kwargs): - """ - Enables/disables the moving receiver option. - """ - return PyMenu(self.service, "/define/models/acoustics/moving_receiver").execute(*args, **kwargs) - def convective_effects(self, *args, **kwargs): - """ - Enables/disables the convective effects option. - """ - return PyMenu(self.service, "/define/models/acoustics/convective_effects").execute(*args, **kwargs) - def display_frequencies(self, *args, **kwargs): - """ - Display resonance frequencies. - """ - return PyMenu(self.service, "/define/models/acoustics/display_frequencies").execute(*args, **kwargs) - - class far_field_parameters(metaclass=PyMenuMeta): - """ - Enters the menu to specify the far-field density and speed of sound. Note that this menu is currently available only with the acoustics wave equation model. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def far_field_density(self, *args, **kwargs): - """ - Specifies the far-field density value for the acoustics wave equation model. - """ - return PyMenu(self.service, "/define/models/acoustics/far_field_parameters/far_field_density").execute(*args, **kwargs) - def far_field_sound_speed(self, *args, **kwargs): - """ - Specifies the far-field speed of sound value for the acoustics wave equation model. - """ - return PyMenu(self.service, "/define/models/acoustics/far_field_parameters/far_field_sound_speed").execute(*args, **kwargs) - - class wave_equation_options(metaclass=PyMenuMeta): - """ - Enters the menu to define the acoustics wave equation model options. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.basic_shapes = self.__class__.basic_shapes(path + [("basic_shapes", None)], service) - self.remote_receivers_options = self.__class__.remote_receivers_options(path + [("remote_receivers_options", None)], service) - def time_filter_source(self, *args, **kwargs): - """ - Enables/disables a time filter for the sound source. - """ - return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/time_filter_source").execute(*args, **kwargs) - def sponge_layer_factor(self, *args, **kwargs): - """ - Specifies the factor of the artificial viscosity coefficient. - """ - return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/sponge_layer_factor").execute(*args, **kwargs) - def sponge_layer_base_level(self, *args, **kwargs): - """ - Specify artificial viscosity base level applied everywhere. - """ - return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/sponge_layer_base_level").execute(*args, **kwargs) - def source_mask_udf(self, *args, **kwargs): - """ - Specifies the name of a user-defined function, which defines geometry of the source mask. - """ - return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/source_mask_udf").execute(*args, **kwargs) - def sponge_layer_udf(self, *args, **kwargs): - """ - Specifies the name of a user-defined function, which defines geometry of the sponge layer. - """ - return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/sponge_layer_udf").execute(*args, **kwargs) - def remote_receivers(self, *args, **kwargs): - """ - Enables/disables the Kirchhoff integral model. - """ - return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/remote_receivers").execute(*args, **kwargs) - - class basic_shapes(metaclass=PyMenuMeta): - """ - Enters the menu to define the geometry of the source mask and sponge layer using the basic shapes, represented by the cell registers of the type "Region". - """ - def __init__(self, path, service): - self.path = path - self.service = service - def list_region_registers(self, *args, **kwargs): - """ - List all available cell registers of the type "Region". - """ - return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/basic_shapes/list_region_registers").execute(*args, **kwargs) - def list_source_mask_shapes(self, *args, **kwargs): - """ - List basic shapes, which are currently used in the definition of the source mask geometry. - """ - return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/basic_shapes/list_source_mask_shapes").execute(*args, **kwargs) - def list_sponge_layer_shapes(self, *args, **kwargs): - """ - List basic shapes, which are currently used in the definition of the sponge layer geometry. - """ - return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/basic_shapes/list_sponge_layer_shapes").execute(*args, **kwargs) - def add_source_mask_shape(self, *args, **kwargs): - """ - Adds a basic shape to the definition of the source mask geometry. - """ - return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/basic_shapes/add_source_mask_shape").execute(*args, **kwargs) - def add_sponge_layer_shape(self, *args, **kwargs): - """ - Adds a basic shape to the definition of the sponge layer geometry. - """ - return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/basic_shapes/add_sponge_layer_shape").execute(*args, **kwargs) - def remove_source_mask_shape(self, *args, **kwargs): - """ - Remove a basic shape from the definition of the source mask geometry. - """ - return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/basic_shapes/remove_source_mask_shape").execute(*args, **kwargs) - def remove_sponge_layer_shape(self, *args, **kwargs): - """ - Remove a basic shape from the definition of the sponge layer geometry. - """ - return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/basic_shapes/remove_sponge_layer_shape").execute(*args, **kwargs) - - class remote_receivers_options(metaclass=PyMenuMeta): - """ - Enters the menu to define remote receivers for the Kirchhoff integral model. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def integration_surface(self, *args, **kwargs): - """ - Selects the integration surface for the Kirchhoff model. - """ - return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/remote_receivers_options/integration_surface").execute(*args, **kwargs) - def write_signals(self, *args, **kwargs): - """ - Writes the computed receiver signals to the ASCII files. - """ - return PyMenu(self.service, "/define/models/acoustics/wave_equation_options/remote_receivers_options/write_signals").execute(*args, **kwargs) - - class sources_fft(metaclass=PyMenuMeta): - """ - Enters the acoustic sources fast Fourier transform (FFT) menu, to compute Fourier spectra from acoustic source data (ASD) files, create postprocessing variables for the pressure signals, and write CGNS files of the spectrum data. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.fft_surface_variables = self.__class__.fft_surface_variables(path + [("fft_surface_variables", None)], service) - def read_asd_files(self, *args, **kwargs): - """ - Reads ASD files to perform FFT of the pressure history field. - """ - return PyMenu(self.service, "/define/models/acoustics/sources_fft/read_asd_files").execute(*args, **kwargs) - def compute_fft_fields(self, *args, **kwargs): - """ - Computes FFT of the read pressure histories. The computed spectra replace the pressure histories in memory. - """ - return PyMenu(self.service, "/define/models/acoustics/sources_fft/compute_fft_fields").execute(*args, **kwargs) - def write_cgns_files(self, *args, **kwargs): - """ - Writes surface pressure spectra in CGNS format, which can be used for one-way coupling with Ansys Mechanical in the frequency domain. - """ - return PyMenu(self.service, "/define/models/acoustics/sources_fft/write_cgns_files").execute(*args, **kwargs) - def clean_up_storage_area(self, *args, **kwargs): - """ - De-allocates memory used to store the pressure histories and their Fourier spectra, as well as any created surface variables for the visualization. - """ - return PyMenu(self.service, "/define/models/acoustics/sources_fft/clean_up_storage_area").execute(*args, **kwargs) - - class fft_surface_variables(metaclass=PyMenuMeta): - """ - Enters the menu to create surface variables from the computed Fourier spectra for visualization. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def create_octave_bands(self, *args, **kwargs): - """ - Creates either the surface pressure level (SPL) variables or the PSD of dp/dt variables for 17 technical octaves. - """ - return PyMenu(self.service, "/define/models/acoustics/sources_fft/fft_surface_variables/create_octave_bands").execute(*args, **kwargs) - def create_third_bands(self, *args, **kwargs): - """ - Creates either the surface pressure level (SPL) variables or the PSD of dp/dt variables for 54 technical thirds. - """ - return PyMenu(self.service, "/define/models/acoustics/sources_fft/fft_surface_variables/create_third_bands").execute(*args, **kwargs) - def create_constant_width_bands(self, *args, **kwargs): - """ - Selects up to 20 constant width bands and creates either the surface pressures level (SPL) variables or the PSD of dp/dt variables for them. - """ - return PyMenu(self.service, "/define/models/acoustics/sources_fft/fft_surface_variables/create_constant_width_bands").execute(*args, **kwargs) - def create_set_of_modes(self, *args, **kwargs): - """ - Selects up to 20 individual Fourier modes and create variable pairs for them, containing the real and the imaginary parts of the complex Fourier amplitudes. - """ - return PyMenu(self.service, "/define/models/acoustics/sources_fft/fft_surface_variables/create_set_of_modes").execute(*args, **kwargs) - def remove_variables(self, *args, **kwargs): - """ - Removes all variables created in this menu. - """ - return PyMenu(self.service, "/define/models/acoustics/sources_fft/fft_surface_variables/remove_variables").execute(*args, **kwargs) - - class sponge_layers(metaclass=PyMenuMeta): - """ - Manage sponge layers where density is blended to eliminate reflections from boundary zones. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def activate(self, *args, **kwargs): - """ - Activate a sponge object. - """ - return PyMenu(self.service, "/define/models/acoustics/sponge_layers/activate").execute(*args, **kwargs) - def add(self, *args, **kwargs): - """ - Add a new sponge layer definition. - """ - return PyMenu(self.service, "/define/models/acoustics/sponge_layers/add").execute(*args, **kwargs) - def deactivate(self, *args, **kwargs): - """ - Deactivate a sponge layer definition. - """ - return PyMenu(self.service, "/define/models/acoustics/sponge_layers/deactivate").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edits an existing sponge layer. You can revise the fields listed previously for the define/models/acoustics/sponge-layers/add text command. - """ - return PyMenu(self.service, "/define/models/acoustics/sponge_layers/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes an existing sponge layer definition. - """ - return PyMenu(self.service, "/define/models/acoustics/sponge_layers/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Prints a list of the existing sponge layers in the console. - """ - return PyMenu(self.service, "/define/models/acoustics/sponge_layers/list").execute(*args, **kwargs) - def list_active(self, *args, **kwargs): - """ - List the names of the active sponge layer definitions. - """ - return PyMenu(self.service, "/define/models/acoustics/sponge_layers/list_active").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): - """ - Prints the properties of an existing sponge layer of your choice in the console. - """ - return PyMenu(self.service, "/define/models/acoustics/sponge_layers/list_properties").execute(*args, **kwargs) - - class optics(metaclass=PyMenuMeta): - """ - Enter the optics model menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.set = self.__class__.set(path + [("set", None)], service) - def enable(self, *args, **kwargs): - """ - Enable/disable optics model. - """ - return PyMenu(self.service, "/define/models/optics/enable").execute(*args, **kwargs) - def add_beam(self, *args, **kwargs): - """ - Add optical beam grid. - """ - return PyMenu(self.service, "/define/models/optics/add_beam").execute(*args, **kwargs) - - class set(metaclass=PyMenuMeta): - """ - Enter the set menu for optics model. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def sampling(self, *args, **kwargs): - """ - Specify when the fluid density field is sampled. - """ - return PyMenu(self.service, "/define/models/optics/set/sampling").execute(*args, **kwargs) - def index_of_refraction(self, *args, **kwargs): - """ - Specify the model parameters of index of refraction. - """ - return PyMenu(self.service, "/define/models/optics/set/index_of_refraction").execute(*args, **kwargs) - def running_average(self, *args, **kwargs): - """ - Setup the running average of the collected density field. - """ - return PyMenu(self.service, "/define/models/optics/set/running_average").execute(*args, **kwargs) - - class eulerian_wallfilm(metaclass=PyMenuMeta): - """ - Enters the Eulerian wall film model menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.coupled_solution = self.__class__.coupled_solution(path + [("coupled_solution", None)], service) - self.implicit_options = self.__class__.implicit_options(path + [("implicit_options", None)], service) - def enable_wallfilm_model(self, *args, **kwargs): - """ - Enables/disables Eulerian Wall Film Model. - """ - return PyMenu(self.service, "/define/models/eulerian_wallfilm/enable_wallfilm_model").execute(*args, **kwargs) - def initialize_wallfilm_model(self, *args, **kwargs): - """ - Initializes Eulerian Wall Film Model. - """ - return PyMenu(self.service, "/define/models/eulerian_wallfilm/initialize_wallfilm_model").execute(*args, **kwargs) - def solve_wallfilm_equation(self, *args, **kwargs): - """ - Activates Eulerian Wall Film Equations. - """ - return PyMenu(self.service, "/define/models/eulerian_wallfilm/solve_wallfilm_equation").execute(*args, **kwargs) - def model_options(self, *args, **kwargs): - """ - Sets Eulerian Wall Film Model Options. - """ - return PyMenu(self.service, "/define/models/eulerian_wallfilm/model_options").execute(*args, **kwargs) - def film_material(self, *args, **kwargs): - """ - Sets Film Material and Properties. - """ - return PyMenu(self.service, "/define/models/eulerian_wallfilm/film_material").execute(*args, **kwargs) - def solution_options(self, *args, **kwargs): - """ - Sets Eulerian Wall Film Model Solution Options. - """ - return PyMenu(self.service, "/define/models/eulerian_wallfilm/solution_options").execute(*args, **kwargs) - - class coupled_solution(metaclass=PyMenuMeta): - """ - Enters the Coupled-Solution menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable_coupled_solution(self, *args, **kwargs): - """ - Enables/disables the coupled solution method. - """ - return PyMenu(self.service, "/define/models/eulerian_wallfilm/coupled_solution/enable_coupled_solution").execute(*args, **kwargs) - def enable_curvature_smoothing(self, *args, **kwargs): - """ - Enables/disables the film curvature smoothing option and sets the smoothing parameters. - """ - return PyMenu(self.service, "/define/models/eulerian_wallfilm/coupled_solution/enable_curvature_smoothing").execute(*args, **kwargs) - - class implicit_options(metaclass=PyMenuMeta): - """ - Enter Implicit Scheme Option (beta). - """ - def __init__(self, path, service): - self.path = path - self.service = service - def new_implicit_scheme(self, *args, **kwargs): - """ - Enable alternative implicit scheme. - """ - return PyMenu(self.service, "/define/models/eulerian_wallfilm/implicit_options/new_implicit_scheme").execute(*args, **kwargs) - def relative_error_residual(self, *args, **kwargs): - """ - Enable relative error residual. - """ - return PyMenu(self.service, "/define/models/eulerian_wallfilm/implicit_options/relative_error_residual").execute(*args, **kwargs) - - class dpm(metaclass=PyMenuMeta): - """ - Enters the dispersed phase model menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.collisions = self.__class__.collisions(path + [("collisions", None)], service) - self.erosion_dynamic_mesh = self.__class__.erosion_dynamic_mesh(path + [("erosion_dynamic_mesh", None)], service) - self.interaction = self.__class__.interaction(path + [("interaction", None)], service) - self.numerics = self.__class__.numerics(path + [("numerics", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - self.parallel = self.__class__.parallel(path + [("parallel", None)], service) - self.splash_options = self.__class__.splash_options(path + [("splash_options", None)], service) - self.stripping_options = self.__class__.stripping_options(path + [("stripping_options", None)], service) - def clear_particles_from_domain(self, *args, **kwargs): - """ - Removes/keeps all particles currently in the domain. - """ - return PyMenu(self.service, "/define/models/dpm/clear_particles_from_domain").execute(*args, **kwargs) - def fill_injection_material_sources(self, *args, **kwargs): - """ - Initialize the DPM sources corresponding to each material. - """ - return PyMenu(self.service, "/define/models/dpm/fill_injection_material_sources").execute(*args, **kwargs) - def injections(self, *args, **kwargs): - """ - Enters the injections menu. - """ - return PyMenu(self.service, "/define/models/dpm/injections").execute(*args, **kwargs) - def unsteady_tracking(self, *args, **kwargs): - """ - Enables/disables unsteady particle tracking. - """ - return PyMenu(self.service, "/define/models/dpm/unsteady_tracking").execute(*args, **kwargs) - def spray_model(self, *args, **kwargs): - """ - Enters the spray model menu. This command is available only if the breakup model enabled globally. - """ - return PyMenu(self.service, "/define/models/dpm/spray_model").execute(*args, **kwargs) - def user_defined(self, *args, **kwargs): - """ - Sets DPM user-defined functions. - """ - return PyMenu(self.service, "/define/models/dpm/user_defined").execute(*args, **kwargs) - - class collisions(metaclass=PyMenuMeta): - """ - Enters the DEM collisions menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.collision_partners = self.__class__.collision_partners(path + [("collision_partners", None)], service) - def collision_pair_settings(self, *args, **kwargs): - """ - Supplies settings for collisions to a pair of collision partners. You will be prompted to specify theImpact collision partner and the Target collision partner. - """ - return PyMenu(self.service, "/define/models/dpm/collisions/collision_pair_settings").execute(*args, **kwargs) - def list_all_pair_settings(self, *args, **kwargs): - """ - For each pair of collision partners, lists the collision laws and their parameters. - """ - return PyMenu(self.service, "/define/models/dpm/collisions/list_all_pair_settings").execute(*args, **kwargs) - def dem_collisions(self, *args, **kwargs): - """ - Enables/disables the DEM collision model. - """ - return PyMenu(self.service, "/define/models/dpm/collisions/dem_collisions").execute(*args, **kwargs) - def collision_mesh(self, *args, **kwargs): - """ - Input for the collision mesh. - """ - return PyMenu(self.service, "/define/models/dpm/collisions/collision_mesh").execute(*args, **kwargs) - def max_particle_velocity(self, *args, **kwargs): - """ - Sets the maximum particle velocity that may arise from collisions. - """ - return PyMenu(self.service, "/define/models/dpm/collisions/max_particle_velocity").execute(*args, **kwargs) - - class collision_partners(metaclass=PyMenuMeta): - """ - Manages collision partners. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def create(self, *args, **kwargs): - """ - Creates a collision partner. - """ - return PyMenu(self.service, "/define/models/dpm/collisions/collision_partners/create").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes a collision partner. - """ - return PyMenu(self.service, "/define/models/dpm/collisions/collision_partners/delete").execute(*args, **kwargs) - def copy(self, *args, **kwargs): - """ - Copies a collision partner. - """ - return PyMenu(self.service, "/define/models/dpm/collisions/collision_partners/copy").execute(*args, **kwargs) - def rename(self, *args, **kwargs): - """ - Renames a collision partner. - """ - return PyMenu(self.service, "/define/models/dpm/collisions/collision_partners/rename").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Lists all known collision partners. - """ - return PyMenu(self.service, "/define/models/dpm/collisions/collision_partners/list").execute(*args, **kwargs) - - class erosion_dynamic_mesh(metaclass=PyMenuMeta): - """ - Enters the menu to enable/configure/run the erosion-dynamic mesh interaction. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.general_parameters = self.__class__.general_parameters(path + [("general_parameters", None)], service) - self.run_parameters = self.__class__.run_parameters(path + [("run_parameters", None)], service) - def enable_erosion_dynamic_mesh_coupling(self, *args, **kwargs): - """ - Enables mesh deformation due to wall erosion. - """ - return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/enable_erosion_dynamic_mesh_coupling").execute(*args, **kwargs) - def run_simulation(self, *args, **kwargs): - """ - Performs a coupled erosion-dynamic mesh simulation. - """ - return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/run_simulation").execute(*args, **kwargs) - - class general_parameters(metaclass=PyMenuMeta): - """ - Enters the menu for setting erosion coupling with dynamic mesh. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def erosion_settings(self, *args, **kwargs): - """ - Sets parameters for erosion calculations. - """ - return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/general_parameters/erosion_settings").execute(*args, **kwargs) - def dynamic_mesh_settings(self, *args, **kwargs): - """ - Sets parameters for dynamic mesh calculations. - """ - return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/general_parameters/dynamic_mesh_settings").execute(*args, **kwargs) - def participating_walls(self, *args, **kwargs): - """ - Specifies all participating walls. - """ - return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/general_parameters/participating_walls").execute(*args, **kwargs) - - class run_parameters(metaclass=PyMenuMeta): - """ - Manages erosion-dynamic mesh run settings. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def mesh_motion_time_step(self, *args, **kwargs): - """ - Sets the mesh motion time stepping parameters and method. - """ - return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/run_parameters/mesh_motion_time_step").execute(*args, **kwargs) - def simulation_termination(self, *args, **kwargs): - """ - Sets the total time of erosion. - """ - return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/run_parameters/simulation_termination").execute(*args, **kwargs) - def flow_simulation_control(self, *args, **kwargs): - """ - Sets the number of iterations per flow simulation step. - """ - return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/run_parameters/flow_simulation_control").execute(*args, **kwargs) - def autosave_files(self, *args, **kwargs): - """ - Sets the iteration increment and filename to save data files. - """ - return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/run_parameters/autosave_files").execute(*args, **kwargs) - def autosave_graphics(self, *args, **kwargs): - """ - Sets the iteration increment to save graphics files. - """ - return PyMenu(self.service, "/define/models/dpm/erosion_dynamic_mesh/run_parameters/autosave_graphics").execute(*args, **kwargs) - - class interaction(metaclass=PyMenuMeta): - """ - Sets parameters for coupled discrete phase calculations. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def choice_of_eulerian_phase_for_interaction(self, *args, **kwargs): - """ - Enable/disable the option to choose for every injection the Eulerian phase for the DPM continuous phase interaction. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/choice_of_eulerian_phase_for_interaction").execute(*args, **kwargs) - def coupled_calculations(self, *args, **kwargs): - """ - Selects whether or not to couple continuous and discrete phase calculations. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/coupled_calculations").execute(*args, **kwargs) - def dpm_iteration_interval(self, *args, **kwargs): - """ - Sets the frequency with which the particle trajectory calculations are introduced. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/dpm_iteration_interval").execute(*args, **kwargs) - def underrelaxation_factor(self, *args, **kwargs): - """ - Sets the under-relaxation factor for the discrete phase sources. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/underrelaxation_factor").execute(*args, **kwargs) - def implicit_momentum_coupling(self, *args, **kwargs): - """ - Enables/disables implicit treatment for the DPM momentum source terms. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/implicit_momentum_coupling").execute(*args, **kwargs) - def implicit_source_term_coupling(self, *args, **kwargs): - """ - Enables/disables implicit treatment for all DPM source terms. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/implicit_source_term_coupling").execute(*args, **kwargs) - def linearized_dpm_source_terms(self, *args, **kwargs): - """ - Enables/disables linearization of source terms for the discrete phase. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/linearized_dpm_source_terms").execute(*args, **kwargs) - def replace_dpm_mass_source_by_mixture_fraction(self, *args, **kwargs): - """ - When enabled, recalculates the mixture fraction source terms as a function of the primary mixture fraction. This command is available for non- or partially-premixed combustion cases only. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/replace_dpm_mass_source_by_mixture_fraction").execute(*args, **kwargs) - def linearized_dpm_mixture_fraction_source_terms(self, *args, **kwargs): - """ - Enables/disables linearization of mixture fraction source terms. This command is available only for non- or partially-premixed combustion cases. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/linearized_dpm_mixture_fraction_source_terms").execute(*args, **kwargs) - def linearized_dpm_species_source_terms(self, *args, **kwargs): - """ - Perform linearization of species source terms. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/linearized_dpm_species_source_terms").execute(*args, **kwargs) - def keep_linearized_dpm_source_terms_constant(self, *args, **kwargs): - """ - Keep linearized DPM source terms constant until the next DPM Update. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/keep_linearized_dpm_source_terms_constant").execute(*args, **kwargs) - def linearized_dpm_source_terms_limiter(self, *args, **kwargs): - """ - Relative limit for DPM source linear coefficient with respect to fluid linear Ap coefficient. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/linearized_dpm_source_terms_limiter").execute(*args, **kwargs) - def update_dpm_sources_every_flow_iteration(self, *args, **kwargs): - """ - Enables/disables the update of DPM source terms every flow iteration (if this option is not enabled, the terms will be updated every DPM iteration). - """ - return PyMenu(self.service, "/define/models/dpm/interaction/update_dpm_sources_every_flow_iteration").execute(*args, **kwargs) - def linear_growth_of_dpm_source_term(self, *args, **kwargs): - """ - Enables/disables the linear ramping up of the DPM source terms at every DPM iteration. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/linear_growth_of_dpm_source_term").execute(*args, **kwargs) - def reset_sources_at_timestep(self, *args, **kwargs): - """ - Enable/disable flush of DPM source terms at beginning of every time step. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/reset_sources_at_timestep").execute(*args, **kwargs) - def enable_flow_blocking_by_particles(self, *args, **kwargs): - """ - Enable/disable inclusion of DPM volume fraction in continuous flow. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/enable_flow_blocking_by_particles").execute(*args, **kwargs) - def enable_source_scaling_due_to_flow_blocking(self, *args, **kwargs): - """ - Enable/disable scaling of DPM source terms due to inclusion of DPM volume fraction in continuous flow. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/enable_source_scaling_due_to_flow_blocking").execute(*args, **kwargs) - def enable_drag_scaling_due_to_flow_blocking(self, *args, **kwargs): - """ - Enable/disable scaling of DPM drag coefficient due to inclusion of DPM volume fraction in continuous flow. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/enable_drag_scaling_due_to_flow_blocking").execute(*args, **kwargs) - def max_vf_allowed_for_blocking(self, *args, **kwargs): - """ - Maximum DPM volume fraction used in continuous flow. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/max_vf_allowed_for_blocking").execute(*args, **kwargs) - def min_vf_threshold_for_dpm_src_scaling(self, *args, **kwargs): - """ - Minimum DPM volume fraction below which no DPM source scaling is applied. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/min_vf_threshold_for_dpm_src_scaling").execute(*args, **kwargs) - def ddpm_iad_particle(self, *args, **kwargs): - """ - Enable/disable the non-default interfacial area method IA-particle. - """ - return PyMenu(self.service, "/define/models/dpm/interaction/ddpm_iad_particle").execute(*args, **kwargs) - - class numerics(metaclass=PyMenuMeta): - """ - Enters the numerics menu to set numerical solution parameters. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.high_resolution_tracking = self.__class__.high_resolution_tracking(path + [("high_resolution_tracking", None)], service) - def coupled_heat_mass_update(self, *args, **kwargs): - """ - Enables/disables coupled heat and mass update. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/coupled_heat_mass_update").execute(*args, **kwargs) - def minimum_liquid_fraction(self, *args, **kwargs): - """ - A droplet evaporates completely when the remaining mass is below this fraction of the initial droplet mass. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/minimum_liquid_fraction").execute(*args, **kwargs) - def underrelax_film_height(self, *args, **kwargs): - """ - Sets the under-relaxation factor for the film height calculation. The recommended values range between 0.5 (default) and 0.9. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/underrelax_film_height").execute(*args, **kwargs) - def vaporization_limiting_factors(self, *args, **kwargs): - """ - Sets the Vaporization Fractional Change Limits. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/vaporization_limiting_factors").execute(*args, **kwargs) - def tracking_parameters(self, *args, **kwargs): - """ - Sets parameters for the (initial) tracking step length. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/tracking_parameters").execute(*args, **kwargs) - def tracking_scheme(self, *args, **kwargs): - """ - Specifies a tracking scheme. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/tracking_scheme").execute(*args, **kwargs) - def tracking_statistics(self, *args, **kwargs): - """ - Controls the format of the one-line tracking statistics to be printed after every DPM tracking pass. A value of 0 (the default) prints only fates with non-zero values. A value of 1 prints all fates, including fates with zero values. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/tracking_statistics").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Adjust the DPM tracker's verbosity level. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/verbosity").execute(*args, **kwargs) - def error_control(self, *args, **kwargs): - """ - Adapts integration step length based on a maximum error. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/error_control").execute(*args, **kwargs) - def automated_scheme_selection(self, *args, **kwargs): - """ - Enables/disables the adaptation of integration step length based on a maximum error. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/automated_scheme_selection").execute(*args, **kwargs) - def drag_law(self, *args, **kwargs): - """ - Sets the drag law. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/drag_law").execute(*args, **kwargs) - def enable_node_based_averaging(self, *args, **kwargs): - """ - Enables/disables mesh node averaging of DPM quantities. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/enable_node_based_averaging").execute(*args, **kwargs) - def average_source_terms(self, *args, **kwargs): - """ - Enables/disables mesh node averaging of DPM source terms. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/average_source_terms").execute(*args, **kwargs) - def average_DDPM_variables(self, *args, **kwargs): - """ - Enables/disables mesh node averaging of DDPM quantities. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/average_DDPM_variables").execute(*args, **kwargs) - def average_each_step(self, *args, **kwargs): - """ - Enables/disables mesh node averaging during integration time step. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/average_each_step").execute(*args, **kwargs) - def average_kernel(self, *args, **kwargs): - """ - Specifies the averaging kernel to use for mesh node averaging. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/average_kernel").execute(*args, **kwargs) - def gaussian_factor(self, *args, **kwargs): - """ - Specifies the Gaussian constant when using thegaussian kernel for mesh node averaging. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/gaussian_factor").execute(*args, **kwargs) - def mppic_settings(self, *args, **kwargs): - """ - Enable PIC and MPPIC to compute DPM and DDPM source terms. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/mppic_settings").execute(*args, **kwargs) - def enhanced_packing_limit_numerics(self, *args, **kwargs): - """ - Enable enhanced packing limit numerics to avoid exceeding of packing limit for granular phases. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/enhanced_packing_limit_numerics").execute(*args, **kwargs) - - class high_resolution_tracking(metaclass=PyMenuMeta): - """ - Enters the high resolution tracking menu. See for more information about these options. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.barycentric_interpolation = self.__class__.barycentric_interpolation(path + [("barycentric_interpolation", None)], service) - self.particle_relocation = self.__class__.particle_relocation(path + [("particle_relocation", None)], service) - def enable_high_resolution_tracking(self, *args, **kwargs): - """ - Enables/disables high resolution tracking. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/enable_high_resolution_tracking").execute(*args, **kwargs) - def enable_barycentric_intersections(self, *args, **kwargs): - """ - Enables/disables an alternative method of calculating intersections with cell boundaries. Barycentric intersections are linear calculations and are faster than the default intersection algorithm. The default intersection algorithm is second-order for stationary meshes; therefore, using the barycentric intersection may sacrifice accuracy. You must verify that the barycentric intersections provide comparable results to the default intersection method. This option is available only for 3D stationary meshes and the double precision solver. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/enable_barycentric_intersections").execute(*args, **kwargs) - def use_barycentric_sampling(self, *args, **kwargs): - """ - When enabled, this option provides improved accuracy and parallel consistency when sampling particles at planes. This item is available only with the 3D solver. Using the double-precision solver and bounded planes is recommended. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/use_barycentric_sampling").execute(*args, **kwargs) - def use_velocity_based_error_control(self, *args, **kwargs): - """ - Enables/disables an alternative method of timestep adaption. By default, ANSYS Fluent uses the half-step method of timestep adaption with particle integration. This alternative method of controlling the integration timestep based upon velocity changes is faster; however, you need to ensure that the accuracy is comparable for your specific application. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/use_velocity_based_error_control").execute(*args, **kwargs) - def use_quad_face_centroid(self, *args, **kwargs): - """ - Enables/disables using quad face centroids when creating subtets. This option changes the way hexahedral cells are decomposed to avoid creating degenerate subtets. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/use_quad_face_centroid").execute(*args, **kwargs) - def check_subtet_validity(self, *args, **kwargs): - """ - When enabled, checks the validity of a subtet when the particle first enters it. If the subtet is found to be degenerate, the tracking algorithm modifies to accommodate it. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/check_subtet_validity").execute(*args, **kwargs) - def always_use_face_centroid_with_periodics(self, *args, **kwargs): - """ - When enabled, ANSYS Fluent uses quad face centroids when creating subtets in cases with periodic boundaries. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/always_use_face_centroid_with_periodics").execute(*args, **kwargs) - def boundary_layer_tracking(self, *args, **kwargs): - """ - Enables/disables the calculation of the particle time step that considers both the cell aspect ratio and the particle trajectory. This method improves the accuracy of the predictions in boundary layer cells, particularly in layers where flow gradients are large. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/boundary_layer_tracking").execute(*args, **kwargs) - def sliding_interface_crossover_fraction(self, *args, **kwargs): - """ - Specifies the fraction of the distance to the subtet center to move the particle. At non-conformal interfaces, the nodes used for the barycentric interpolation are different on either side of the interface. This may result in incomplete particles due to discontinuities in the variable interpolation. The number of incomplete particles may be reduced by moving the particles slightly off of the sliding interface. Recommended values range between 0 and 0.5. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/sliding_interface_crossover_fraction").execute(*args, **kwargs) - def project_wall_film_particles_to_film(self, *args, **kwargs): - """ - Enables/disables projecting existing particles to Lagrangian wall film to track using high-resolution tracking. When reading in a data file that contains wall film particles previously tracked with the existing ANSYS Fluent tracking method, you need to either clear the particles from the domain or project their positions to the wall film surface using the project-wall-film-particles-to-film? text command prior to using the high-resolution tracking method. After tracking the particles for one timestep, this option can be disabled to improve performance. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/project_wall_film_particles_to_film").execute(*args, **kwargs) - def use_particle_timestep_for_intersection_tolerance(self, *args, **kwargs): - """ - Enables/disables the use of the particle timestep for the subtet intersection tolerance with axisymmetric grids (default: enabled). If disabled, the tolerance will be calculated in the same manner as non-axisymmetric meshes (a scaled value of the tolerance which is set using the define/models/dpm/numerics/high-resolution-tracking/set-subtet-intersection-tolerance text command). - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/use_particle_timestep_for_intersection_tolerance").execute(*args, **kwargs) - def enable_automatic_intersection_tolerance(self, *args, **kwargs): - """ - Enables/disables the automatic calculation of intersection tolerance. By default, the tolerance used in intersection calculations is scaled by the residence time of the particle in the cell to improve robustness. For most cases, the scaled tolerance is sufficient to identify all intersections of the particle trajectory and the subtet faces. You can set the intersection tolerance manually using the set-subtet-intersection-tolerance text command. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/enable_automatic_intersection_tolerance").execute(*args, **kwargs) - def set_film_spreading_parameter(self, *args, **kwargs): - """ - Set the spreading parameter for Lagrangian wallfilm particles. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/set_film_spreading_parameter").execute(*args, **kwargs) - def set_subtet_intersection_tolerance(self, *args, **kwargs): - """ - Specifies the tolerance used in intersection calculations. This tolerance will be scaled by the characteristic cell crossing time of the particle if the enable-automatic-intersection-tolerance? text command is enabled. If that option is disabled, the specified tolerance will be used without scaling. The default intersection tolerance is 10-5. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/set_subtet_intersection_tolerance").execute(*args, **kwargs) - - class barycentric_interpolation(metaclass=PyMenuMeta): - """ - Enter the barycentric interpolation menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def interpolate_flow_solution_gradients(self, *args, **kwargs): - """ - When enabled, flow solution gradients are interpolated to the particle position. This can be useful when using physical models that depend on these gradients (for example, the thermophoretic force, pressure-gradient force, or virtual mass force). Interpolating the gradients also improves the accuracy and robustness of the trapezoidal numerics scheme, which is the default method for pathlines. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/interpolate_flow_solution_gradients").execute(*args, **kwargs) - def interpolate_temperature(self, *args, **kwargs): - """ - Enables/disables the barycentric interpolation of temperature to the particle position. The cell temperature is used by default in calculations of heat transfer to/from the particle. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/interpolate_temperature").execute(*args, **kwargs) - def interpolate_flow_density(self, *args, **kwargs): - """ - Enables/disables the barycentric interpolation of the flow density. This option is recommended when the density varies with position to avoid discontinuities in the interpolated variable at cell boundaries. For constant density flows, this option is unnecessary. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/interpolate_flow_density").execute(*args, **kwargs) - def interpolate_flow_cp(self, *args, **kwargs): - """ - Enables/disables the barycentric interpolation of specific heat to the particle position. This option is recommended when the specific heat varies with position to avoid discontinuities in the interpolated variable at cell boundaries. For flows with constant specific heat, this option is unnecessary. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/interpolate_flow_cp").execute(*args, **kwargs) - def interpolate_flow_viscosity(self, *args, **kwargs): - """ - Enables/disables the barycentric interpolation of flow viscosity to the particle position. This option is recommended when the flow viscosity varies with position to avoid discontinuities in the interpolated variable at cell boundaries. For flows with constant viscosity, this option is unnecessary. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/interpolate_flow_viscosity").execute(*args, **kwargs) - def interpolate_wallfilm_properties(self, *args, **kwargs): - """ - When enabled, the wall film properties (film height, film mass, and wall shear) are interpolated to the particle position. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/interpolate_wallfilm_properties").execute(*args, **kwargs) - def precompute_pdf_species(self, *args, **kwargs): - """ - When this option is enabled for premixed or non-premixed combustion simulations, the species composition in each cell is precomputed prior to tracking particles. This approach may improve performance for cases with many particles and relatively few cells. By default, this option is set to no, and ANSYS Fluent calculates the species composition during particle tracking. The solution results will be identical for both methods. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/precompute_pdf_species").execute(*args, **kwargs) - def zero_nodal_velocity_on_walls(self, *args, **kwargs): - """ - When enabled, sets the velocity at wall nodes to zero. (By default, the nodal velocities on walls are first reconstructed from cell and face values and then corrected to ensure that there are no velocity components directed towards the walls). This may be useful if you want to consider particle impingement on the walls. Note that enabling this option will more likely produce incomplete particles as some particles may settle on the walls. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/zero_nodal_velocity_on_walls").execute(*args, **kwargs) - def enable_transient_variable_interpolation(self, *args, **kwargs): - """ - Enable transient variable interpolation. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/enable_transient_variable_interpolation").execute(*args, **kwargs) - def nodal_reconstruction_frequency(self, *args, **kwargs): - """ - Update nodal reconstruction every N'th DPM iteration. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/nodal_reconstruction_frequency").execute(*args, **kwargs) - def user_interpolation_function(self, *args, **kwargs): - """ - Enter user interpolation function. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/user_interpolation_function").execute(*args, **kwargs) - - class particle_relocation(metaclass=PyMenuMeta): - """ - Enter the particle relocation menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def wallfilm_relocation_tolerance_scale_factor(self, *args, **kwargs): - """ - Set the relocation tolerance scaling factor for wallfilm particles after remeshing. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/particle_relocation/wallfilm_relocation_tolerance_scale_factor").execute(*args, **kwargs) - def use_legacy_particle_location_method(self, *args, **kwargs): - """ - Enable legacy method of locating particles in cells. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/particle_relocation/use_legacy_particle_location_method").execute(*args, **kwargs) - def load_legacy_particles(self, *args, **kwargs): - """ - Load particles that were tracked without high-resolution tracking enabled. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/particle_relocation/load_legacy_particles").execute(*args, **kwargs) - def enhanced_cell_relocation_method(self, *args, **kwargs): - """ - Enable enhanced method of locating particles in cells. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/particle_relocation/enhanced_cell_relocation_method").execute(*args, **kwargs) - def overset_relocation_robustness_level(self, *args, **kwargs): - """ - Set the robustness level for particle relocation in overset meshes. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/particle_relocation/overset_relocation_robustness_level").execute(*args, **kwargs) - def enhanced_wallfilm_location_method(self, *args, **kwargs): - """ - Enable enhanced method of locating film particles on faces. - """ - return PyMenu(self.service, "/define/models/dpm/numerics/high_resolution_tracking/particle_relocation/enhanced_wallfilm_location_method").execute(*args, **kwargs) - - class options(metaclass=PyMenuMeta): - """ - Enters the options menu to set optional models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable_contour_plots(self, *args, **kwargs): - """ - Enables computation of mean and/or RMS values of additional discrete phase variables for postprocessing. - """ - return PyMenu(self.service, "/define/models/dpm/options/enable_contour_plots").execute(*args, **kwargs) - def ensemble_average(self, *args, **kwargs): - """ - Ensembles average cloud properties. - """ - return PyMenu(self.service, "/define/models/dpm/options/ensemble_average").execute(*args, **kwargs) - def particle_radiation(self, *args, **kwargs): - """ - Enables/disables particle radiation. - """ - return PyMenu(self.service, "/define/models/dpm/options/particle_radiation").execute(*args, **kwargs) - def track_in_absolute_frame(self, *args, **kwargs): - """ - Enables/disables tracking in absolute frame. - """ - return PyMenu(self.service, "/define/models/dpm/options/track_in_absolute_frame").execute(*args, **kwargs) - def thermophoretic_force(self, *args, **kwargs): - """ - Enables/disables thermophoretic force. - """ - return PyMenu(self.service, "/define/models/dpm/options/thermophoretic_force").execute(*args, **kwargs) - def convective_film_heat_transfer(self, *args, **kwargs): - """ - Enable/disable convection/conduction film to wall heat transfer model. - """ - return PyMenu(self.service, "/define/models/dpm/options/convective_film_heat_transfer").execute(*args, **kwargs) - def saffman_lift_force(self, *args, **kwargs): - """ - Enables/disables Saffman lift force. - """ - return PyMenu(self.service, "/define/models/dpm/options/saffman_lift_force").execute(*args, **kwargs) - def pressure_gradient_force(self, *args, **kwargs): - """ - Enables/disables inclusion of pressure gradient effects in the particle force balance. - """ - return PyMenu(self.service, "/define/models/dpm/options/pressure_gradient_force").execute(*args, **kwargs) - def virtual_mass_force(self, *args, **kwargs): - """ - Enables/disables inclusion of the virtual mass force in the particle force balance. - """ - return PyMenu(self.service, "/define/models/dpm/options/virtual_mass_force").execute(*args, **kwargs) - def two_way_coupling(self, *args, **kwargs): - """ - Enables/disables calculation of DPM sources in TKE equation. - """ - return PyMenu(self.service, "/define/models/dpm/options/two_way_coupling").execute(*args, **kwargs) - def remove_wall_film_temperature_limiter(self, *args, **kwargs): - """ - Answering yes at the prompt removes the wall temperature limiter for Lagrangian wall-film walls. If you enter no (default), two additional prompts will appear in the console allowing you to define the temperature difference above the boiling point and to enable/disable the reporting of the Leidenfrost temperature on the wall faces. - """ - return PyMenu(self.service, "/define/models/dpm/options/remove_wall_film_temperature_limiter").execute(*args, **kwargs) - def maximum_udf_species(self, *args, **kwargs): - """ - Specifies the maximum number of species that will be accessible from discrete phase model UDFs. Only species with indices up to this value are accessible in discrete phase model UDFs. - """ - return PyMenu(self.service, "/define/models/dpm/options/maximum_udf_species").execute(*args, **kwargs) - def brownian_motion(self, *args, **kwargs): - """ - Enables/disables Brownian motion of particles. - """ - return PyMenu(self.service, "/define/models/dpm/options/brownian_motion").execute(*args, **kwargs) - def stagger_spatially_standard_injections(self, *args, **kwargs): - """ - Enables/disables spatial staggering for standard (non-atomizer and non-solid-cone) injections. - """ - return PyMenu(self.service, "/define/models/dpm/options/stagger_spatially_standard_injections").execute(*args, **kwargs) - def stagger_spatially_atomizer_injections(self, *args, **kwargs): - """ - Enables/disables spatial staggering for atomizer and solid-cone injections. - """ - return PyMenu(self.service, "/define/models/dpm/options/stagger_spatially_atomizer_injections").execute(*args, **kwargs) - def stagger_temporally(self, *args, **kwargs): - """ - Enables/disables temporal staggering. - """ - return PyMenu(self.service, "/define/models/dpm/options/stagger_temporally").execute(*args, **kwargs) - def staggering_factor(self, *args, **kwargs): - """ - S - """ - return PyMenu(self.service, "/define/models/dpm/options/staggering_factor").execute(*args, **kwargs) - def stagger_radius(self, *args, **kwargs): - """ - Specifies the region over which to spatially stagger particles when particle-staggering is enabled for non-atomizer injections. - """ - return PyMenu(self.service, "/define/models/dpm/options/stagger_radius").execute(*args, **kwargs) - def uniform_mass_distribution_for_injections(self, *args, **kwargs): - """ - Specifies a uniform distribution of mass over the cross-section of solid cone and atomizer injections. This can become important when the mesh is smaller than the diameter (or another characteristic size) of the injection. - """ - return PyMenu(self.service, "/define/models/dpm/options/uniform_mass_distribution_for_injections").execute(*args, **kwargs) - def use_absolute_pressure_for_vaporization(self, *args, **kwargs): - """ - Determines whether the absolute pressure or constant operating pressure (specified in define/operating-conditions/operating-pressure) will be used in vaporization rates calculations. - """ - return PyMenu(self.service, "/define/models/dpm/options/use_absolute_pressure_for_vaporization").execute(*args, **kwargs) - def vaporization_options(self, *args, **kwargs): - """ - Sets Vaporization options. - """ - return PyMenu(self.service, "/define/models/dpm/options/vaporization_options").execute(*args, **kwargs) - def vaporization_heat_transfer_averaging(self, *args, **kwargs): - """ - Enables averaging of the Spalding heat transfer term for the convection/diffusion-controlled model. - """ - return PyMenu(self.service, "/define/models/dpm/options/vaporization_heat_transfer_averaging").execute(*args, **kwargs) - def allow_supercritical_pressure_vaporization(self, *args, **kwargs): - """ - Enforces the switching from vaporization to boiling even if the boiling point is not calculated from the vapor pressure data. If the pressure in your model is above critical you must retain the default setting (yes). This options is available only if whenPressure Dependent Boiling is enabled in the Physical Models tab of the Discrete Phase Models dialog box. For more details, see . - """ - return PyMenu(self.service, "/define/models/dpm/options/allow_supercritical_pressure_vaporization").execute(*args, **kwargs) - def treat_multicomponent_saturation_temperature_failure(self, *args, **kwargs): - """ - Enables/disables dumping multicomponent particle mass into the continuous phase if the saturation temperature calculation fails. - """ - return PyMenu(self.service, "/define/models/dpm/options/treat_multicomponent_saturation_temperature_failure").execute(*args, **kwargs) - def set_thermolysis_limit(self, *args, **kwargs): - """ - Sets the limit for the thermolysis model. - """ - return PyMenu(self.service, "/define/models/dpm/options/set_thermolysis_limit").execute(*args, **kwargs) - def lowest_volatiles_mass_fraction(self, *args, **kwargs): - """ - Set the lowest volatiles mass fraction. - """ - return PyMenu(self.service, "/define/models/dpm/options/lowest_volatiles_mass_fraction").execute(*args, **kwargs) - def erosion_accretion(self, *args, **kwargs): - """ - Enables/disables erosion/accretion. - """ - return PyMenu(self.service, "/define/models/dpm/options/erosion_accretion").execute(*args, **kwargs) - def init_erosion_accretion_rate(self, *args, **kwargs): - """ - Initializes the erosion/accretion rates with zero. - """ - return PyMenu(self.service, "/define/models/dpm/options/init_erosion_accretion_rate").execute(*args, **kwargs) - def step_report_sig_figures(self, *args, **kwargs): - """ - Sets significant figures in the step-by-step report. - """ - return PyMenu(self.service, "/define/models/dpm/options/step_report_sig_figures").execute(*args, **kwargs) - def include_lwf_particles_in_dpm_concentration(self, *args, **kwargs): - """ - Include LWF particle mass in DPM Concentration. - """ - return PyMenu(self.service, "/define/models/dpm/options/include_lwf_particles_in_dpm_concentration").execute(*args, **kwargs) - def current_positions_in_sample_file_format(self, *args, **kwargs): - """ - When enabled, generates a file containing particle current positions (step-by-step history report for unsteady tracking) in the sampling file format. - """ - return PyMenu(self.service, "/define/models/dpm/options/current_positions_in_sample_file_format").execute(*args, **kwargs) - def scr_urea_deposition_risk_analysis(self, *args, **kwargs): - """ - Enters the menu for setting up the risk for solids deposit formation for the Selective Catalytic Reduction (SCR) process. For more information, see . - """ - return PyMenu(self.service, "/define/models/dpm/options/scr_urea_deposition_risk_analysis").execute(*args, **kwargs) - - class parallel(metaclass=PyMenuMeta): - """ - Enters the parallel menu to set parameters for parallel DPM calculations. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.expert = self.__class__.expert(path + [("expert", None)], service) - def enable_workpile(self, *args, **kwargs): - """ - Turns on/off particle workpile algorithm. This option is only available when the define/models/dpm/parallel/use-shared-memory option is selected. - """ - return PyMenu(self.service, "/define/models/dpm/parallel/enable_workpile").execute(*args, **kwargs) - def n_threads(self, *args, **kwargs): - """ - Sets the number of processors to use for DPM. This option is only available when the define/models/dpm/parallel/enable-workpile? option is enabled. - """ - return PyMenu(self.service, "/define/models/dpm/parallel/n_threads").execute(*args, **kwargs) - def report(self, *args, **kwargs): - """ - Prints particle workpile statistics. This option is only available when the define/models/dpm/parallel/enable-workpile? option is enabled. - """ - return PyMenu(self.service, "/define/models/dpm/parallel/report").execute(*args, **kwargs) - def use_shared_memory(self, *args, **kwargs): - """ - Specifies that the calculations are performed on shared-memory multiprocessor machines. - """ - return PyMenu(self.service, "/define/models/dpm/parallel/use_shared_memory").execute(*args, **kwargs) - def use_message_passing(self, *args, **kwargs): - """ - Specifies that the calculations are performed using cluster computing or shared-memory machines. With this option, the compute node processes themselves perform the particle work on their local partitions and particle migration to other compute nodes is implemented using message passing primitives. - """ - return PyMenu(self.service, "/define/models/dpm/parallel/use_message_passing").execute(*args, **kwargs) - def use_hybrid(self, *args, **kwargs): - """ - Specifies that the calculations are performed using multicore cluster computing or shared-memory machines. This option works in conjunction withopenmpi for a dynamic load balancing without migration of cells. - """ - return PyMenu(self.service, "/define/models/dpm/parallel/use_hybrid").execute(*args, **kwargs) - def fix_source_term_accumulation_order(self, *args, **kwargs): - """ - Enforce deterministic order of source term accumulation. - """ - return PyMenu(self.service, "/define/models/dpm/parallel/fix_source_term_accumulation_order").execute(*args, **kwargs) - def hybrid_2domain(self, *args, **kwargs): - """ - Enables/disables the use of a second domain for DPM particle tracking. - """ - return PyMenu(self.service, "/define/models/dpm/parallel/hybrid_2domain").execute(*args, **kwargs) - def hybrid_workpile(self, *args, **kwargs): - """ - Optimize multi-thread load balancing within each partition in hybrid-parallel DPM tracking. - """ - return PyMenu(self.service, "/define/models/dpm/parallel/hybrid_workpile").execute(*args, **kwargs) - def hybrid_collision_model(self, *args, **kwargs): - """ - An EXPERIMENTAL feature to allow 'hybrid' DPM parallel tracking with the collision / coalescence model. - """ - return PyMenu(self.service, "/define/models/dpm/parallel/hybrid_collision_model").execute(*args, **kwargs) - def hybrid_collision_unidirectional(self, *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. - """ - return PyMenu(self.service, "/define/models/dpm/parallel/hybrid_collision_unidirectional").execute(*args, **kwargs) - def hybrid_collision_variant(self, *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. - """ - return PyMenu(self.service, "/define/models/dpm/parallel/hybrid_collision_variant").execute(*args, **kwargs) - - class expert(metaclass=PyMenuMeta): - """ - Enters the menu for expert DPM parallel text commands. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def partition_method_hybrid_2domain(self, *args, **kwargs): - """ - Enables/disables a partitioning method that is more granular and can yield faster calculations (especially for cases that are running on a low to moderate number of processors). This partitioning method is only applied when you use the DPM domain for the hybrid parallel DPM tracking mode (that is, when you have enabled the define/models/dpm/parallel/hybrid-2domain? text command). - """ - return PyMenu(self.service, "/define/models/dpm/parallel/expert/partition_method_hybrid_2domain").execute(*args, **kwargs) - - class splash_options(metaclass=PyMenuMeta): - """ - Enters the splash option menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def orourke_splash_fraction(self, *args, **kwargs): - """ - Enables/disables the O’Rourke formulation (default for the Lagrangian Wall Film (LWF) model). If the O’Rourke formulation is disabled, the Stanton formulation (default for the Eulerian Wall Film (EWF) model) is used in a simulation. - """ - return PyMenu(self.service, "/define/models/dpm/splash_options/orourke_splash_fraction").execute(*args, **kwargs) - def splash_pdf_limiting(self, *args, **kwargs): - """ - Sets the splash pdf limiting method. Available methods are: the splash pdf tail limiting (default for the LWF model) and the splash pdf peak limiting (default for the EWF model). For the splash pdf peak limiting, you will be prompted to specify the peak limiting value. - """ - return PyMenu(self.service, "/define/models/dpm/splash_options/splash_pdf_limiting").execute(*args, **kwargs) - - class stripping_options(metaclass=PyMenuMeta): - """ - Enters the stripping options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def mass_coefficient(self, *args, **kwargs): - """ - Sets the mass coefficient ( in in the Theory Guide) - """ - return PyMenu(self.service, "/define/models/dpm/stripping_options/mass_coefficient").execute(*args, **kwargs) - def diameter_coefficient(self, *args, **kwargs): - """ - Sets the diameter coefficient ( in in the Theory Guide) - """ - return PyMenu(self.service, "/define/models/dpm/stripping_options/diameter_coefficient").execute(*args, **kwargs) - - class shell_conduction(metaclass=PyMenuMeta): - """ - Enters the shell conduction models menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def multi_layer_shell(self, *args, **kwargs): - """ - Enables/disables the ability to define multi-layer shell conduction for walls. Note that the warped-face gradient correction (WFGC) is not supported when multi-layer shells are disabled. - """ - return PyMenu(self.service, "/define/models/shell_conduction/multi_layer_shell").execute(*args, **kwargs) - def enhanced_encapsulation(self, *args, **kwargs): - """ - Enables/disables an enhanced routine for the encapsulation of coupled walls during mesh partitioning that is enabled by default when shell conduction and/or the surface to surface (S2S) radiation model is used. - """ - return PyMenu(self.service, "/define/models/shell_conduction/enhanced_encapsulation").execute(*args, **kwargs) - def read_csv(self, *args, **kwargs): - """ - Defines the shell conduction settings by reading a CSV file. - """ - return PyMenu(self.service, "/define/models/shell_conduction/read_csv").execute(*args, **kwargs) - def write_csv(self, *args, **kwargs): - """ - Writes your saved shell conduction settings to a CSV file. - """ - return PyMenu(self.service, "/define/models/shell_conduction/write_csv").execute(*args, **kwargs) - def settings(self, *args, **kwargs): - """ - Enables shell conduction and defines the settings for any wall or group of walls by manually entering the number and properties of the layers. - """ - return PyMenu(self.service, "/define/models/shell_conduction/settings").execute(*args, **kwargs) - def save_shell_zones(self, *args, **kwargs): - """ - Enables the saving of shell zones to case files. - """ - return PyMenu(self.service, "/define/models/shell_conduction/save_shell_zones").execute(*args, **kwargs) - - class system_coupling_settings(metaclass=PyMenuMeta): - """ - Enters the system coupling menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.htc = self.__class__.htc(path + [("htc", None)], service) - def use_face_or_element_based_data_transfer(self, *args, **kwargs): - """ - Answering yes at the prompt enables Fluent to use element data for mapping surface conservative quantities such as surface forces and heat flows. - """ - return PyMenu(self.service, "/define/models/system_coupling_settings/use_face_or_element_based_data_transfer").execute(*args, **kwargs) - def update_rigid_body_mesh_motion_before_mesh_transfer(self, *args, **kwargs): - """ - SC Enable/disable mesh motion. - """ - return PyMenu(self.service, "/define/models/system_coupling_settings/update_rigid_body_mesh_motion_before_mesh_transfer").execute(*args, **kwargs) - def specify_system_coupling_volumetric_cell_zones(self, *args, **kwargs): - """ - Enable/disable volumetric cell zones. - """ - return PyMenu(self.service, "/define/models/system_coupling_settings/specify_system_coupling_volumetric_cell_zones").execute(*args, **kwargs) - - class htc(metaclass=PyMenuMeta): - """ - Enter the heat transfer coeficient menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.unsteady_statistics = self.__class__.unsteady_statistics(path + [("unsteady_statistics", None)], service) - self.htc_calculation_method = self.__class__.htc_calculation_method(path + [("htc_calculation_method", None)], service) - - class unsteady_statistics(metaclass=PyMenuMeta): - """ - Enter the unsteady statistics menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def sc_enable_sub_stepping_option_per_coupling_step(self, *args, **kwargs): - """ - Enable/disable sub stepping option per coupling step. - """ - return PyMenu(self.service, "/define/models/system_coupling_settings/htc/unsteady_statistics/sc_enable_sub_stepping_option_per_coupling_step").execute(*args, **kwargs) - - class htc_calculation_method(metaclass=PyMenuMeta): - """ - Enter the htc calculation menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def use_tref_in_htc_calculation(self, *args, **kwargs): - """ - Enable/disable tref in htc computation. - """ - return PyMenu(self.service, "/define/models/system_coupling_settings/htc/htc_calculation_method/use_tref_in_htc_calculation").execute(*args, **kwargs) - def use_yplus_based_htc_calculation(self, *args, **kwargs): - """ - Enable/disable yplus in htc computation. - """ - return PyMenu(self.service, "/define/models/system_coupling_settings/htc/htc_calculation_method/use_yplus_based_htc_calculation").execute(*args, **kwargs) - def use_wall_function_based_htc(self, *args, **kwargs): - """ - Enable/disable wall function based htc computation. - """ - return PyMenu(self.service, "/define/models/system_coupling_settings/htc/htc_calculation_method/use_wall_function_based_htc").execute(*args, **kwargs) - - class cht(metaclass=PyMenuMeta): - """ - Enters the cht (conjugate heat transfer) menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.explicit_time_averaged_coupling = self.__class__.explicit_time_averaged_coupling(path + [("explicit_time_averaged_coupling", None)], service) - def read_mi_type_wall(self, *args, **kwargs): - """ - Read mapped interface data settings from a csv file. - """ - return PyMenu(self.service, "/define/models/cht/read_mi_type_wall").execute(*args, **kwargs) - def write_mi_type_wall(self, *args, **kwargs): - """ - Write mapped interface settings to a scv file. - """ - return PyMenu(self.service, "/define/models/cht/write_mi_type_wall").execute(*args, **kwargs) - def implicit_coupling(self, *args, **kwargs): - """ - Enables the implicit mapping scheme for any fluid-solid pair with a mapped mesh interface (only required for cases set up in version 19.2 or earlier). - """ - return PyMenu(self.service, "/define/models/cht/implicit_coupling").execute(*args, **kwargs) - - class explicit_time_averaged_coupling(metaclass=PyMenuMeta): - """ - Enters the explicit time averaged thermal coupling menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def conformal_coupled_walls(self, *args, **kwargs): - """ - Select fluid-solid coupled walls (without shell) for explicit coupling using time averaged thermal variables. - """ - return PyMenu(self.service, "/define/models/cht/explicit_time_averaged_coupling/conformal_coupled_walls").execute(*args, **kwargs) - def mapped_interfaces(self, *args, **kwargs): - """ - Select fluid-solid mapped interfaces for explicit coupling using time averaged thermal variables. - """ - return PyMenu(self.service, "/define/models/cht/explicit_time_averaged_coupling/mapped_interfaces").execute(*args, **kwargs) - def coupling_controls(self, *args, **kwargs): - """ - Specify explcit coupling controls. - """ - return PyMenu(self.service, "/define/models/cht/explicit_time_averaged_coupling/coupling_controls").execute(*args, **kwargs) - def fuse_explicit_cht_zones(self, *args, **kwargs): - """ - Fuse slitted conformal coupled walls marked for transient explicit thermal coupling. - """ - return PyMenu(self.service, "/define/models/cht/explicit_time_averaged_coupling/fuse_explicit_cht_zones").execute(*args, **kwargs) - - class two_temperature(metaclass=PyMenuMeta): - """ - Enters the Two-Temperature model menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable(self, *args, **kwargs): - """ - Enables/disables the Two-Temperature model. - """ - return PyMenu(self.service, "/define/models/two_temperature/enable").execute(*args, **kwargs) - def robustness_enhancement(self, *args, **kwargs): - """ - Enables/disables the robustness enhancement, which is on by default. - """ - return PyMenu(self.service, "/define/models/two_temperature/robustness_enhancement").execute(*args, **kwargs) - def nasa9_enhancement(self, *args, **kwargs): - """ - Apply nasa9 robustness enhancements in the two-temperature model. - """ - return PyMenu(self.service, "/define/models/two_temperature/nasa9_enhancement").execute(*args, **kwargs) - def set_verbosity(self, *args, **kwargs): - """ - Specifies the level of detail printed in the console about the Two-Temperature model. For a verbosity of one, Fluent will print the number of cells that reach the temperature limit, have an excessive temperature change, or get a negative temperature. - """ - return PyMenu(self.service, "/define/models/two_temperature/set_verbosity").execute(*args, **kwargs) - - class multiphase(metaclass=PyMenuMeta): - """ - Enters the multiphase model menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.phases = self.__class__.phases(path + [("phases", None)], service) - self.wet_steam = self.__class__.wet_steam(path + [("wet_steam", None)], service) - self.population_balance = self.__class__.population_balance(path + [("population_balance", None)], service) - self.explicit_expert_options = self.__class__.explicit_expert_options(path + [("explicit_expert_options", None)], service) - def model(self, *args, **kwargs): - """ - Specifies multiphase model. - """ - return PyMenu(self.service, "/define/models/multiphase/model").execute(*args, **kwargs) - def number_of_phases(self, *args, **kwargs): - """ - Specifies the number of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/number_of_phases").execute(*args, **kwargs) - def regime_transition_modeling(self, *args, **kwargs): - """ - Enables the Algebraic Interfacial Area Density (AIAD) model and sets the AIAD secondary continuous phase and the secondary entrained phase. Entering 0 as a phase ID cancels any previous phase selection. Note that you must define the phases in your simulation using the define/phases/ text command prior to using the regime-transition-modeling text command. This option is available only with the Eulerian multiphase model. - """ - return PyMenu(self.service, "/define/models/multiphase/regime_transition_modeling").execute(*args, **kwargs) - def eulerian_parameters(self, *args, **kwargs): - """ - Specifies Eulerian parameters. - """ - return PyMenu(self.service, "/define/models/multiphase/eulerian_parameters").execute(*args, **kwargs) - def volume_fraction_parameters(self, *args, **kwargs): - """ - Specifies volume fraction parameters. - """ - return PyMenu(self.service, "/define/models/multiphase/volume_fraction_parameters").execute(*args, **kwargs) - def boiling_model_options(self, *args, **kwargs): - """ - Specifies the boiling model options. You can choose theRPI boiling model,Non-equilibrium boiling, orCritical heat flux. - """ - return PyMenu(self.service, "/define/models/multiphase/boiling_model_options").execute(*args, **kwargs) - def mixture_parameters(self, *args, **kwargs): - """ - Specifies mixture parameters. - """ - return PyMenu(self.service, "/define/models/multiphase/mixture_parameters").execute(*args, **kwargs) - def body_force_formulation(self, *args, **kwargs): - """ - Specifies body force formulation. - """ - return PyMenu(self.service, "/define/models/multiphase/body_force_formulation").execute(*args, **kwargs) - def coupled_level_set(self, *args, **kwargs): - """ - Enables coupled level set interface tracking method. - """ - return PyMenu(self.service, "/define/models/multiphase/coupled_level_set").execute(*args, **kwargs) - def vof_sub_models(self, *args, **kwargs): - """ - Enables the Open Channel sub-model and/or the Open Channel Wave Boundary Condition sub-model. - """ - return PyMenu(self.service, "/define/models/multiphase/vof_sub_models").execute(*args, **kwargs) - def interface_modeling_options(self, *args, **kwargs): - """ - Specifies interface modeling options. - """ - return PyMenu(self.service, "/define/models/multiphase/interface_modeling_options").execute(*args, **kwargs) - def expert_options(self, *args, **kwargs): - """ - Expert Options. - """ - return PyMenu(self.service, "/define/models/multiphase/expert_options").execute(*args, **kwargs) - - class phases(metaclass=PyMenuMeta): - """ - Enter the phases menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.set_domain_properties = self.__class__.set_domain_properties(path + [("set_domain_properties", None)], service) - self.iac_expert = self.__class__.iac_expert(path + [("iac_expert", None)], service) - - class set_domain_properties(metaclass=PyMenuMeta): - """ - Enter the menu to set domain properties. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.interaction_domain = self.__class__.interaction_domain(path + [("interaction_domain", None)], service) - def change_phases_names(self, *args, **kwargs): - """ - Change names for all defined phases?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/change_phases_names").execute(*args, **kwargs) - def phase_domains(self, *args, **kwargs): - """ - Enter the menu to select a specific phase domain. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/phase_domains").execute(*args, **kwargs) - - class interaction_domain(metaclass=PyMenuMeta): - """ - Enter the menu to set the interaction domain properties. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.forces = self.__class__.forces(path + [("forces", None)], service) - self.heat_mass_reactions = self.__class__.heat_mass_reactions(path + [("heat_mass_reactions", None)], service) - self.interfacial_area = self.__class__.interfacial_area(path + [("interfacial_area", None)], service) - self.model_transition = self.__class__.model_transition(path + [("model_transition", None)], service) - self.numerics = self.__class__.numerics(path + [("numerics", None)], service) - - class forces(metaclass=PyMenuMeta): - """ - Enter the menu to set interfacial forces related models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) - self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) - self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) - self.lift = self.__class__.lift(path + [("lift", None)], service) - self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) - self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) - def drag(self, *args, **kwargs): - """ - Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/drag").execute(*args, **kwargs) - def heat_coeff(self, *args, **kwargs): - """ - Specify the heat transfer coefficient function between each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/heat_coeff").execute(*args, **kwargs) - def interfacial_area(self, *args, **kwargs): - """ - Set the interfacial area parameters for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interfacial_area").execute(*args, **kwargs) - def mass_transfer(self, *args, **kwargs): - """ - Specify the mass transfer mechanisms. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/mass_transfer").execute(*args, **kwargs) - def model_transition(self, *args, **kwargs): - """ - Set the model transition mechanism. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/model_transition").execute(*args, **kwargs) - def reactions(self, *args, **kwargs): - """ - Define multiple heterogeneous reactions and stoichiometry. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/reactions").execute(*args, **kwargs) - def restitution(self, *args, **kwargs): - """ - Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/restitution").execute(*args, **kwargs) - def slip_velocity(self, *args, **kwargs): - """ - Specify the slip velocity function for each secondary phase with respect to the primary phase. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/slip_velocity").execute(*args, **kwargs) - def turbulence_interaction(self, *args, **kwargs): - """ - Specify the turbulence interaction model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/turbulence_interaction").execute(*args, **kwargs) - def turbulent_dispersion(self, *args, **kwargs): - """ - Specify the turbulent dispersion model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/turbulent_dispersion").execute(*args, **kwargs) - def wall_lubrication(self, *args, **kwargs): - """ - Specify the wall lubrication model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/wall_lubrication").execute(*args, **kwargs) - - class cavitation(metaclass=PyMenuMeta): - """ - Enter the menu to set cavitation models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/wall_adhesion").execute(*args, **kwargs) - - class interphase_discretization(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase discretization models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - - class interphase_viscous_dissipation(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase viscous dissipation related models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - - class lift(metaclass=PyMenuMeta): - """ - Enter the menu to set lift models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/wall_adhesion").execute(*args, **kwargs) - - class surface_tension(metaclass=PyMenuMeta): - """ - Enter the menu to set surface tension models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/wall_adhesion").execute(*args, **kwargs) - - class virtual_mass(metaclass=PyMenuMeta): - """ - Enter the menu to set virtual mass models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/wall_adhesion").execute(*args, **kwargs) - - class heat_mass_reactions(metaclass=PyMenuMeta): - """ - Enter the menu to set heat, mass-transfer, or reaction related models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) - self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) - self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) - self.lift = self.__class__.lift(path + [("lift", None)], service) - self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) - self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) - def drag(self, *args, **kwargs): - """ - Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/drag").execute(*args, **kwargs) - def heat_coeff(self, *args, **kwargs): - """ - Specify the heat transfer coefficient function between each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/heat_coeff").execute(*args, **kwargs) - def interfacial_area(self, *args, **kwargs): - """ - Set the interfacial area parameters for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interfacial_area").execute(*args, **kwargs) - def mass_transfer(self, *args, **kwargs): - """ - Specify the mass transfer mechanisms. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/mass_transfer").execute(*args, **kwargs) - def model_transition(self, *args, **kwargs): - """ - Set the model transition mechanism. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/model_transition").execute(*args, **kwargs) - def reactions(self, *args, **kwargs): - """ - Define multiple heterogeneous reactions and stoichiometry. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/reactions").execute(*args, **kwargs) - def restitution(self, *args, **kwargs): - """ - Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/restitution").execute(*args, **kwargs) - def slip_velocity(self, *args, **kwargs): - """ - Specify the slip velocity function for each secondary phase with respect to the primary phase. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/slip_velocity").execute(*args, **kwargs) - def turbulence_interaction(self, *args, **kwargs): - """ - Specify the turbulence interaction model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/turbulence_interaction").execute(*args, **kwargs) - def turbulent_dispersion(self, *args, **kwargs): - """ - Specify the turbulent dispersion model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/turbulent_dispersion").execute(*args, **kwargs) - def wall_lubrication(self, *args, **kwargs): - """ - Specify the wall lubrication model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/wall_lubrication").execute(*args, **kwargs) - - class cavitation(metaclass=PyMenuMeta): - """ - Enter the menu to set cavitation models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/wall_adhesion").execute(*args, **kwargs) - - class interphase_discretization(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase discretization models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - - class interphase_viscous_dissipation(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase viscous dissipation related models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - - class lift(metaclass=PyMenuMeta): - """ - Enter the menu to set lift models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/wall_adhesion").execute(*args, **kwargs) - - class surface_tension(metaclass=PyMenuMeta): - """ - Enter the menu to set surface tension models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/wall_adhesion").execute(*args, **kwargs) - - class virtual_mass(metaclass=PyMenuMeta): - """ - Enter the menu to set virtual mass models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/wall_adhesion").execute(*args, **kwargs) - - class interfacial_area(metaclass=PyMenuMeta): - """ - Enter the menu to set interfacial area models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) - self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) - self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) - self.lift = self.__class__.lift(path + [("lift", None)], service) - self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) - self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) - def drag(self, *args, **kwargs): - """ - Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/drag").execute(*args, **kwargs) - def heat_coeff(self, *args, **kwargs): - """ - Specify the heat transfer coefficient function between each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/heat_coeff").execute(*args, **kwargs) - def interfacial_area(self, *args, **kwargs): - """ - Set the interfacial area parameters for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interfacial_area").execute(*args, **kwargs) - def mass_transfer(self, *args, **kwargs): - """ - Specify the mass transfer mechanisms. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/mass_transfer").execute(*args, **kwargs) - def model_transition(self, *args, **kwargs): - """ - Set the model transition mechanism. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/model_transition").execute(*args, **kwargs) - def reactions(self, *args, **kwargs): - """ - Define multiple heterogeneous reactions and stoichiometry. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/reactions").execute(*args, **kwargs) - def restitution(self, *args, **kwargs): - """ - Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/restitution").execute(*args, **kwargs) - def slip_velocity(self, *args, **kwargs): - """ - Specify the slip velocity function for each secondary phase with respect to the primary phase. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/slip_velocity").execute(*args, **kwargs) - def turbulence_interaction(self, *args, **kwargs): - """ - Specify the turbulence interaction model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/turbulence_interaction").execute(*args, **kwargs) - def turbulent_dispersion(self, *args, **kwargs): - """ - Specify the turbulent dispersion model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/turbulent_dispersion").execute(*args, **kwargs) - def wall_lubrication(self, *args, **kwargs): - """ - Specify the wall lubrication model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/wall_lubrication").execute(*args, **kwargs) - - class cavitation(metaclass=PyMenuMeta): - """ - Enter the menu to set cavitation models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/wall_adhesion").execute(*args, **kwargs) - - class interphase_discretization(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase discretization models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - - class interphase_viscous_dissipation(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase viscous dissipation related models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - - class lift(metaclass=PyMenuMeta): - """ - Enter the menu to set lift models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/wall_adhesion").execute(*args, **kwargs) - - class surface_tension(metaclass=PyMenuMeta): - """ - Enter the menu to set surface tension models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/wall_adhesion").execute(*args, **kwargs) - - class virtual_mass(metaclass=PyMenuMeta): - """ - Enter the menu to set virtual mass models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/wall_adhesion").execute(*args, **kwargs) - - class model_transition(metaclass=PyMenuMeta): - """ - Enter the menu to set model transition mechanisms. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) - self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) - self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) - self.lift = self.__class__.lift(path + [("lift", None)], service) - self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) - self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) - def drag(self, *args, **kwargs): - """ - Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/drag").execute(*args, **kwargs) - def heat_coeff(self, *args, **kwargs): - """ - Specify the heat transfer coefficient function between each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/heat_coeff").execute(*args, **kwargs) - def interfacial_area(self, *args, **kwargs): - """ - Set the interfacial area parameters for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interfacial_area").execute(*args, **kwargs) - def mass_transfer(self, *args, **kwargs): - """ - Specify the mass transfer mechanisms. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/mass_transfer").execute(*args, **kwargs) - def model_transition(self, *args, **kwargs): - """ - Set the model transition mechanism. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/model_transition").execute(*args, **kwargs) - def reactions(self, *args, **kwargs): - """ - Define multiple heterogeneous reactions and stoichiometry. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/reactions").execute(*args, **kwargs) - def restitution(self, *args, **kwargs): - """ - Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/restitution").execute(*args, **kwargs) - def slip_velocity(self, *args, **kwargs): - """ - Specify the slip velocity function for each secondary phase with respect to the primary phase. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/slip_velocity").execute(*args, **kwargs) - def turbulence_interaction(self, *args, **kwargs): - """ - Specify the turbulence interaction model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/turbulence_interaction").execute(*args, **kwargs) - def turbulent_dispersion(self, *args, **kwargs): - """ - Specify the turbulent dispersion model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/turbulent_dispersion").execute(*args, **kwargs) - def wall_lubrication(self, *args, **kwargs): - """ - Specify the wall lubrication model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/wall_lubrication").execute(*args, **kwargs) - - class cavitation(metaclass=PyMenuMeta): - """ - Enter the menu to set cavitation models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/wall_adhesion").execute(*args, **kwargs) - - class interphase_discretization(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase discretization models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - - class interphase_viscous_dissipation(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase viscous dissipation related models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - - class lift(metaclass=PyMenuMeta): - """ - Enter the menu to set lift models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/wall_adhesion").execute(*args, **kwargs) - - class surface_tension(metaclass=PyMenuMeta): - """ - Enter the menu to set surface tension models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/wall_adhesion").execute(*args, **kwargs) - - class virtual_mass(metaclass=PyMenuMeta): - """ - Enter the menu to set virtual mass models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/wall_adhesion").execute(*args, **kwargs) - - class numerics(metaclass=PyMenuMeta): - """ - Enter the menu to set numerics models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) - self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) - self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) - self.lift = self.__class__.lift(path + [("lift", None)], service) - self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) - self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) - def drag(self, *args, **kwargs): - """ - Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/drag").execute(*args, **kwargs) - def heat_coeff(self, *args, **kwargs): - """ - Specify the heat transfer coefficient function between each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/heat_coeff").execute(*args, **kwargs) - def interfacial_area(self, *args, **kwargs): - """ - Set the interfacial area parameters for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interfacial_area").execute(*args, **kwargs) - def mass_transfer(self, *args, **kwargs): - """ - Specify the mass transfer mechanisms. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/mass_transfer").execute(*args, **kwargs) - def model_transition(self, *args, **kwargs): - """ - Set the model transition mechanism. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/model_transition").execute(*args, **kwargs) - def reactions(self, *args, **kwargs): - """ - Define multiple heterogeneous reactions and stoichiometry. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/reactions").execute(*args, **kwargs) - def restitution(self, *args, **kwargs): - """ - Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/restitution").execute(*args, **kwargs) - def slip_velocity(self, *args, **kwargs): - """ - Specify the slip velocity function for each secondary phase with respect to the primary phase. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/slip_velocity").execute(*args, **kwargs) - def turbulence_interaction(self, *args, **kwargs): - """ - Specify the turbulence interaction model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/turbulence_interaction").execute(*args, **kwargs) - def turbulent_dispersion(self, *args, **kwargs): - """ - Specify the turbulent dispersion model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/turbulent_dispersion").execute(*args, **kwargs) - def wall_lubrication(self, *args, **kwargs): - """ - Specify the wall lubrication model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/wall_lubrication").execute(*args, **kwargs) - - class cavitation(metaclass=PyMenuMeta): - """ - Enter the menu to set cavitation models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/wall_adhesion").execute(*args, **kwargs) - - class interphase_discretization(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase discretization models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - - class interphase_viscous_dissipation(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase viscous dissipation related models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - - class lift(metaclass=PyMenuMeta): - """ - Enter the menu to set lift models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/wall_adhesion").execute(*args, **kwargs) - - class surface_tension(metaclass=PyMenuMeta): - """ - Enter the menu to set surface tension models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/wall_adhesion").execute(*args, **kwargs) - - class virtual_mass(metaclass=PyMenuMeta): - """ - Enter the menu to set virtual mass models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/wall_adhesion").execute(*args, **kwargs) - - class iac_expert(metaclass=PyMenuMeta): - """ - Enter the IAC expert setting menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def ishii_kim_model(self, *args, **kwargs): - """ - Set ik model coefficients. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/iac_expert/ishii_kim_model").execute(*args, **kwargs) - def hibiki_ishii_model(self, *args, **kwargs): - """ - Set hi model coefficients. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/iac_expert/hibiki_ishii_model").execute(*args, **kwargs) - def yao_morel_model(self, *args, **kwargs): - """ - Set ym model coefficients. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/iac_expert/yao_morel_model").execute(*args, **kwargs) - def iac_pseudo_time_step(self, *args, **kwargs): - """ - Set iac pseudo-time. - """ - return PyMenu(self.service, "/define/models/multiphase/phases/iac_expert/iac_pseudo_time_step").execute(*args, **kwargs) - - class wet_steam(metaclass=PyMenuMeta): - """ - Enters the wet steam model menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.set = self.__class__.set(path + [("set", None)], service) - def enable(self, *args, **kwargs): - """ - Enables/disables the wet steam model. - """ - return PyMenu(self.service, "/define/models/multiphase/wet_steam/enable").execute(*args, **kwargs) - def compile_user_defined_wetsteam_functions(self, *args, **kwargs): - """ - Compiles user-defined wet steam library. - """ - return PyMenu(self.service, "/define/models/multiphase/wet_steam/compile_user_defined_wetsteam_functions").execute(*args, **kwargs) - def load_unload_user_defined_wetsteam_library(self, *args, **kwargs): - """ - Loads or unloads user-defined wet steam library. - """ - return PyMenu(self.service, "/define/models/multiphase/wet_steam/load_unload_user_defined_wetsteam_library").execute(*args, **kwargs) - - class set(metaclass=PyMenuMeta): - """ - Enters the set menu for setting wet steam model options. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def max_liquid_mass_fraction(self, *args, **kwargs): - """ - Sets the maximum limit on the condensed liquid-phase mass-fraction to prevent divergence. - """ - return PyMenu(self.service, "/define/models/multiphase/wet_steam/set/max_liquid_mass_fraction").execute(*args, **kwargs) - def droplet_growth_rate(self, *args, **kwargs): - """ - S formulation (default) or Hill - """ - return PyMenu(self.service, "/define/models/multiphase/wet_steam/set/droplet_growth_rate").execute(*args, **kwargs) - def virial_equation(self, *args, **kwargs): - """ - Sets the equation of state for steam to either Vukalovich formulation (default) or Young formulation. - """ - return PyMenu(self.service, "/define/models/multiphase/wet_steam/set/virial_equation").execute(*args, **kwargs) - def rgp_tables(self, *args, **kwargs): - """ - Sets the RGP (real gas property) table to be used with the Wet Steam model. - """ - return PyMenu(self.service, "/define/models/multiphase/wet_steam/set/rgp_tables").execute(*args, **kwargs) - def stagnation_conditions(self, *args, **kwargs): - """ - Computes stagnation conditions using either gas phase only, or mixture. For details, see . - """ - return PyMenu(self.service, "/define/models/multiphase/wet_steam/set/stagnation_conditions").execute(*args, **kwargs) - - class population_balance(metaclass=PyMenuMeta): - """ - Enters the population balance models menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.phenomena = self.__class__.phenomena(path + [("phenomena", None)], service) - self.expert = self.__class__.expert(path + [("expert", None)], service) - def model(self, *args, **kwargs): - """ - Allows you to select the population balance model and set its parameters. - """ - return PyMenu(self.service, "/define/models/multiphase/population_balance/model").execute(*args, **kwargs) - def include_expansion(self, *args, **kwargs): - """ - Set expansion. - """ - return PyMenu(self.service, "/define/models/multiphase/population_balance/include_expansion").execute(*args, **kwargs) - def size_calculator(self, *args, **kwargs): - """ - Gives you recommendations for appropriate bubble sizes and/or droplet size limits. - """ - return PyMenu(self.service, "/define/models/multiphase/population_balance/size_calculator").execute(*args, **kwargs) - - class phenomena(metaclass=PyMenuMeta): - """ - Enters the phenomena menu for population balance. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def nucleation(self, *args, **kwargs): - """ - Specifies the nucleation rate. - """ - return PyMenu(self.service, "/define/models/multiphase/population_balance/phenomena/nucleation").execute(*args, **kwargs) - def growth(self, *args, **kwargs): - """ - Specifies the growth rate. - """ - return PyMenu(self.service, "/define/models/multiphase/population_balance/phenomena/growth").execute(*args, **kwargs) - def aggregation(self, *args, **kwargs): - """ - Sets the aggregation kernel. - """ - return PyMenu(self.service, "/define/models/multiphase/population_balance/phenomena/aggregation").execute(*args, **kwargs) - def breakage(self, *args, **kwargs): - """ - Sets the breakage kernel. - """ - return PyMenu(self.service, "/define/models/multiphase/population_balance/phenomena/breakage").execute(*args, **kwargs) - def aggregation_factor(self, *args, **kwargs): - """ - Specifies a factor that controls the intensity of the selected aggregation kernel. - """ - return PyMenu(self.service, "/define/models/multiphase/population_balance/phenomena/aggregation_factor").execute(*args, **kwargs) - def breakage_factor(self, *args, **kwargs): - """ - Specifies a factor that controls the intensity of the selected breakage kernel. - """ - return PyMenu(self.service, "/define/models/multiphase/population_balance/phenomena/breakage_factor").execute(*args, **kwargs) - def breakage_aggregation_vof_cutoff(self, *args, **kwargs): - """ - Specifies a cutoff limit for the volume fraction values for the breakage and aggregation kernels. - """ - return PyMenu(self.service, "/define/models/multiphase/population_balance/phenomena/breakage_aggregation_vof_cutoff").execute(*args, **kwargs) - - class expert(metaclass=PyMenuMeta): - """ - Enter the expert menu for quadrature-based population balance method. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.qmom = self.__class__.qmom(path + [("qmom", None)], service) - - class qmom(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def retain_qmom_sources_for_low_vof(self, *args, **kwargs): - """ - Retain qmom source calculation for low secondary phase vof. - """ - return PyMenu(self.service, "/define/models/multiphase/population_balance/expert/qmom/retain_qmom_sources_for_low_vof").execute(*args, **kwargs) - def realizable_moments(self, *args, **kwargs): - """ - Set the population balance model. - """ - return PyMenu(self.service, "/define/models/multiphase/population_balance/expert/qmom/realizable_moments").execute(*args, **kwargs) - def print_realizable_moment_warning(self, *args, **kwargs): - """ - Print the information for realizable moments in the population balance model. - """ - return PyMenu(self.service, "/define/models/multiphase/population_balance/expert/qmom/print_realizable_moment_warning").execute(*args, **kwargs) - def inversion_algorithm(self, *args, **kwargs): - """ - Select the inversion algorithm for quadrature-based population balance method. - """ - return PyMenu(self.service, "/define/models/multiphase/population_balance/expert/qmom/inversion_algorithm").execute(*args, **kwargs) - - class explicit_expert_options(metaclass=PyMenuMeta): - """ - Enters the menu to set explicit VOF expert options. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.volume_fraction_filtering = self.__class__.volume_fraction_filtering(path + [("volume_fraction_filtering", None)], service) - def sub_time_step_method(self, *args, **kwargs): - """ - Selects the sub-time step method. - """ - return PyMenu(self.service, "/define/models/multiphase/explicit_expert_options/sub_time_step_method").execute(*args, **kwargs) - def solve_vof_every_iter(self, *args, **kwargs): - """ - If you enter yes, the volume fraction equations will be solved every iteration. By default, the volume fraction equations will be solved only once per time step. - """ - return PyMenu(self.service, "/define/models/multiphase/explicit_expert_options/solve_vof_every_iter").execute(*args, **kwargs) - - class volume_fraction_filtering(metaclass=PyMenuMeta): - """ - Enters the volume fraction filtering menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable(self, *args, **kwargs): - """ - Enables/disables the volume fraction filtering treatment. - """ - return PyMenu(self.service, "/define/models/multiphase/explicit_expert_options/volume_fraction_filtering/enable").execute(*args, **kwargs) - def filtering_options(self, *args, **kwargs): - """ - Selects the volume fraction filtering method. This command becomes available once the define/models/multiphase/explicit-expert-options/volume-fraction-filtering/enable? text option has been set to yes. - """ - return PyMenu(self.service, "/define/models/multiphase/explicit_expert_options/volume_fraction_filtering/filtering_options").execute(*args, **kwargs) - def vol_frac_cutoff(self, *args, **kwargs): - """ - Specifies a cut-off value for the volume fraction filtering. This command becomes available after you select the node averaged cutoff method using the define/models/multiphase/explicit-expert-options/volume-fraction-filtering/filtering-options text command. - """ - return PyMenu(self.service, "/define/models/multiphase/explicit_expert_options/volume_fraction_filtering/vol_frac_cutoff").execute(*args, **kwargs) - - class nox_parameters(metaclass=PyMenuMeta): - """ - Enters the NOx parameters menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def nox_chemistry(self, *args, **kwargs): - """ - Selects NOx chemistry model. - """ - return PyMenu(self.service, "/define/models/nox_parameters/nox_chemistry").execute(*args, **kwargs) - def nox_turbulence_interaction(self, *args, **kwargs): - """ - Sets NOx turbulence interaction model. - """ - return PyMenu(self.service, "/define/models/nox_parameters/nox_turbulence_interaction").execute(*args, **kwargs) - def inlet_diffusion(self, *args, **kwargs): - """ - Enables/disables inclusion of diffusion at inlets. - """ - return PyMenu(self.service, "/define/models/nox_parameters/inlet_diffusion").execute(*args, **kwargs) - def nox_expert(self, *args, **kwargs): - """ - Selects additional NOx equations. - """ - return PyMenu(self.service, "/define/models/nox_parameters/nox_expert").execute(*args, **kwargs) - - class soot_parameters(metaclass=PyMenuMeta): - """ - Enters the soot parameters menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def soot_model_parameters(self, *args, **kwargs): - """ - Selects soot model parameters. - """ - return PyMenu(self.service, "/define/models/soot_parameters/soot_model_parameters").execute(*args, **kwargs) - def soot_process_parameters(self, *args, **kwargs): - """ - Selects soot process parameters. - """ - return PyMenu(self.service, "/define/models/soot_parameters/soot_process_parameters").execute(*args, **kwargs) - def soot_radiation_interaction(self, *args, **kwargs): - """ - Enables/disables the soot-radiation interaction model. - """ - return PyMenu(self.service, "/define/models/soot_parameters/soot_radiation_interaction").execute(*args, **kwargs) - def soot_turbulence_interaction(self, *args, **kwargs): - """ - Sets soot-turbulence interaction model. - """ - return PyMenu(self.service, "/define/models/soot_parameters/soot_turbulence_interaction").execute(*args, **kwargs) - def modify_schmidt_number(self, *args, **kwargs): - """ - Changes the turbulent Schmidt number for soot/nuclei equations. - """ - return PyMenu(self.service, "/define/models/soot_parameters/modify_schmidt_number").execute(*args, **kwargs) - def inlet_diffusion(self, *args, **kwargs): - """ - Enables/disables inclusion of diffusion at inlets. - """ - return PyMenu(self.service, "/define/models/soot_parameters/inlet_diffusion").execute(*args, **kwargs) - def soot_model_udfs(self, *args, **kwargs): - """ - User defined functions for soot model. - """ - return PyMenu(self.service, "/define/models/soot_parameters/soot_model_udfs").execute(*args, **kwargs) - - class radiation(metaclass=PyMenuMeta): - """ - Enters the radiation models menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.s2s_parameters = self.__class__.s2s_parameters(path + [("s2s_parameters", None)], service) - self.dtrm_parameters = self.__class__.dtrm_parameters(path + [("dtrm_parameters", None)], service) - self.solar_parameters = self.__class__.solar_parameters(path + [("solar_parameters", None)], service) - def discrete_ordinates(self, *args, **kwargs): - """ - Enables/disables discrete ordinates radiation model. - """ - return PyMenu(self.service, "/define/models/radiation/discrete_ordinates").execute(*args, **kwargs) - def do_acceleration(self, *args, **kwargs): - """ - Enables/disables the acceleration of the discrete ordinates (DO) radiation model calculations. Note that this text command is only available when running on Linux in parallel. - """ - return PyMenu(self.service, "/define/models/radiation/do_acceleration").execute(*args, **kwargs) - def non_gray_model_parameters(self, *args, **kwargs): - """ - Sets parameters for non-gray model. - """ - return PyMenu(self.service, "/define/models/radiation/non_gray_model_parameters").execute(*args, **kwargs) - def montecarlo(self, *args, **kwargs): - """ - Enables/disables the Monte Carlo radiation model. - """ - return PyMenu(self.service, "/define/models/radiation/montecarlo").execute(*args, **kwargs) - def target_cells_per_volume_cluster(self, *args, **kwargs): - """ - Sets the amount of coarsening of the radiation mesh for the Monte Carlo radiation model. A number greater than one implies coarsening, whereas equal to one implies no coarsening. - """ - return PyMenu(self.service, "/define/models/radiation/target_cells_per_volume_cluster").execute(*args, **kwargs) - def s2s(self, *args, **kwargs): - """ - Enables/disables S2S radiation model. - """ - return PyMenu(self.service, "/define/models/radiation/s2s").execute(*args, **kwargs) - def discrete_transfer(self, *args, **kwargs): - """ - Enables/disables discrete transfer radiation model. - """ - return PyMenu(self.service, "/define/models/radiation/discrete_transfer").execute(*args, **kwargs) - def p1(self, *args, **kwargs): - """ - Enables/disables P1 radiation model. - """ - return PyMenu(self.service, "/define/models/radiation/p1").execute(*args, **kwargs) - def radiation_model_parameters(self, *args, **kwargs): - """ - Sets parameters for radiation models. - """ - return PyMenu(self.service, "/define/models/radiation/radiation_model_parameters").execute(*args, **kwargs) - def radiation_iteration_parameters(self, *args, **kwargs): - """ - Sets iteration parameters for radiation models. - """ - return PyMenu(self.service, "/define/models/radiation/radiation_iteration_parameters").execute(*args, **kwargs) - def mc_model_parameters(self, *args, **kwargs): - """ - Specifies Monte Carlo model parameters. This text command is available only when the Monte Carlo model is enabled. - """ - return PyMenu(self.service, "/define/models/radiation/mc_model_parameters").execute(*args, **kwargs) - def mc_under_relaxation(self, *args, **kwargs): - """ - Sets the under-relaxation factor for Monte Carlo radiation sources used in the energy equation. - """ - return PyMenu(self.service, "/define/models/radiation/mc_under_relaxation").execute(*args, **kwargs) - def rosseland(self, *args, **kwargs): - """ - Enables/disables Rosseland radiation model. - """ - return PyMenu(self.service, "/define/models/radiation/rosseland").execute(*args, **kwargs) - def solar(self, *args, **kwargs): - """ - Enables/disables solar model. - """ - return PyMenu(self.service, "/define/models/radiation/solar").execute(*args, **kwargs) - def solar_irradiation(self, *args, **kwargs): - """ - Enables/disables the solar irradiation model. - """ - return PyMenu(self.service, "/define/models/radiation/solar_irradiation").execute(*args, **kwargs) - def solar_calculator(self, *args, **kwargs): - """ - Calculates sun direction and intensity. - """ - return PyMenu(self.service, "/define/models/radiation/solar_calculator").execute(*args, **kwargs) - def apply_full_solar_irradiation(self, *args, **kwargs): - """ - Enables/disables the application of the complete solar load to the first wavelength band only, reverting to the pre-2019 R1 behavior of the Solar Load and Discrete Ordinates models. - """ - return PyMenu(self.service, "/define/models/radiation/apply_full_solar_irradiation").execute(*args, **kwargs) - def wsggm_cell_based(self, *args, **kwargs): - """ - Enables/disables WSGGM cell based method. Note that when enabled, the wsggm-cell-based option will become available in theAbsorption Coefficient drop-down list in the Create/Edit Materials dialog box. - """ - return PyMenu(self.service, "/define/models/radiation/wsggm_cell_based").execute(*args, **kwargs) - def fast_second_order_discrete_ordinate(self, *args, **kwargs): - """ - Enables/disables the fast-second-order option for Discrete Ordinate Model. - """ - return PyMenu(self.service, "/define/models/radiation/fast_second_order_discrete_ordinate").execute(*args, **kwargs) - def do_coupling(self, *args, **kwargs): - """ - Enables/disables DO/energy coupling. - """ - return PyMenu(self.service, "/define/models/radiation/do_coupling").execute(*args, **kwargs) - def solution_method_for_do_coupling(self, *args, **kwargs): - """ - Enables/disables the solution method for DO/energy coupling. - """ - return PyMenu(self.service, "/define/models/radiation/solution_method_for_do_coupling").execute(*args, **kwargs) - def beta_radiation_features(self, *args, **kwargs): - """ - Enable Radiation Models with Non-Iterative Time Advancement (NITA) as Beta features in FL12.0. - """ - return PyMenu(self.service, "/define/models/radiation/beta_radiation_features").execute(*args, **kwargs) - def method_partially_specular_wall(self, *args, **kwargs): - """ - Sets the method for partially specular wall with discrete ordinate model. - """ - return PyMenu(self.service, "/define/models/radiation/method_partially_specular_wall").execute(*args, **kwargs) - def blending_factor(self, *args, **kwargs): - """ - Sets numeric option for Discrete Ordinate model. Make sure thatSecond Order Upwind is selected for the Discrete Ordinates spatial discretization for the blending-factor option to appear in the text command list. - """ - return PyMenu(self.service, "/define/models/radiation/blending_factor").execute(*args, **kwargs) - - class s2s_parameters(metaclass=PyMenuMeta): - """ - Enters the S2S parameters menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def compute_vf_only(self, *args, **kwargs): - """ - Computes/writes view factors only. - """ - return PyMenu(self.service, "/define/models/radiation/s2s_parameters/compute_vf_only").execute(*args, **kwargs) - def compute_write_vf(self, *args, **kwargs): - """ - Computes/writes surface clusters and view factors for S2S radiation model. - """ - return PyMenu(self.service, "/define/models/radiation/s2s_parameters/compute_write_vf").execute(*args, **kwargs) - def compute_vf_accelerated(self, *args, **kwargs): - """ - Compute/Write view factors from existing surface clusters. - """ - return PyMenu(self.service, "/define/models/radiation/s2s_parameters/compute_vf_accelerated").execute(*args, **kwargs) - def compute_clusters_and_vf_accelerated(self, *args, **kwargs): - """ - Compute/Write surface cluster first and then view factors. - """ - return PyMenu(self.service, "/define/models/radiation/s2s_parameters/compute_clusters_and_vf_accelerated").execute(*args, **kwargs) - def non_participating_boundary_zones_temperature(self, *args, **kwargs): - """ - Sets temperature for the non-participating boundary zones. - """ - return PyMenu(self.service, "/define/models/radiation/s2s_parameters/non_participating_boundary_zones_temperature").execute(*args, **kwargs) - def read_vf_file(self, *args, **kwargs): - """ - Reads S2S file. - """ - return PyMenu(self.service, "/define/models/radiation/s2s_parameters/read_vf_file").execute(*args, **kwargs) - def set_vf_parameters(self, *args, **kwargs): - """ - Sets the parameters needed for the viewfactor calculations. - """ - return PyMenu(self.service, "/define/models/radiation/s2s_parameters/set_vf_parameters").execute(*args, **kwargs) - def split_angle(self, *args, **kwargs): - """ - Sets split angle for the clustering algorithm. - """ - return PyMenu(self.service, "/define/models/radiation/s2s_parameters/split_angle").execute(*args, **kwargs) - def set_global_faces_per_surface_cluster(self, *args, **kwargs): - """ - Sets global value of faces per surface cluster for all boundary zones. - """ - return PyMenu(self.service, "/define/models/radiation/s2s_parameters/set_global_faces_per_surface_cluster").execute(*args, **kwargs) - def print_thread_clusters(self, *args, **kwargs): - """ - Prints the following for all boundary threads: thread-id, number of faces, faces per surface cluster, and the number of surface clusters. - """ - return PyMenu(self.service, "/define/models/radiation/s2s_parameters/print_thread_clusters").execute(*args, **kwargs) - def print_zonewise_radiation(self, *args, **kwargs): - """ - Prints the zonewise incoming radiation, viewfactors, and average temperature. - """ - return PyMenu(self.service, "/define/models/radiation/s2s_parameters/print_zonewise_radiation").execute(*args, **kwargs) - def use_old_cluster_algorithm(self, *args, **kwargs): - """ - Uses the old surface clustering algorithm. - """ - return PyMenu(self.service, "/define/models/radiation/s2s_parameters/use_old_cluster_algorithm").execute(*args, **kwargs) - def use_new_cluster_algorithm(self, *args, **kwargs): - """ - Uses the new surface clustering algorithm. - """ - return PyMenu(self.service, "/define/models/radiation/s2s_parameters/use_new_cluster_algorithm").execute(*args, **kwargs) - def compute_fpsc_values(self, *args, **kwargs): - """ - Computes only fpsc values based on current settings - """ - return PyMenu(self.service, "/define/models/radiation/s2s_parameters/compute_fpsc_values").execute(*args, **kwargs) - def enable_mesh_interface_clustering(self, *args, **kwargs): - """ - Enables surface clusters on mesh interfaces. - """ - return PyMenu(self.service, "/define/models/radiation/s2s_parameters/enable_mesh_interface_clustering").execute(*args, **kwargs) - - class dtrm_parameters(metaclass=PyMenuMeta): - """ - Enters the dtrm parameters menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def controls(self, *args, **kwargs): - """ - Sets dtrm solution controls. - """ - return PyMenu(self.service, "/define/models/radiation/dtrm_parameters/controls").execute(*args, **kwargs) - def make_globs(self, *args, **kwargs): - """ - Makes globs (coarser mesh) for radiation. - """ - return PyMenu(self.service, "/define/models/radiation/dtrm_parameters/make_globs").execute(*args, **kwargs) - def ray_trace(self, *args, **kwargs): - """ - Creates DTRM rays for radiation. - """ - return PyMenu(self.service, "/define/models/radiation/dtrm_parameters/ray_trace").execute(*args, **kwargs) - def check_ray_file(self, *args, **kwargs): - """ - Reads DTRM rays file. - """ - return PyMenu(self.service, "/define/models/radiation/dtrm_parameters/check_ray_file").execute(*args, **kwargs) - - class solar_parameters(metaclass=PyMenuMeta): - """ - Enters the solar parameters menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def autosave_solar_data(self, *args, **kwargs): - """ - Sets autosave solar data parameters. - """ - return PyMenu(self.service, "/define/models/radiation/solar_parameters/autosave_solar_data").execute(*args, **kwargs) - def autoread_solar_data(self, *args, **kwargs): - """ - Sets autoread solar data parameters. - """ - return PyMenu(self.service, "/define/models/radiation/solar_parameters/autoread_solar_data").execute(*args, **kwargs) - def sun_direction_vector(self, *args, **kwargs): - """ - Sets sun direction vector. - """ - return PyMenu(self.service, "/define/models/radiation/solar_parameters/sun_direction_vector").execute(*args, **kwargs) - def illumination_parameters(self, *args, **kwargs): - """ - Sets illumination parameters. - """ - return PyMenu(self.service, "/define/models/radiation/solar_parameters/illumination_parameters").execute(*args, **kwargs) - def iteration_parameters(self, *args, **kwargs): - """ - Sets update parameters. - """ - return PyMenu(self.service, "/define/models/radiation/solar_parameters/iteration_parameters").execute(*args, **kwargs) - def quad_tree_parameters(self, *args, **kwargs): - """ - Sets quad-tree refinement parameters. - """ - return PyMenu(self.service, "/define/models/radiation/solar_parameters/quad_tree_parameters").execute(*args, **kwargs) - def ground_reflectivity(self, *args, **kwargs): - """ - Sets ground reflectivity parameters. - """ - return PyMenu(self.service, "/define/models/radiation/solar_parameters/ground_reflectivity").execute(*args, **kwargs) - def scattering_fraction(self, *args, **kwargs): - """ - Sets scattering fraction parameters. - """ - return PyMenu(self.service, "/define/models/radiation/solar_parameters/scattering_fraction").execute(*args, **kwargs) - def sol_on_demand(self, *args, **kwargs): - """ - Sets solar load on demand. - """ - return PyMenu(self.service, "/define/models/radiation/solar_parameters/sol_on_demand").execute(*args, **kwargs) - def sol_camera_pos(self, *args, **kwargs): - """ - Sets camera position based on sun direction vector. - """ - return PyMenu(self.service, "/define/models/radiation/solar_parameters/sol_camera_pos").execute(*args, **kwargs) - def sol_adjacent_fluidcells(self, *args, **kwargs): - """ - Sets solar load on for adjacent fluid cells. - """ - return PyMenu(self.service, "/define/models/radiation/solar_parameters/sol_adjacent_fluidcells").execute(*args, **kwargs) - def use_direction_from_sol_calc(self, *args, **kwargs): - """ - Sets direction computed from solar calculator. - """ - return PyMenu(self.service, "/define/models/radiation/solar_parameters/use_direction_from_sol_calc").execute(*args, **kwargs) - def solar_thread_control(self, *args, **kwargs): - """ - Sets the number of threads to run the solar flux calculation. This item appears only when running in parallel with nodes located on a separate machine from the one running the host process andSolar Ray Tracing is enabled. - """ - return PyMenu(self.service, "/define/models/radiation/solar_parameters/solar_thread_control").execute(*args, **kwargs) - - class solver(metaclass=PyMenuMeta): - """ - Enters the menu to select the solver. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def pressure_based(self, *args, **kwargs): - """ - Enables/disables the pressure-based solver. - """ - return PyMenu(self.service, "/define/models/solver/pressure_based").execute(*args, **kwargs) - def density_based_explicit(self, *args, **kwargs): - """ - Enables/disables the density-based-explicit solver. - """ - return PyMenu(self.service, "/define/models/solver/density_based_explicit").execute(*args, **kwargs) - def density_based_implicit(self, *args, **kwargs): - """ - Enables/disables the density-based-implicit solver. - """ - return PyMenu(self.service, "/define/models/solver/density_based_implicit").execute(*args, **kwargs) - def adjust_solver_defaults_based_on_setup(self, *args, **kwargs): - """ - Enable/disable adjustment of solver defaults based on setup. - """ - return PyMenu(self.service, "/define/models/solver/adjust_solver_defaults_based_on_setup").execute(*args, **kwargs) - - class species(metaclass=PyMenuMeta): - """ - Enters the species models menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.CHEMKIN_CFD_parameters = self.__class__.CHEMKIN_CFD_parameters(path + [("CHEMKIN_CFD_parameters", None)], service) - def off(self, *args, **kwargs): - """ - Enables/disables solution of species models. - """ - return PyMenu(self.service, "/define/models/species/off").execute(*args, **kwargs) - def species_transport(self, *args, **kwargs): - """ - Enables/disables the species transport model. - """ - return PyMenu(self.service, "/define/models/species/species_transport").execute(*args, **kwargs) - def non_premixed_combustion(self, *args, **kwargs): - """ - Enables/disables non-premixed combustion model. - """ - return PyMenu(self.service, "/define/models/species/non_premixed_combustion").execute(*args, **kwargs) - def premixed_combustion(self, *args, **kwargs): - """ - Enables/disables premixed combustion model. - """ - return PyMenu(self.service, "/define/models/species/premixed_combustion").execute(*args, **kwargs) - def partially_premixed_combustion(self, *args, **kwargs): - """ - Enables/disables partially premixed combustion model. - """ - return PyMenu(self.service, "/define/models/species/partially_premixed_combustion").execute(*args, **kwargs) - def premixed_model(self, *args, **kwargs): - """ - Sets premixed combustion model. - """ - return PyMenu(self.service, "/define/models/species/premixed_model").execute(*args, **kwargs) - def pdf_transport(self, *args, **kwargs): - """ - Enables/disables the composition PDF transport combustion model. - """ - return PyMenu(self.service, "/define/models/species/pdf_transport").execute(*args, **kwargs) - def save_gradients(self, *args, **kwargs): - """ - Enables/disables storage of species mass fraction gradients. - """ - return PyMenu(self.service, "/define/models/species/save_gradients").execute(*args, **kwargs) - def liquid_energy_diffusion(self, *args, **kwargs): - """ - Enable/disable energy diffusion for liquid regime. - """ - return PyMenu(self.service, "/define/models/species/liquid_energy_diffusion").execute(*args, **kwargs) - def volumetric_reactions(self, *args, **kwargs): - """ - Enables/disables volumetric reactions. - """ - return PyMenu(self.service, "/define/models/species/volumetric_reactions").execute(*args, **kwargs) - def species_transport_expert(self, *args, **kwargs): - """ - Sets the convergence acceleration expert parameters. This command is only available when the species transport model is enabled. - """ - return PyMenu(self.service, "/define/models/species/species_transport_expert").execute(*args, **kwargs) - def coal_calculator(self, *args, **kwargs): - """ - Sets up coal modeling inputs. - """ - return PyMenu(self.service, "/define/models/species/coal_calculator").execute(*args, **kwargs) - def mixing_model(self, *args, **kwargs): - """ - Sets PDF Transport mixing model. - """ - return PyMenu(self.service, "/define/models/species/mixing_model").execute(*args, **kwargs) - def stiff_chemistry(self, *args, **kwargs): - """ - Enables/disables stiff chemistry option. - """ - return PyMenu(self.service, "/define/models/species/stiff_chemistry").execute(*args, **kwargs) - def liquid_micro_mixing(self, *args, **kwargs): - """ - Enables/disables liquid micro mixing. - """ - return PyMenu(self.service, "/define/models/species/liquid_micro_mixing").execute(*args, **kwargs) - def epdf_energy(self, *args, **kwargs): - """ - Enables/disables EPDF energy option. - """ - return PyMenu(self.service, "/define/models/species/epdf_energy").execute(*args, **kwargs) - def integration_parameters(self, *args, **kwargs): - """ - Sets chemistry ODE integrator parameters. Enables/disables stiff chemistry acceleration methods and set their parameters. - """ - return PyMenu(self.service, "/define/models/species/integration_parameters").execute(*args, **kwargs) - def clear_isat_table(self, *args, **kwargs): - """ - Clears ISAT table. - """ - return PyMenu(self.service, "/define/models/species/clear_isat_table").execute(*args, **kwargs) - def pdf_transport_expert(self, *args, **kwargs): - """ - Enables/disables PDF Transport expert user. - """ - return PyMenu(self.service, "/define/models/species/pdf_transport_expert").execute(*args, **kwargs) - def set_turb_chem_interaction(self, *args, **kwargs): - """ - Sets EDC model constants. - """ - return PyMenu(self.service, "/define/models/species/set_turb_chem_interaction").execute(*args, **kwargs) - def spark_model(self, *args, **kwargs): - """ - Switches between the R15 and R14.5 spark models and sets spark model parameters. - """ - return PyMenu(self.service, "/define/models/species/spark_model").execute(*args, **kwargs) - def ignition_model(self, *args, **kwargs): - """ - Enables/disables the ignition model. - """ - return PyMenu(self.service, "/define/models/species/ignition_model").execute(*args, **kwargs) - def ignition_model_controls(self, *args, **kwargs): - """ - Sets ignition model parameters. - """ - return PyMenu(self.service, "/define/models/species/ignition_model_controls").execute(*args, **kwargs) - def inert_transport_model(self, *args, **kwargs): - """ - Enables/disables the inert transport model. - """ - return PyMenu(self.service, "/define/models/species/inert_transport_model").execute(*args, **kwargs) - def inert_transport_controls(self, *args, **kwargs): - """ - Sets inert transport model parameters. - """ - return PyMenu(self.service, "/define/models/species/inert_transport_controls").execute(*args, **kwargs) - def particle_surface_reactions(self, *args, **kwargs): - """ - Enables/disables particle surface reactions. - """ - return PyMenu(self.service, "/define/models/species/particle_surface_reactions").execute(*args, **kwargs) - def wall_surface_reactions(self, *args, **kwargs): - """ - Enables/disables wall surface reactions. - """ - return PyMenu(self.service, "/define/models/species/wall_surface_reactions").execute(*args, **kwargs) - def heat_of_surface_reactions(self, *args, **kwargs): - """ - Enables/disables heat of surface reactions. - """ - return PyMenu(self.service, "/define/models/species/heat_of_surface_reactions").execute(*args, **kwargs) - def mass_deposition_source(self, *args, **kwargs): - """ - Enables/disables mass deposition source due to surface reactions. - """ - return PyMenu(self.service, "/define/models/species/mass_deposition_source").execute(*args, **kwargs) - def electro_chemical_surface_reactions(self, *args, **kwargs): - """ - Enables/disables electrochemical surface reactions. - """ - return PyMenu(self.service, "/define/models/species/electro_chemical_surface_reactions").execute(*args, **kwargs) - def species_migration(self, *args, **kwargs): - """ - Includes species migration in electric field. This command is available only when the electrochemical surface reactions are enabled. - """ - return PyMenu(self.service, "/define/models/species/species_migration").execute(*args, **kwargs) - def reaction_diffusion_balance(self, *args, **kwargs): - """ - Enables/disables reaction diffusion balance at reacting surface for surface reactions. - """ - return PyMenu(self.service, "/define/models/species/reaction_diffusion_balance").execute(*args, **kwargs) - def surf_reaction_aggressiveness_factor(self, *args, **kwargs): - """ - Sets the surface reaction aggressiveness factor. - """ - return PyMenu(self.service, "/define/models/species/surf_reaction_aggressiveness_factor").execute(*args, **kwargs) - def surf_reaction_netm_params(self, *args, **kwargs): - """ - Sets the surface reaction parameters for the Non-Equilibrium Thermal Model. - """ - return PyMenu(self.service, "/define/models/species/surf_reaction_netm_params").execute(*args, **kwargs) - def inlet_diffusion(self, *args, **kwargs): - """ - Enables/disables inclusion of diffusion at inlets. - """ - return PyMenu(self.service, "/define/models/species/inlet_diffusion").execute(*args, **kwargs) - def diffusion_energy_source(self, *args, **kwargs): - """ - Enables/disables diffusion energy source. - """ - return PyMenu(self.service, "/define/models/species/diffusion_energy_source").execute(*args, **kwargs) - def multicomponent_diffusion(self, *args, **kwargs): - """ - Enables/disables multicomponent diffusion. - """ - return PyMenu(self.service, "/define/models/species/multicomponent_diffusion").execute(*args, **kwargs) - def thermal_diffusion(self, *args, **kwargs): - """ - Enables/disables thermal diffusion. - """ - return PyMenu(self.service, "/define/models/species/thermal_diffusion").execute(*args, **kwargs) - def CHEMKIN_CFD(self, *args, **kwargs): - """ - Enables/disables the Ansys CHEMKIN-CFD solver. - """ - return PyMenu(self.service, "/define/models/species/CHEMKIN_CFD").execute(*args, **kwargs) - def non_premixed_combustion_parameters(self, *args, **kwargs): - """ - Sets PDF parameters. - """ - return PyMenu(self.service, "/define/models/species/non_premixed_combustion_parameters").execute(*args, **kwargs) - def partially_premixed_combustion_parameters(self, *args, **kwargs): - """ - Sets PDF parameters. - """ - return PyMenu(self.service, "/define/models/species/partially_premixed_combustion_parameters").execute(*args, **kwargs) - def partially_premixed_properties(self, *args, **kwargs): - """ - Sets/changes partially-premixed mixture properties. This command is only available when partially-premixed-combustion? is enabled. - """ - return PyMenu(self.service, "/define/models/species/partially_premixed_properties").execute(*args, **kwargs) - def re_calc_par_premix_props(self, *args, **kwargs): - """ - Re-calculate partially-premixed properties. - """ - return PyMenu(self.service, "/define/models/species/re_calc_par_premix_props").execute(*args, **kwargs) - def full_tabulation(self, *args, **kwargs): - """ - Enables/disables building of a full 2-mixture fraction table - """ - return PyMenu(self.service, "/define/models/species/full_tabulation").execute(*args, **kwargs) - def init_unsteady_flamelet_prob(self, *args, **kwargs): - """ - Initializes Unsteady Flamelet Probability. - """ - return PyMenu(self.service, "/define/models/species/init_unsteady_flamelet_prob").execute(*args, **kwargs) - def import_flamelet_for_restart(self, *args, **kwargs): - """ - Imports Flamelet File for Restart. - """ - return PyMenu(self.service, "/define/models/species/import_flamelet_for_restart").execute(*args, **kwargs) - def non_premixed_combustion_expert(self, *args, **kwargs): - """ - Sets PDF expert parameters. - """ - return PyMenu(self.service, "/define/models/species/non_premixed_combustion_expert").execute(*args, **kwargs) - def partially_premixed_combustion_expert(self, *args, **kwargs): - """ - Sets PDF expert parameters. - """ - return PyMenu(self.service, "/define/models/species/partially_premixed_combustion_expert").execute(*args, **kwargs) - def partially_premixed_combustion_grids(self, *args, **kwargs): - """ - Sets values for the grid distribution for PDF table or flamelet parameter. This text command is available only for partially premixed combustion cases with FGM. - """ - return PyMenu(self.service, "/define/models/species/partially_premixed_combustion_grids").execute(*args, **kwargs) - def flamelet_expert(self, *args, **kwargs): - """ - Sets flamelet expert parameters. - """ - return PyMenu(self.service, "/define/models/species/flamelet_expert").execute(*args, **kwargs) - def combustion_expert(self, *args, **kwargs): - """ - Enables import of the CHEMKIN mechanism transport data. When this option is enabled, you will be prompted for importing CHEMKIN transport property database when setting your combustion case. - """ - return PyMenu(self.service, "/define/models/species/combustion_expert").execute(*args, **kwargs) - def set_premixed_combustion(self, *args, **kwargs): - """ - Sets premixed combustion parameters. - """ - return PyMenu(self.service, "/define/models/species/set_premixed_combustion").execute(*args, **kwargs) - def set_multi_regime_fgm(self, *args, **kwargs): - """ - Set-multi-regim-fgm-parameters. - """ - return PyMenu(self.service, "/define/models/species/set_multi_regime_fgm").execute(*args, **kwargs) - def relax_to_equil(self, *args, **kwargs): - """ - Enables/disables the Relaxation to Chemical Equilibrium model. - """ - return PyMenu(self.service, "/define/models/species/relax_to_equil").execute(*args, **kwargs) - def thickened_flame_model(self, *args, **kwargs): - """ - Enables/disables the Relaxation to Chemical Equilibrium model - """ - return PyMenu(self.service, "/define/models/species/thickened_flame_model").execute(*args, **kwargs) - def decoupled_detailed_chemistry(self, *args, **kwargs): - """ - Enables/disables the Decoupled Detailed Chemistry model. - """ - return PyMenu(self.service, "/define/models/species/decoupled_detailed_chemistry").execute(*args, **kwargs) - def reactor_network_model(self, *args, **kwargs): - """ - Enables/disables the Reactor Network Model. - """ - return PyMenu(self.service, "/define/models/species/reactor_network_model").execute(*args, **kwargs) - def reacting_channel_model(self, *args, **kwargs): - """ - Enables/disables the Reacting Channel Model. - """ - return PyMenu(self.service, "/define/models/species/reacting_channel_model").execute(*args, **kwargs) - def reacting_channel_model_options(self, *args, **kwargs): - """ - Sets Reacting Channel Model parameters. - """ - return PyMenu(self.service, "/define/models/species/reacting_channel_model_options").execute(*args, **kwargs) - def combustion_numerics(self, *args, **kwargs): - """ - Applies optimal solver settings automatically to provide a faster solution time. This command is available only for transient non-premixed and partially premixed combustion models. - """ - return PyMenu(self.service, "/define/models/species/combustion_numerics").execute(*args, **kwargs) - - class CHEMKIN_CFD_parameters(metaclass=PyMenuMeta): - """ - Enters the expert CHEMKIN-CFD parameters menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def basic_options(self, *args, **kwargs): - """ - Sets basic parameter options. - """ - return PyMenu(self.service, "/define/models/species/CHEMKIN_CFD_parameters/basic_options").execute(*args, **kwargs) - def advanced_options(self, *args, **kwargs): - """ - Sets advanced parameter options. - """ - return PyMenu(self.service, "/define/models/species/CHEMKIN_CFD_parameters/advanced_options").execute(*args, **kwargs) - def add_cell_monitor(self, *args, **kwargs): - """ - Monitors cell for debug output. - """ - return PyMenu(self.service, "/define/models/species/CHEMKIN_CFD_parameters/add_cell_monitor").execute(*args, **kwargs) - def list_cell_monitors(self, *args, **kwargs): - """ - Lists cell monitors. - """ - return PyMenu(self.service, "/define/models/species/CHEMKIN_CFD_parameters/list_cell_monitors").execute(*args, **kwargs) - def delete_cell_monitors(self, *args, **kwargs): - """ - Deletes cell monitors. - """ - return PyMenu(self.service, "/define/models/species/CHEMKIN_CFD_parameters/delete_cell_monitors").execute(*args, **kwargs) - - class viscous(metaclass=PyMenuMeta): - """ - Enters the viscous model menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.near_wall_treatment = self.__class__.near_wall_treatment(path + [("near_wall_treatment", None)], service) - self.multiphase_turbulence = self.__class__.multiphase_turbulence(path + [("multiphase_turbulence", None)], service) - self.turbulence_expert = self.__class__.turbulence_expert(path + [("turbulence_expert", None)], service) - self.geko_options = self.__class__.geko_options(path + [("geko_options", None)], service) - self.transition_model_options = self.__class__.transition_model_options(path + [("transition_model_options", None)], service) - def inviscid(self, *args, **kwargs): - """ - Enables/disables inviscid flow model. - """ - return PyMenu(self.service, "/define/models/viscous/inviscid").execute(*args, **kwargs) - def laminar(self, *args, **kwargs): - """ - Enables/disables laminar flow model. - """ - return PyMenu(self.service, "/define/models/viscous/laminar").execute(*args, **kwargs) - def low_pressure_boundary_slip(self, *args, **kwargs): - """ - Enables/disables the slip boundary formulation for low-pressure gas systems. - """ - return PyMenu(self.service, "/define/models/viscous/low_pressure_boundary_slip").execute(*args, **kwargs) - def mixing_length(self, *args, **kwargs): - """ - Enables/disables mixing-length (algebraic) turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/mixing_length").execute(*args, **kwargs) - def zero_equation_hvac(self, *args, **kwargs): - """ - Enables/disables zero-equation HVAC turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/zero_equation_hvac").execute(*args, **kwargs) - def spalart_allmaras(self, *args, **kwargs): - """ - Enables/disables Spalart-Allmaras turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/spalart_allmaras").execute(*args, **kwargs) - def ke1e(self, *args, **kwargs): - """ - Enable/disable the KE1E turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/ke1e").execute(*args, **kwargs) - def sa_enhanced_wall_treatment(self, *args, **kwargs): - """ - Enables/disables 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 Fluent 14. - """ - return PyMenu(self.service, "/define/models/viscous/sa_enhanced_wall_treatment").execute(*args, **kwargs) - def sa_alternate_prod(self, *args, **kwargs): - """ - Enables/disables strain/vorticity production in Spalart-Allmaras model. - """ - return PyMenu(self.service, "/define/models/viscous/sa_alternate_prod").execute(*args, **kwargs) - def sa_damping(self, *args, **kwargs): - """ - Enables/disables full low-Reynolds number form of Spalart-Allmaras model. This option is only available if your response wasno to sa-enhanced-wall-treatment?. - """ - return PyMenu(self.service, "/define/models/viscous/sa_damping").execute(*args, **kwargs) - def ke_standard(self, *args, **kwargs): - """ - Enables/disables the standard - turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/ke_standard").execute(*args, **kwargs) - def ke_easm(self, *args, **kwargs): - """ - Enables/disables the EASM - turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/ke_easm").execute(*args, **kwargs) - def ke_realizable(self, *args, **kwargs): - """ - Enables/disables the realizable - turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/ke_realizable").execute(*args, **kwargs) - def ke_rng(self, *args, **kwargs): - """ - Enables/disables the RNG - turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/ke_rng").execute(*args, **kwargs) - def rng_differential_visc(self, *args, **kwargs): - """ - Enables/disables the differential-viscosity model. - """ - return PyMenu(self.service, "/define/models/viscous/rng_differential_visc").execute(*args, **kwargs) - def rng_swirl_model(self, *args, **kwargs): - """ - Enables/disables swirl corrections for rng-model. - """ - return PyMenu(self.service, "/define/models/viscous/rng_swirl_model").execute(*args, **kwargs) - def kw_standard(self, *args, **kwargs): - """ - Enables/disables the standard - turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/kw_standard").execute(*args, **kwargs) - def kw_easm(self, *args, **kwargs): - """ - Enables/disables the EASM - turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/kw_easm").execute(*args, **kwargs) - def kw_bsl(self, *args, **kwargs): - """ - Enables/disables the baseline (BSL) - turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/kw_bsl").execute(*args, **kwargs) - def kw_geko(self, *args, **kwargs): - """ - Enables/disables the generalized - (GEKO) turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/kw_geko").execute(*args, **kwargs) - def kw_sst(self, *args, **kwargs): - """ - Enables/disables the SST - turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/kw_sst").execute(*args, **kwargs) - def kw_wj_bsl_earsm(self, *args, **kwargs): - """ - Enable/disable the EASM k-omega turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/kw_wj_bsl_earsm").execute(*args, **kwargs) - def kw_low_re_correction(self, *args, **kwargs): - """ - Enables/disables the - low Re option. - """ - return PyMenu(self.service, "/define/models/viscous/kw_low_re_correction").execute(*args, **kwargs) - def kw_shear_correction(self, *args, **kwargs): - """ - Enables/disables the - shear-flow correction option. This text command is only available for the standard - model and the stress-omega RSM model. - """ - return PyMenu(self.service, "/define/models/viscous/kw_shear_correction").execute(*args, **kwargs) - def turb_compressibility(self, *args, **kwargs): - """ - Enables/disables the compressibility correction option. - """ - return PyMenu(self.service, "/define/models/viscous/turb_compressibility").execute(*args, **kwargs) - def k_kl_w(self, *args, **kwargs): - """ - Enables/disables the k-kl- turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/k_kl_w").execute(*args, **kwargs) - def transition_sst(self, *args, **kwargs): - """ - Enables/disables the transition SST turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/transition_sst").execute(*args, **kwargs) - def v2f(self, *args, **kwargs): - """ - Enables/disables V2F turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/v2f").execute(*args, **kwargs) - def reynolds_stress_model(self, *args, **kwargs): - """ - Enables/disables the Reynolds-stress turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/reynolds_stress_model").execute(*args, **kwargs) - def rsm_solve_tke(self, *args, **kwargs): - """ - Enables/disables the solution of T.K.E. in RSM model. - """ - return PyMenu(self.service, "/define/models/viscous/rsm_solve_tke").execute(*args, **kwargs) - def rsm_wall_echo(self, *args, **kwargs): - """ - Enables/disables wall-echo effects in RSM model. - """ - return PyMenu(self.service, "/define/models/viscous/rsm_wall_echo").execute(*args, **kwargs) - def rsm_linear_pressure_strain(self, *args, **kwargs): - """ - Enables/disables the linear pressure-strain model in RSM. - """ - return PyMenu(self.service, "/define/models/viscous/rsm_linear_pressure_strain").execute(*args, **kwargs) - def rsm_ssg_pressure_strain(self, *args, **kwargs): - """ - Enables/disables quadratic pressure-strain model in RSM. - """ - return PyMenu(self.service, "/define/models/viscous/rsm_ssg_pressure_strain").execute(*args, **kwargs) - def rsm_omega_based(self, *args, **kwargs): - """ - Enables/disables the stress-omega Reynolds stress model. - """ - return PyMenu(self.service, "/define/models/viscous/rsm_omega_based").execute(*args, **kwargs) - def rsm_bsl_based(self, *args, **kwargs): - """ - Enables/disables the stress-BSL Reynolds stress model. - """ - return PyMenu(self.service, "/define/models/viscous/rsm_bsl_based").execute(*args, **kwargs) - def sas(self, *args, **kwargs): - """ - Enables/disables Scale-Adaptive Simulation (SAS) in combination with the SST - turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/sas").execute(*args, **kwargs) - def detached_eddy_simulation(self, *args, **kwargs): - """ - Enables/disables detached eddy simulation. - """ - return PyMenu(self.service, "/define/models/viscous/detached_eddy_simulation").execute(*args, **kwargs) - def des_limiter_option(self, *args, **kwargs): - """ - Selects the DES limiter option (none, F1, F2, Delayed DES, or Improved Delayed DES). - """ - return PyMenu(self.service, "/define/models/viscous/des_limiter_option").execute(*args, **kwargs) - def large_eddy_simulation(self, *args, **kwargs): - """ - Enables/disables large eddy simulation. - """ - return PyMenu(self.service, "/define/models/viscous/large_eddy_simulation").execute(*args, **kwargs) - def les_subgrid_smagorinsky(self, *args, **kwargs): - """ - Enables/disables the Smagorinsky-Lilly subgrid-scale model. - """ - return PyMenu(self.service, "/define/models/viscous/les_subgrid_smagorinsky").execute(*args, **kwargs) - def les_dynamic_energy_flux(self, *args, **kwargs): - """ - Enables/disables the dynamic sub-grid scale turbulent Prandtl Number. - """ - return PyMenu(self.service, "/define/models/viscous/les_dynamic_energy_flux").execute(*args, **kwargs) - def les_dynamic_scalar_flux(self, *args, **kwargs): - """ - Enables/disables the dynamic sub-grid scale turbulent Schmidt Number. - """ - return PyMenu(self.service, "/define/models/viscous/les_dynamic_scalar_flux").execute(*args, **kwargs) - def les_subgrid_dynamic_fvar(self, *args, **kwargs): - """ - Enables/disables the dynamic subgrid-scale mixture fraction variance model. - """ - return PyMenu(self.service, "/define/models/viscous/les_subgrid_dynamic_fvar").execute(*args, **kwargs) - def les_subgrid_rng(self, *args, **kwargs): - """ - Enable/disable the RNG subgrid-scale model. - """ - return PyMenu(self.service, "/define/models/viscous/les_subgrid_rng").execute(*args, **kwargs) - def les_subgrid_wale(self, *args, **kwargs): - """ - Enables/disables WALE subgrid-scale model. - """ - return PyMenu(self.service, "/define/models/viscous/les_subgrid_wale").execute(*args, **kwargs) - def les_subgrid_wmles(self, *args, **kwargs): - """ - Enables/disables the WMLES subgrid-scale model. - """ - return PyMenu(self.service, "/define/models/viscous/les_subgrid_wmles").execute(*args, **kwargs) - def les_subgrid_wmles_s_minus_omega(self, *args, **kwargs): - """ - Enables/disables the WMLES - subgrid-scale model. - """ - return PyMenu(self.service, "/define/models/viscous/les_subgrid_wmles_s_minus_omega").execute(*args, **kwargs) - def les_subgrid_tke(self, *args, **kwargs): - """ - Enables/disables kinetic energy transport subgrid-scale model. - """ - return PyMenu(self.service, "/define/models/viscous/les_subgrid_tke").execute(*args, **kwargs) - def turb_buoyancy_effects(self, *args, **kwargs): - """ - Enables/disables effects of buoyancy on turbulence. - """ - return PyMenu(self.service, "/define/models/viscous/turb_buoyancy_effects").execute(*args, **kwargs) - def curvature_correction(self, *args, **kwargs): - """ - Enables/disables the curvature correction. - """ - return PyMenu(self.service, "/define/models/viscous/curvature_correction").execute(*args, **kwargs) - def curvature_correction_ccurv(self, *args, **kwargs): - """ - Sets the strength of the curvature correction term. The default value is 1. This is available after the curvature-correction? option is enabled. - """ - return PyMenu(self.service, "/define/models/viscous/curvature_correction_ccurv").execute(*args, **kwargs) - def corner_flow_correction(self, *args, **kwargs): - """ - Enables/disables the corner flow correction. - """ - return PyMenu(self.service, "/define/models/viscous/corner_flow_correction").execute(*args, **kwargs) - def corner_flow_correction_ccorner(self, *args, **kwargs): - """ - Sets the strength of the quadratic term of the corner flow correction. The default value is 1. This is available after the corner-flow-correction? option is enabled. - """ - return PyMenu(self.service, "/define/models/viscous/corner_flow_correction_ccorner").execute(*args, **kwargs) - def rsm_or_earsm_geko_option(self, *args, **kwargs): - """ - Enables/disables the RSM version of the GEKO model. - """ - return PyMenu(self.service, "/define/models/viscous/rsm_or_earsm_geko_option").execute(*args, **kwargs) - def add_transition_model(self, *args, **kwargs): - """ - Sets Transition model to account for transitional effects. The default is none, however you can select gamma-algebraic or gamma-transport-eqn. After a transition model has been enabled, you have additional options in the submenu transition-model-options. - """ - return PyMenu(self.service, "/define/models/viscous/add_transition_model").execute(*args, **kwargs) - def user_defined(self, *args, **kwargs): - """ - Selects user-defined functions to define the turbulent viscosity and the turbulent Prandtl and Schmidt numbers. - """ - return PyMenu(self.service, "/define/models/viscous/user_defined").execute(*args, **kwargs) - def user_defined_transition(self, *args, **kwargs): - """ - Sets user-defined transition correlations. - """ - return PyMenu(self.service, "/define/models/viscous/user_defined_transition").execute(*args, **kwargs) - def trans_sst_roughness_correlation(self, *args, **kwargs): - """ - Enables/disables the Transition-SST roughness correlation option. - """ - return PyMenu(self.service, "/define/models/viscous/trans_sst_roughness_correlation").execute(*args, **kwargs) - - class near_wall_treatment(metaclass=PyMenuMeta): - """ - Enters the near wall treatment menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def non_equilibrium_wall_fn(self, *args, **kwargs): - """ - Enables/disables non-equilibrium wall functions. - """ - return PyMenu(self.service, "/define/models/viscous/near_wall_treatment/non_equilibrium_wall_fn").execute(*args, **kwargs) - def enhanced_wall_treatment(self, *args, **kwargs): - """ - Enables/disables enhanced wall functions. - """ - return PyMenu(self.service, "/define/models/viscous/near_wall_treatment/enhanced_wall_treatment").execute(*args, **kwargs) - def menter_lechner(self, *args, **kwargs): - """ - Enables/disables the Menter-Lechner near-wall treatment. - """ - return PyMenu(self.service, "/define/models/viscous/near_wall_treatment/menter_lechner").execute(*args, **kwargs) - def scalable_wall_functions(self, *args, **kwargs): - """ - Enables/disables scalable wall functions. - """ - return PyMenu(self.service, "/define/models/viscous/near_wall_treatment/scalable_wall_functions").execute(*args, **kwargs) - def user_defined_wall_functions(self, *args, **kwargs): - """ - Enables/disables user-defined wall functions. - """ - return PyMenu(self.service, "/define/models/viscous/near_wall_treatment/user_defined_wall_functions").execute(*args, **kwargs) - def werner_wengle_wall_fn(self, *args, **kwargs): - """ - Enables/disables Werner-Wengle wall functions. - """ - return PyMenu(self.service, "/define/models/viscous/near_wall_treatment/werner_wengle_wall_fn").execute(*args, **kwargs) - def wf_pressure_gradient_effects(self, *args, **kwargs): - """ - Enables/disables wall function pressure- gradient effects. - """ - return PyMenu(self.service, "/define/models/viscous/near_wall_treatment/wf_pressure_gradient_effects").execute(*args, **kwargs) - def wf_thermal_effects(self, *args, **kwargs): - """ - Enables/disables wall function thermal effects. - """ - return PyMenu(self.service, "/define/models/viscous/near_wall_treatment/wf_thermal_effects").execute(*args, **kwargs) - - class multiphase_turbulence(metaclass=PyMenuMeta): - """ - Enters the multiphase turbulence menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def multiphase_options(self, *args, **kwargs): - """ - Enables/disables multiphase options. - """ - return PyMenu(self.service, "/define/models/viscous/multiphase_turbulence/multiphase_options").execute(*args, **kwargs) - def turbulence_multiphase_models(self, *args, **kwargs): - """ - Selects - multiphase model. - """ - return PyMenu(self.service, "/define/models/viscous/multiphase_turbulence/turbulence_multiphase_models").execute(*args, **kwargs) - def rsm_multiphase_models(self, *args, **kwargs): - """ - Selects Reynolds Stress multiphase model. - """ - return PyMenu(self.service, "/define/models/viscous/multiphase_turbulence/rsm_multiphase_models").execute(*args, **kwargs) - def subgrid_turbulence_contribution_aiad(self, *args, **kwargs): - """ - Enable/disable the Subgrid Turbulence Contribution for the AIAD model. - """ - return PyMenu(self.service, "/define/models/viscous/multiphase_turbulence/subgrid_turbulence_contribution_aiad").execute(*args, **kwargs) - - class turbulence_expert(metaclass=PyMenuMeta): - """ - Enters the turbulence expert menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def low_re_ke(self, *args, **kwargs): - """ - Enables/disables the low-Re - turbulence model. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/low_re_ke").execute(*args, **kwargs) - def low_re_ke_index(self, *args, **kwargs): - """ - Specifies which low-Reynolds-number - model is to be used. Six models are available: - - - - - - Index - Model - - - - - 0 - Abid - - - 1 - Lam-Bremhorst - - - 2 - Launder-Sharma - - - 3 - Yang-Shih - - - 4 - Abe-Kondoh-Nagano - - - 5 - Chang-Hsieh-Chen - - - - Contact your Ansys, Inc. technical support engineer for more details. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/low_re_ke_index").execute(*args, **kwargs) - def kato_launder_model(self, *args, **kwargs): - """ - Enables/disables Kato-Launder modification. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/kato_launder_model").execute(*args, **kwargs) - def production_limiter(self, *args, **kwargs): - """ - Enables/disables Production Limiter modification. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/production_limiter").execute(*args, **kwargs) - def kw_vorticity_based_production(self, *args, **kwargs): - """ - Enables/disables vorticity-based production. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/kw_vorticity_based_production").execute(*args, **kwargs) - def kw_add_sas(self, *args, **kwargs): - """ - Enables/disables Scale-Adaptive Simulation (SAS) in combination with the currently selected -based URANS turbulence model. This text command is only available for transient cases. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/kw_add_sas").execute(*args, **kwargs) - def kw_add_des(self, *args, **kwargs): - """ - Enables/disables Detached Eddy Simulation (DES) in combination with the currently selected BSL - model or transition SST model. This text command is only available for transient cases. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/kw_add_des").execute(*args, **kwargs) - def turb_add_sbes_sdes(self, *args, **kwargs): - """ - Enables/disables the Stress-Blended Eddy Simulation (SBES) model or Shielded Detached Eddy Simulation (SDES) model. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/turb_add_sbes_sdes").execute(*args, **kwargs) - def sbes_sdes_hybrid_model(self, *args, **kwargs): - """ - Selects the hybrid model, to specify whether you want to apply the Shielded Detached Eddy Simulation (SDES) model, Stress-Blended Eddy Simulation (SBES), or SBES with a user-defined function. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/sbes_sdes_hybrid_model").execute(*args, **kwargs) - def sbes_update_interval_k_omega(self, *args, **kwargs): - """ - Sets the number of time steps between updates of the k-ω part of the SBES model. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/sbes_update_interval_k_omega").execute(*args, **kwargs) - def sbes_sgs_option(self, *args, **kwargs): - """ - Selects the subgrid-scale model for the LES portion of your Stress-Blended Eddy Simulation (SBES). - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/sbes_sgs_option").execute(*args, **kwargs) - def sbes_les_subgrid_dynamic_fvar(self, *args, **kwargs): - """ - Enable/disable the dynamic subgrid-scale mixture fraction variance model. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/sbes_les_subgrid_dynamic_fvar").execute(*args, **kwargs) - def turbulence_damping(self, *args, **kwargs): - """ - Enables/disables turbulence damping and sets turbulence damping parameters. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/turbulence_damping").execute(*args, **kwargs) - def rke_cmu_rotation_term(self, *args, **kwargs): - """ - Modifies the definition for the realizable - model. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/rke_cmu_rotation_term").execute(*args, **kwargs) - def turb_non_newtonian(self, *args, **kwargs): - """ - Enables/disables turbulence for non-Newtonian fluids. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/turb_non_newtonian").execute(*args, **kwargs) - def non_newtonian_modification(self, *args, **kwargs): - """ - Enables/disables non-Newtonian modification for Lam-Bremhorst model. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/non_newtonian_modification").execute(*args, **kwargs) - def turb_pk_compressible(self, *args, **kwargs): - """ - Enables/disables turbulent production due to compressible divergence. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/turb_pk_compressible").execute(*args, **kwargs) - def thermal_p_function(self, *args, **kwargs): - """ - Enables/disables Jayatilleke P function. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/thermal_p_function").execute(*args, **kwargs) - def restore_sst_v61(self, *args, **kwargs): - """ - Enables/disables SST formulation of v6.1. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/restore_sst_v61").execute(*args, **kwargs) - def stg_set_ti_and_tvr_limiters(self, *args, **kwargs): - """ - - Specify minimum Turbulence Intensity (TI) and Turbulent Viscosity Ratio (TVR) - to search STG scales only at inlet areas where TVR > TVR_min and TI > TI_min. - """ - return PyMenu(self.service, "/define/models/viscous/turbulence_expert/stg_set_ti_and_tvr_limiters").execute(*args, **kwargs) - - class geko_options(metaclass=PyMenuMeta): - """ - Enters the GEKO model menu.. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def wall_distance_free(self, *args, **kwargs): - """ - Enables/disables the wall distance free version of the GEKO model. - """ - return PyMenu(self.service, "/define/models/viscous/geko_options/wall_distance_free").execute(*args, **kwargs) - def csep(self, *args, **kwargs): - """ - Setscsep, the parameter to optimize flow separation from smooth surfaces. - """ - return PyMenu(self.service, "/define/models/viscous/geko_options/csep").execute(*args, **kwargs) - def cnw(self, *args, **kwargs): - """ - Setscnw, the parameter to optimize flow in non-equilibrium near wall regions. - """ - return PyMenu(self.service, "/define/models/viscous/geko_options/cnw").execute(*args, **kwargs) - def cmix(self, *args, **kwargs): - """ - Setscmix, the parameter to optimize strength of mixing in free shear flows. - """ - return PyMenu(self.service, "/define/models/viscous/geko_options/cmix").execute(*args, **kwargs) - def cjet(self, *args, **kwargs): - """ - Setscjet, the parameter to optimize free shear layer mixing (optimize free jets independent of mixing layer). - """ - return PyMenu(self.service, "/define/models/viscous/geko_options/cjet").execute(*args, **kwargs) - def blending_function(self, *args, **kwargs): - """ - Sets the blending function, which deactivatescmix and cjet inside boundary layers. - """ - return PyMenu(self.service, "/define/models/viscous/geko_options/blending_function").execute(*args, **kwargs) - def creal(self, *args, **kwargs): - """ - Setscreal, a realizability limiter that ensures positive normal stresses in the entire domain. - """ - return PyMenu(self.service, "/define/models/viscous/geko_options/creal").execute(*args, **kwargs) - def cnw_sub(self, *args, **kwargs): - """ - Setscnw_sub, which allows the adjustment of log-layer and cf. - """ - return PyMenu(self.service, "/define/models/viscous/geko_options/cnw_sub").execute(*args, **kwargs) - def cjet_aux(self, *args, **kwargs): - """ - Setscjet_aux, which allows fine-tuning of the parameter to optimize free jets. - """ - return PyMenu(self.service, "/define/models/viscous/geko_options/cjet_aux").execute(*args, **kwargs) - def cbf_lam(self, *args, **kwargs): - """ - Setscbf_lam, a part of the blending function and shields the laminar boundary layer. - """ - return PyMenu(self.service, "/define/models/viscous/geko_options/cbf_lam").execute(*args, **kwargs) - def cbf_tur(self, *args, **kwargs): - """ - Setscbf_tur, a factor for the main blending factor, controlling the thickness of the layer near walls. - """ - return PyMenu(self.service, "/define/models/viscous/geko_options/cbf_tur").execute(*args, **kwargs) - def geko_defaults(self, *args, **kwargs): - """ - Restores the defaults of all GEKO parameters. - """ - return PyMenu(self.service, "/define/models/viscous/geko_options/geko_defaults").execute(*args, **kwargs) - - class transition_model_options(metaclass=PyMenuMeta): - """ - Enters the transition model options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def crossflow_transition(self, *args, **kwargs): - """ - Enables/disables the effects of crossflow instability. - """ - return PyMenu(self.service, "/define/models/viscous/transition_model_options/crossflow_transition").execute(*args, **kwargs) - def critical_reynolds_number_correlation(self, *args, **kwargs): - """ - Sets the critical Reynolds number correlation. - """ - return PyMenu(self.service, "/define/models/viscous/transition_model_options/critical_reynolds_number_correlation").execute(*args, **kwargs) - def clambda_scale(self, *args, **kwargs): - """ - Sets the algebraic transition model coefficient CLAMBDA_SCALE. - """ - return PyMenu(self.service, "/define/models/viscous/transition_model_options/clambda_scale").execute(*args, **kwargs) - def capg_hightu(self, *args, **kwargs): - """ - Sets the algebraic transition model coefficient CAPG_HIGHTU. - """ - return PyMenu(self.service, "/define/models/viscous/transition_model_options/capg_hightu").execute(*args, **kwargs) - def cfpg_hightu(self, *args, **kwargs): - """ - Sets the algebraic transition model coefficient CFPG_HIGHTU. - """ - return PyMenu(self.service, "/define/models/viscous/transition_model_options/cfpg_hightu").execute(*args, **kwargs) - def capg_lowtu(self, *args, **kwargs): - """ - Sets the algebraic transition model coefficient CAPG_LOWTU. - """ - return PyMenu(self.service, "/define/models/viscous/transition_model_options/capg_lowtu").execute(*args, **kwargs) - def cfpg_lowtu(self, *args, **kwargs): - """ - Sets the algebraic transition model coefficient CFPG_LOWTU. - """ - return PyMenu(self.service, "/define/models/viscous/transition_model_options/cfpg_lowtu").execute(*args, **kwargs) - def ctu_hightu(self, *args, **kwargs): - """ - Sets the algebraic transition model coefficient CTU_HIGHTU. - """ - return PyMenu(self.service, "/define/models/viscous/transition_model_options/ctu_hightu").execute(*args, **kwargs) - def ctu_lowtu(self, *args, **kwargs): - """ - Sets the algebraic transition model coefficient CTU_LOWTU. - """ - return PyMenu(self.service, "/define/models/viscous/transition_model_options/ctu_lowtu").execute(*args, **kwargs) - def rec_max(self, *args, **kwargs): - """ - Sets the algebraic transition model coefficient REC_MAX. - """ - return PyMenu(self.service, "/define/models/viscous/transition_model_options/rec_max").execute(*args, **kwargs) - def rec_c1(self, *args, **kwargs): - """ - Sets the algebraic transition model coefficient REC_C1. - """ - return PyMenu(self.service, "/define/models/viscous/transition_model_options/rec_c1").execute(*args, **kwargs) - def rec_c2(self, *args, **kwargs): - """ - Sets the algebraic transition model coefficient REC_C2. - """ - return PyMenu(self.service, "/define/models/viscous/transition_model_options/rec_c2").execute(*args, **kwargs) - def cbubble_c1(self, *args, **kwargs): - """ - Sets the algebraic transition model coefficient CBUBBLE_C1. - """ - return PyMenu(self.service, "/define/models/viscous/transition_model_options/cbubble_c1").execute(*args, **kwargs) - def cbubble_c2(self, *args, **kwargs): - """ - Sets the algebraic transition model coefficient CBUBBLE_C2. - """ - return PyMenu(self.service, "/define/models/viscous/transition_model_options/cbubble_c2").execute(*args, **kwargs) - def rv1_switch(self, *args, **kwargs): - """ - Sets the algebraic transition model coefficient RV1_SWITCH. - """ - return PyMenu(self.service, "/define/models/viscous/transition_model_options/rv1_switch").execute(*args, **kwargs) - - class structure(metaclass=PyMenuMeta): - """ - Enters the structure model menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.controls = self.__class__.controls(path + [("controls", None)], service) - self.expert = self.__class__.expert(path + [("expert", None)], service) - def structure_off(self, *args, **kwargs): - """ - Disables the structural model. - """ - return PyMenu(self.service, "/define/models/structure/structure_off").execute(*args, **kwargs) - def linear_elasticity(self, *args, **kwargs): - """ - Enables the linear elasticity model. - """ - return PyMenu(self.service, "/define/models/structure/linear_elasticity").execute(*args, **kwargs) - def nonlinear_elasticity(self, *args, **kwargs): - """ - Enable the nonlinear elasticity model. - """ - return PyMenu(self.service, "/define/models/structure/nonlinear_elasticity").execute(*args, **kwargs) - def thermal_effects(self, *args, **kwargs): - """ - Enable structure thermal effects. - """ - return PyMenu(self.service, "/define/models/structure/thermal_effects").execute(*args, **kwargs) - - class controls(metaclass=PyMenuMeta): - """ - Enters the structure controls menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def numerical_damping_factor(self, *args, **kwargs): - """ - Sets the damping factor for the structural model (that is, the amplitude decay factor in in the Theory Guide). - """ - return PyMenu(self.service, "/define/models/structure/controls/numerical_damping_factor").execute(*args, **kwargs) - def enhanced_strain(self, *args, **kwargs): - """ - Enable enhanced strain element. - """ - return PyMenu(self.service, "/define/models/structure/controls/enhanced_strain").execute(*args, **kwargs) - def unsteady_damping_rayleigh(self, *args, **kwargs): - """ - Enable/disable Newmark unsteady solution model. - """ - return PyMenu(self.service, "/define/models/structure/controls/unsteady_damping_rayleigh").execute(*args, **kwargs) - def amg_stabilization(self, *args, **kwargs): - """ - Sets the algebraic multigrid (AMG) stabilization method for the structural model calculations. - """ - return PyMenu(self.service, "/define/models/structure/controls/amg_stabilization").execute(*args, **kwargs) - def max_iter(self, *args, **kwargs): - """ - Sets the maximum number of iterations for the structural model calculations. - """ - return PyMenu(self.service, "/define/models/structure/controls/max_iter").execute(*args, **kwargs) - - class expert(metaclass=PyMenuMeta): - """ - Enters the structure expert menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def include_pop_in_fsi_force(self, *args, **kwargs): - """ - Enables/disables the inclusion of operating pressure into the fluid-structure interaction force. - """ - return PyMenu(self.service, "/define/models/structure/expert/include_pop_in_fsi_force").execute(*args, **kwargs) - def steady_2way_fsi(self, *args, **kwargs): - """ - Enable steady 2-way fsi workflow. - """ - return PyMenu(self.service, "/define/models/structure/expert/steady_2way_fsi").execute(*args, **kwargs) - def include_viscous_fsi_force(self, *args, **kwargs): - """ - Enables/disables the inclusion of a viscous fluid-structure interaction force. - """ - return PyMenu(self.service, "/define/models/structure/expert/include_viscous_fsi_force").execute(*args, **kwargs) - def explicit_fsi_force(self, *args, **kwargs): - """ - Enables/disables an explicit fluid-structure interaction force. - """ - return PyMenu(self.service, "/define/models/structure/expert/explicit_fsi_force").execute(*args, **kwargs) - - class heat_exchanger(metaclass=PyMenuMeta): - """ - Enters the heat exchanger menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.macro_model = self.__class__.macro_model(path + [("macro_model", None)], service) - self.dual_cell_model = self.__class__.dual_cell_model(path + [("dual_cell_model", None)], service) - - class macro_model(metaclass=PyMenuMeta): - """ - Enters the heat macro-model menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def heat_exchanger(self, *args, **kwargs): - """ - Enables/disables heat-exchanger model. - """ - return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/heat_exchanger").execute(*args, **kwargs) - def heat_exchanger_model(self, *args, **kwargs): - """ - Defines heat-exchanger core model. - """ - return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/heat_exchanger_model").execute(*args, **kwargs) - def heat_exchanger_zone(self, *args, **kwargs): - """ - Specifies the zone that represents the heat exchanger, the dimensions of the heat exchanger, the macro grid, and the coolant direction and properties. - """ - return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/heat_exchanger_zone").execute(*args, **kwargs) - def heat_exchanger_group(self, *args, **kwargs): - """ - Defines heat-exchanger group. - """ - return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/heat_exchanger_group").execute(*args, **kwargs) - def delete_heat_exchanger_group(self, *args, **kwargs): - """ - Deletes heat-exchanger group. - """ - return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/delete_heat_exchanger_group").execute(*args, **kwargs) - def heat_exchanger_report(self, *args, **kwargs): - """ - Reports the computed values of total heat rejection, outlet temperature, and inlet temperature for a specified heat-exchanger core. - """ - return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/heat_exchanger_report").execute(*args, **kwargs) - def heat_exchanger_macro_report(self, *args, **kwargs): - """ - Reports the computed values of heat rejection, outlet temperature, and inlet temperature for the macroscopic cells (macros) in a heat exchanger. - """ - return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/heat_exchanger_macro_report").execute(*args, **kwargs) - def plot_NTU(self, *args, **kwargs): - """ - Plots NTU vs. primary mass flow rate for each auxiliary mass flow rate. - """ - return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/plot_NTU").execute(*args, **kwargs) - def write_NTU(self, *args, **kwargs): - """ - Writes NTU vs. primary mass flow rate for each auxiliary mass flow rate. - """ - return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/write_NTU").execute(*args, **kwargs) - - class dual_cell_model(metaclass=PyMenuMeta): - """ - Enters the dual cell model menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def heat_exchanger(self, *args, **kwargs): - """ - Enables/disables the dual cell heat-exchanger model. - """ - return PyMenu(self.service, "/define/models/heat_exchanger/dual_cell_model/heat_exchanger").execute(*args, **kwargs) - def add_heat_exchanger(self, *args, **kwargs): - """ - Adds heat-exchanger. - """ - return PyMenu(self.service, "/define/models/heat_exchanger/dual_cell_model/add_heat_exchanger").execute(*args, **kwargs) - def modify_heat_exchanger(self, *args, **kwargs): - """ - Modifies heat-exchanger. - """ - return PyMenu(self.service, "/define/models/heat_exchanger/dual_cell_model/modify_heat_exchanger").execute(*args, **kwargs) - def delete_heat_exchanger(self, *args, **kwargs): - """ - Deletes heat-exchanger. - """ - return PyMenu(self.service, "/define/models/heat_exchanger/dual_cell_model/delete_heat_exchanger").execute(*args, **kwargs) - def plot_NTU(self, *args, **kwargs): - """ - Plots NTU vs. primary mass flow rate for each auxiliary mass flow rate. - """ - return PyMenu(self.service, "/define/models/heat_exchanger/dual_cell_model/plot_NTU").execute(*args, **kwargs) - def write_NTU(self, *args, **kwargs): - """ - Writes NTU vs. primary mass flow rate for each auxiliary mass flow rate. - """ - return PyMenu(self.service, "/define/models/heat_exchanger/dual_cell_model/write_NTU").execute(*args, **kwargs) - def alternative_formulation(self, *args, **kwargs): - """ - Enables/disables alternative formulation for heat transfer calculations. - """ - return PyMenu(self.service, "/define/models/heat_exchanger/dual_cell_model/alternative_formulation").execute(*args, **kwargs) - - class electrolysis_setup(metaclass=PyMenuMeta): - """ - Enter the electrolysis model setup menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.anode_setup = self.__class__.anode_setup(path + [("anode_setup", None)], service) - self.cathode_setup = self.__class__.cathode_setup(path + [("cathode_setup", None)], service) - self.membrane_setup = self.__class__.membrane_setup(path + [("membrane_setup", None)], service) - def model_options(self, *args, **kwargs): - """ - Model Options. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/model_options").execute(*args, **kwargs) - def parameters(self, *args, **kwargs): - """ - Model Parameters. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/parameters").execute(*args, **kwargs) - def electrical_tabs_setup(self, *args, **kwargs): - """ - Electrical Tabs Setup. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/electrical_tabs_setup").execute(*args, **kwargs) - - class anode_setup(metaclass=PyMenuMeta): - """ - Anode Setup. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def current_collector(self, *args, **kwargs): - """ - Set Current Collector. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/anode_setup/current_collector").execute(*args, **kwargs) - def flow_channel(self, *args, **kwargs): - """ - Set Flow Channel. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/anode_setup/flow_channel").execute(*args, **kwargs) - def porous_layer(self, *args, **kwargs): - """ - Set Porous Layer. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/anode_setup/porous_layer").execute(*args, **kwargs) - def catalyst_layer(self, *args, **kwargs): - """ - Set Catalyst Layer. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/anode_setup/catalyst_layer").execute(*args, **kwargs) - def electrolyte(self, *args, **kwargs): - """ - Set Electrolyte. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/anode_setup/electrolyte").execute(*args, **kwargs) - - class cathode_setup(metaclass=PyMenuMeta): - """ - Cathode Setup. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def current_collector(self, *args, **kwargs): - """ - Set Current Collector. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/cathode_setup/current_collector").execute(*args, **kwargs) - def flow_channel(self, *args, **kwargs): - """ - Set Flow Channel. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/cathode_setup/flow_channel").execute(*args, **kwargs) - def porous_layer(self, *args, **kwargs): - """ - Set Porous Layer. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/cathode_setup/porous_layer").execute(*args, **kwargs) - def catalyst_layer(self, *args, **kwargs): - """ - Set Catalyst Layer. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/cathode_setup/catalyst_layer").execute(*args, **kwargs) - def electrolyte(self, *args, **kwargs): - """ - Set Electrolyte. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/cathode_setup/electrolyte").execute(*args, **kwargs) - - class membrane_setup(metaclass=PyMenuMeta): - """ - Membrane Setup. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def current_collector(self, *args, **kwargs): - """ - Set Current Collector. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/membrane_setup/current_collector").execute(*args, **kwargs) - def flow_channel(self, *args, **kwargs): - """ - Set Flow Channel. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/membrane_setup/flow_channel").execute(*args, **kwargs) - def porous_layer(self, *args, **kwargs): - """ - Set Porous Layer. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/membrane_setup/porous_layer").execute(*args, **kwargs) - def catalyst_layer(self, *args, **kwargs): - """ - Set Catalyst Layer. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/membrane_setup/catalyst_layer").execute(*args, **kwargs) - def electrolyte(self, *args, **kwargs): - """ - Set Electrolyte. - """ - return PyMenu(self.service, "/define/models/electrolysis_setup/membrane_setup/electrolyte").execute(*args, **kwargs) - - class overset_interfaces(metaclass=PyMenuMeta): - """ - Enters the overset interfaces menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.options = self.__class__.options(path + [("options", None)], service) - self.cut_control = self.__class__.cut_control(path + [("cut_control", None)], service) - self.adapt = self.__class__.adapt(path + [("adapt", None)], service) - def create(self, *args, **kwargs): - """ - Creates an overset interface. - """ - return PyMenu(self.service, "/define/overset_interfaces/create").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes an overset interface. - """ - return PyMenu(self.service, "/define/overset_interfaces/delete").execute(*args, **kwargs) - def delete_all(self, *args, **kwargs): - """ - Deletes all overset interfaces in the domain. - """ - return PyMenu(self.service, "/define/overset_interfaces/delete_all").execute(*args, **kwargs) - def intersect(self, *args, **kwargs): - """ - Executes the hole cutting of an overset interface and establishes the domain connectivity. This text command is only available when define/overset-interfaces/options/expert? is set to yes. - """ - return PyMenu(self.service, "/define/overset_interfaces/intersect").execute(*args, **kwargs) - def intersect_all(self, *args, **kwargs): - """ - Executes hole cutting for all overset interfaces in the domain. This text command is only available when define/overset-interfaces/options/expert? is set to yes. - """ - return PyMenu(self.service, "/define/overset_interfaces/intersect_all").execute(*args, **kwargs) - def clear(self, *args, **kwargs): - """ - Clears the domain connectivity of an overset interface. This text command is only available when define/overset-interfaces/options/expert? is set to yes. - """ - return PyMenu(self.service, "/define/overset_interfaces/clear").execute(*args, **kwargs) - def clear_all(self, *args, **kwargs): - """ - Clears the domain connectivity of all overset interfaces. This text command is only available when define/overset-interfaces/options/expert? is set to yes. - """ - return PyMenu(self.service, "/define/overset_interfaces/clear_all").execute(*args, **kwargs) - def grid_priorities(self, *args, **kwargs): - """ - Allows you to specify grid priorities on background and component meshes, used in the overlap minimization of an overset interface. - """ - return PyMenu(self.service, "/define/overset_interfaces/grid_priorities").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Lists information about the overset interfaces. The output depends on the overset verbosity setting. - """ - return PyMenu(self.service, "/define/overset_interfaces/list").execute(*args, **kwargs) - def mark_cells(self, *args, **kwargs): - """ - Marks the specified overset cells (solve, receptor, donor, orphan, or dead) and fills registers based on the markings. Display the marked cells via the text command define/overset-interfaces/display-cells. - """ - return PyMenu(self.service, "/define/overset_interfaces/mark_cells").execute(*args, **kwargs) - def display_cells(self, *args, **kwargs): - """ - Displays the overset cells marked using the text command define/overset-interfaces/mark-cells. - """ - return PyMenu(self.service, "/define/overset_interfaces/display_cells").execute(*args, **kwargs) - def mark_cell_change(self, *args, **kwargs): - """ - Marks cells that have undergone a specified overset cell type change (from solve,receptor, or dead to any other type) in the last time step. Adaption registers are automatically filled based on these markings. This text command is only available for unsteady simulations and if define/overset-interfaces/options/expert? is set to yes. - """ - return PyMenu(self.service, "/define/overset_interfaces/mark_cell_change").execute(*args, **kwargs) - def set_mark_bounds(self, *args, **kwargs): - """ - Allows you to set bounds so that any marking of cells is performed within a spherical region based on a specified origin and radius. This can be useful when diagnosing a local problem on a large mesh. This text command is only available if define/overset-interfaces/options/expert? is set to yes. After defining the bounds, you can then mark the cells using the define/overset-interfaces/mark-cell-change or define/overset-interfaces/mark-cells text command. To disable the bounds, enter a radius of 0. - """ - return PyMenu(self.service, "/define/overset_interfaces/set_mark_bounds").execute(*args, **kwargs) - def check(self, *args, **kwargs): - """ - Checks the integrity of the overset interfaces. Reports orphan cells and errors in the domain connectivity. - """ - return PyMenu(self.service, "/define/overset_interfaces/check").execute(*args, **kwargs) - def debug_hole_cut(self, *args, **kwargs): - """ - Debugging tool to troubleshoot hole cutting of overset interfaces. This text command is only available when define/overset-interfaces/options/expert? is set to yes. - """ - return PyMenu(self.service, "/define/overset_interfaces/debug_hole_cut").execute(*args, **kwargs) - def fill_dci(self, *args, **kwargs): - """ - Fill overset domain connectivity information (DCI). - """ - return PyMenu(self.service, "/define/overset_interfaces/fill_dci").execute(*args, **kwargs) - def free_dci(self, *args, **kwargs): - """ - Free overset domain connectivity information (DCI). - """ - return PyMenu(self.service, "/define/overset_interfaces/free_dci").execute(*args, **kwargs) - def update_from_dci(self, *args, **kwargs): - """ - Update all overset intrfaces from stored domain connectivity information (DCI). - """ - return PyMenu(self.service, "/define/overset_interfaces/update_from_dci").execute(*args, **kwargs) - def write_dci_to_case(self, *args, **kwargs): - """ - Save domain connectivity information (DCI) to case file. - """ - return PyMenu(self.service, "/define/overset_interfaces/write_dci_to_case").execute(*args, **kwargs) - def read_dci_from_case(self, *args, **kwargs): - """ - Read domain connectivity information (DCI) from case file. - """ - return PyMenu(self.service, "/define/overset_interfaces/read_dci_from_case").execute(*args, **kwargs) - def write_dci(self, *args, **kwargs): - """ - Save domain connectivity information (DCI) to a text file. - """ - return PyMenu(self.service, "/define/overset_interfaces/write_dci").execute(*args, **kwargs) - def write_cell_types(self, *args, **kwargs): - """ - Write overset cell types into file. - """ - return PyMenu(self.service, "/define/overset_interfaces/write_cell_types").execute(*args, **kwargs) - def find_bounding_cell(self, *args, **kwargs): - """ - Find bounding cell for given cell or search point. - """ - return PyMenu(self.service, "/define/overset_interfaces/find_bounding_cell").execute(*args, **kwargs) - def find_all_bounding_cells(self, *args, **kwargs): - """ - Find bounding cells for all cell centroids. - """ - return PyMenu(self.service, "/define/overset_interfaces/find_all_bounding_cells").execute(*args, **kwargs) - - class options(metaclass=PyMenuMeta): - """ - Enters the overset interface options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def expert(self, *args, **kwargs): - """ - Enables / disables overset-related expert tools. - """ - return PyMenu(self.service, "/define/overset_interfaces/options/expert").execute(*args, **kwargs) - def render_receptor_cells(self, *args, **kwargs): - """ - Allows you to enable visualization of receptor cells in contour and mesh displays. - """ - return PyMenu(self.service, "/define/overset_interfaces/options/render_receptor_cells").execute(*args, **kwargs) - def partial_cut_faces(self, *args, **kwargs): - """ - Enables/disables enhanced hole cutting, where partially overlapping cut faces are decomposed into overlapping and non-overlapping fractions, and only the non-overlapping fractions participate in the hole cutting. This can help avoid the situation where a region or cell zone is erroneously identified as dead because of leakage during flood filling, even though it has overlapping boundaries that match well. When this text command is disabled, the partially overlapping faces are entirely protected from cutting. - """ - return PyMenu(self.service, "/define/overset_interfaces/options/partial_cut_faces").execute(*args, **kwargs) - def auto_create(self, *args, **kwargs): - """ - Enables the automatic creation of a default overset interface during initialization or mesh motion update. - """ - return PyMenu(self.service, "/define/overset_interfaces/options/auto_create").execute(*args, **kwargs) - def minimize_overlap(self, *args, **kwargs): - """ - Allows you to disable overlap minimization during hole cutting. - """ - return PyMenu(self.service, "/define/overset_interfaces/options/minimize_overlap").execute(*args, **kwargs) - def overlap_boundaries(self, *args, **kwargs): - """ - Allows you to disable the detection of overlapping boundaries during hole cutting, in order to reduce the computational expense for cases that do not include such boundaries. When enabled, this text command also allows you to specify which boundary zones should be considered when detecting overlapping boundaries; this can be helpful when the default hole cutting process fails. - """ - return PyMenu(self.service, "/define/overset_interfaces/options/overlap_boundaries").execute(*args, **kwargs) - def mesh_interfaces(self, *args, **kwargs): - """ - Allows the inclusion of non-conformal mesh interfaces inside overset cell zones, as long as the mesh interfaces do not spatially overlap with the cells where the overset interfaces lie. - """ - return PyMenu(self.service, "/define/overset_interfaces/options/mesh_interfaces").execute(*args, **kwargs) - def node_connected_donors(self, *args, **kwargs): - """ - Allows you to switch between face or node connected donor cells. This text command is only available when define/overset-interfaces/options/expert? is set to yes. - """ - return PyMenu(self.service, "/define/overset_interfaces/options/node_connected_donors").execute(*args, **kwargs) - def donor_priority_method(self, *args, **kwargs): - """ - Allows you to specify whether the cell donor priority used in the overlap minimization of an overset interface is inversely proportional to either the cell size or the distance to the nearest boundary. - """ - return PyMenu(self.service, "/define/overset_interfaces/options/donor_priority_method").execute(*args, **kwargs) - def solve_island_removal(self, *args, **kwargs): - """ - Sets the method used to control the removal of isolated patches of solve cells. This text command is only available when define/overset-interfaces/options/expert? is set to yes. - """ - return PyMenu(self.service, "/define/overset_interfaces/options/solve_island_removal").execute(*args, **kwargs) - def transient_caching(self, *args, **kwargs): - """ - Sets the options to control caching of entities in transient overset simulations. This text command is only available when define/overset-interfaces/options/expert? is set to yes. - """ - return PyMenu(self.service, "/define/overset_interfaces/options/transient_caching").execute(*args, **kwargs) - def modified_donor_search(self, *args, **kwargs): - """ - Enables / disables modified donor search parameters. When enabled, these parameters result in a more extended donor search, which can be helpful for meshes with orphans. This text command is only available when define/overset-interfaces/options/expert? is set to yes. - """ - return PyMenu(self.service, "/define/overset_interfaces/options/modified_donor_search").execute(*args, **kwargs) - def modified_hole_cutting(self, *args, **kwargs): - """ - Enables / disables modified hole cutting parameters. When enabled, the parameters used can help avoid dead cell zones that result from a hole cutting failure. This text command is only available when define/overset-interfaces/options/expert? is set to yes. - """ - return PyMenu(self.service, "/define/overset_interfaces/options/modified_hole_cutting").execute(*args, **kwargs) - def dead_cell_update(self, *args, **kwargs): - """ - Enables/disables the updating of dead cells during the solution process, which may be helpful for some moving and dynamic mesh simulations (though at the cost of solver performance). You can enter the number of layers of dead cells adjacent to the receptor cells that you want updated, or enter -1 to request that all dead cells are updated. This text command is only available for transient simulations when define/overset-interfaces/options/expert? is set to yes. - """ - return PyMenu(self.service, "/define/overset_interfaces/options/dead_cell_update").execute(*args, **kwargs) - def update_before_case_write(self, *args, **kwargs): - """ - Enables/disables the updating of the overset interfaces before writing a case file in the Common Fluids Format (CFF). This text command is only available when define/overset-interfaces/options/expert? is set to yes. - """ - return PyMenu(self.service, "/define/overset_interfaces/options/update_before_case_write").execute(*args, **kwargs) - def parallel(self, *args, **kwargs): - """ - Allows you to select the algorithm used for overset parallel processing. You can select from the default cell exchange model or the local cell zone replication model; the cell exchange model should require less memory and may result in faster calculations. - """ - return PyMenu(self.service, "/define/overset_interfaces/options/parallel").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Specifies the level of detail printed in the console about overset interfaces. - """ - return PyMenu(self.service, "/define/overset_interfaces/options/verbosity").execute(*args, **kwargs) - - class cut_control(metaclass=PyMenuMeta): - """ - Enters the overset hole cut control menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.cut_seeds = self.__class__.cut_seeds(path + [("cut_seeds", None)], service) - def add(self, *args, **kwargs): - """ - Adds a hole cut control, so that a boundary zone does not cut specified cell zones. - """ - return PyMenu(self.service, "/define/overset_interfaces/cut_control/add").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes the hole cut control for a boundary zone. - """ - return PyMenu(self.service, "/define/overset_interfaces/cut_control/delete").execute(*args, **kwargs) - def delete_all(self, *args, **kwargs): - """ - Deletes the hole cut controls for all boundary zones. - """ - return PyMenu(self.service, "/define/overset_interfaces/cut_control/delete_all").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Lists the defined hole cut controls. - """ - return PyMenu(self.service, "/define/overset_interfaces/cut_control/list").execute(*args, **kwargs) - - class cut_seeds(metaclass=PyMenuMeta): - """ - Enters the overset hole cut seeds menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def add(self, *args, **kwargs): - """ - Add a hole cut seed. - """ - return PyMenu(self.service, "/define/overset_interfaces/cut_control/cut_seeds/add").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Delete a hole cut seed. - """ - return PyMenu(self.service, "/define/overset_interfaces/cut_control/cut_seeds/delete").execute(*args, **kwargs) - def delete_all(self, *args, **kwargs): - """ - Delete all hole cut seeds. - """ - return PyMenu(self.service, "/define/overset_interfaces/cut_control/cut_seeds/delete_all").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - List the defined hole cut seeds. - """ - return PyMenu(self.service, "/define/overset_interfaces/cut_control/cut_seeds/list").execute(*args, **kwargs) - def cut_seeds_for_all_component_zones(self, *args, **kwargs): - """ - Specifies whether all component zones get cut seeds, which cut pilot holes into the overlapping meshes that will then be enlarged during overlap minimization. - """ - return PyMenu(self.service, "/define/overset_interfaces/cut_control/cut_seeds/cut_seeds_for_all_component_zones").execute(*args, **kwargs) - - class adapt(metaclass=PyMenuMeta): - """ - Enters the overset adaption menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.set = self.__class__.set(path + [("set", None)], service) - def mark_adaption(self, *args, **kwargs): - """ - Marks cells to identify those that can be adapted in order to improve your overset mesh. - """ - return PyMenu(self.service, "/define/overset_interfaces/adapt/mark_adaption").execute(*args, **kwargs) - def adapt_mesh(self, *args, **kwargs): - """ - Marks and adapts the mesh to improve your overset mesh. - """ - return PyMenu(self.service, "/define/overset_interfaces/adapt/adapt_mesh").execute(*args, **kwargs) - - class set(metaclass=PyMenuMeta): - """ - Enters the overset adaption set menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def mark_orphans(self, *args, **kwargs): - """ - Enables/disables the option to adapt for orphan reduction. - """ - return PyMenu(self.service, "/define/overset_interfaces/adapt/set/mark_orphans").execute(*args, **kwargs) - def mark_fixed_orphans(self, *args, **kwargs): - """ - Enables/disables the option to also adapt based on cells that are not actual orphans because they were fixed by accepting neighbor donors. This option is only applied if define/overset-interfaces/adapt/set/mark-orphans? is enabled. - """ - return PyMenu(self.service, "/define/overset_interfaces/adapt/set/mark_fixed_orphans").execute(*args, **kwargs) - def mark_size(self, *args, **kwargs): - """ - Enables/disables the option to adapt based on donor-receptor cell size differences. - """ - return PyMenu(self.service, "/define/overset_interfaces/adapt/set/mark_size").execute(*args, **kwargs) - def mark_gaps(self, *args, **kwargs): - """ - Enable the option to adapt underresolved gaps. - """ - return PyMenu(self.service, "/define/overset_interfaces/adapt/set/mark_gaps").execute(*args, **kwargs) - def mark_coarsening(self, *args, **kwargs): - """ - Enables/disables the option to coarsen the mesh if mesh refinement is no longer needed. This option is enabled by default. - """ - return PyMenu(self.service, "/define/overset_interfaces/adapt/set/mark_coarsening").execute(*args, **kwargs) - def anisotropic(self, *args, **kwargs): - """ - Enable the option to use anisotropic adaption in prismatic cells. - """ - return PyMenu(self.service, "/define/overset_interfaces/adapt/set/anisotropic").execute(*args, **kwargs) - def automatic(self, *args, **kwargs): - """ - Enable the option to automatically adapt overset meshes during solution update. - """ - return PyMenu(self.service, "/define/overset_interfaces/adapt/set/automatic").execute(*args, **kwargs) - def length_ratio_max(self, *args, **kwargs): - """ - Sets the length scale ratio threshold used to determine which cells are marked for adaption based on donor-receptor cell size differences. - """ - return PyMenu(self.service, "/define/overset_interfaces/adapt/set/length_ratio_max").execute(*args, **kwargs) - def buffer_layers(self, *args, **kwargs): - """ - Sets the number of cell layers marked in addition to the cells marked for orphan adaption. - """ - return PyMenu(self.service, "/define/overset_interfaces/adapt/set/buffer_layers").execute(*args, **kwargs) - def adaption_sweeps(self, *args, **kwargs): - """ - Sets the number of rounds of adaption applied during each adaption cycle. - """ - return PyMenu(self.service, "/define/overset_interfaces/adapt/set/adaption_sweeps").execute(*args, **kwargs) - def maximum_refinement_level(self, *args, **kwargs): - """ - Sets the maximum level of refinement during overset adaption, in conjunction with the value set using the mesh/adapt/set/maximum-refinement-level text command (the larger of the two values is used). - """ - return PyMenu(self.service, "/define/overset_interfaces/adapt/set/maximum_refinement_level").execute(*args, **kwargs) - - class operating_conditions(metaclass=PyMenuMeta): - """ - Enters the define operating conditions menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def gravity(self, *args, **kwargs): - """ - Sets gravitational acceleration. - """ - return PyMenu(self.service, "/define/operating_conditions/gravity").execute(*args, **kwargs) - def gravity_mrf_rotation(self, *args, **kwargs): - """ - Enables/disables rotation of gravity vector in moving reference frame simulations. If enabled, the gravity vector will rotate with respect to the moving reference frame such that the direction of gravity in global coordinates remains fixed. - """ - return PyMenu(self.service, "/define/operating_conditions/gravity_mrf_rotation").execute(*args, **kwargs) - def set_state(self, *args, **kwargs): - """ - Selects state for real gas EOS subcritical condition. - """ - return PyMenu(self.service, "/define/operating_conditions/set_state").execute(*args, **kwargs) - def operating_pressure(self, *args, **kwargs): - """ - Sets the operating pressure. - """ - return PyMenu(self.service, "/define/operating_conditions/operating_pressure").execute(*args, **kwargs) - def reference_pressure_location(self, *args, **kwargs): - """ - Sets a location that determines the reference pressure cell or cells (depending on the selected reference pressure method). The pressure value in such cells can be used to adjust the gauge pressure field after each iteration to keep it from floating. - """ - return PyMenu(self.service, "/define/operating_conditions/reference_pressure_location").execute(*args, **kwargs) - def reference_pressure_method(self, *args, **kwargs): - """ - Specifies the method used for adjusting the gauge pressure field after each iteration to keep it from floating: the method can assume that all of the cell zones are connected by internal boundary zones (such as interior zones), or can account for connected and disconnected cell zones. Such adjustment is only allowed for incompressible flows, and will be limited partially or entirely by the presence of a pressure boundary. - """ - return PyMenu(self.service, "/define/operating_conditions/reference_pressure_method").execute(*args, **kwargs) - def used_ref_pressure_location(self, *args, **kwargs): - """ - Prints the coordinates of the reference pressure cell or cells (depending on the selected reference pressure method). The pressure value in such cells can be used to adjust the gauge pressure field after each iteration to keep it from floating. - """ - return PyMenu(self.service, "/define/operating_conditions/used_ref_pressure_location").execute(*args, **kwargs) - def operating_density(self, *args, **kwargs): - """ - Enable/disable use of a specified operating density. - """ - return PyMenu(self.service, "/define/operating_conditions/operating_density").execute(*args, **kwargs) - def use_inlet_temperature_for_operating_density(self, *args, **kwargs): - """ - Uses inlet temperature to calculate operating density. - """ - return PyMenu(self.service, "/define/operating_conditions/use_inlet_temperature_for_operating_density").execute(*args, **kwargs) - def operating_temperature(self, *args, **kwargs): - """ - Sets the operating temperature for Boussinesq. - """ - return PyMenu(self.service, "/define/operating_conditions/operating_temperature").execute(*args, **kwargs) - - class parameters(metaclass=PyMenuMeta): - """ - Enters the parameters menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.input_parameters = self.__class__.input_parameters(path + [("input_parameters", None)], service) - self.output_parameters = self.__class__.output_parameters(path + [("output_parameters", None)], service) - self.list_parameters = self.__class__.list_parameters(path + [("list_parameters", None)], service) - def enable_in_TUI(self, *args, **kwargs): - """ - Enables/disables parameters in the text user interface. - """ - return PyMenu(self.service, "/define/parameters/enable_in_TUI").execute(*args, **kwargs) - - class input_parameters(metaclass=PyMenuMeta): - """ - Enters the input-parameters menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.advance = self.__class__.advance(path + [("advance", None)], service) - def edit(self, *args, **kwargs): - """ - Edits an input parameter. - """ - return PyMenu(self.service, "/define/parameters/input_parameters/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes an input parameter. - """ - return PyMenu(self.service, "/define/parameters/input_parameters/delete").execute(*args, **kwargs) - - class advance(metaclass=PyMenuMeta): - """ - Define custom variable to use input parameter. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def use_in(self, *args, **kwargs): - """ - Use input parameter in solver-udf or in scheme-procedure. - """ - return PyMenu(self.service, "/define/parameters/input_parameters/advance/use_in").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - List of custom-input-parameters. - """ - return PyMenu(self.service, "/define/parameters/input_parameters/advance/list").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Delete selected custom-input-parameters. - """ - return PyMenu(self.service, "/define/parameters/input_parameters/advance/delete").execute(*args, **kwargs) - - class output_parameters(metaclass=PyMenuMeta): - """ - Enters the output-parameters menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def create(self, *args, **kwargs): - """ - Creates an output parameter. - """ - return PyMenu(self.service, "/define/parameters/output_parameters/create").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edits an output parameter. - """ - return PyMenu(self.service, "/define/parameters/output_parameters/edit").execute(*args, **kwargs) - def rename(self, *args, **kwargs): - """ - Renames an output parameter. - """ - return PyMenu(self.service, "/define/parameters/output_parameters/rename").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes an output parameter. - """ - return PyMenu(self.service, "/define/parameters/output_parameters/delete").execute(*args, **kwargs) - def print_to_console(self, *args, **kwargs): - """ - Displays parameter value in the console. - """ - return PyMenu(self.service, "/define/parameters/output_parameters/print_to_console").execute(*args, **kwargs) - def print_all_to_console(self, *args, **kwargs): - """ - Displays all parameter values in the console. - """ - return PyMenu(self.service, "/define/parameters/output_parameters/print_all_to_console").execute(*args, **kwargs) - def write_to_file(self, *args, **kwargs): - """ - Writes parameter value to file. - """ - return PyMenu(self.service, "/define/parameters/output_parameters/write_to_file").execute(*args, **kwargs) - def write_all_to_file(self, *args, **kwargs): - """ - Writes all parameter values to file. - """ - return PyMenu(self.service, "/define/parameters/output_parameters/write_all_to_file").execute(*args, **kwargs) - - class list_parameters(metaclass=PyMenuMeta): - """ - Enter list-param menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def input_parameters(self, *args, **kwargs): - """ - List all input parameters. - """ - return PyMenu(self.service, "/define/parameters/list_parameters/input_parameters").execute(*args, **kwargs) - def output_parameters(self, *args, **kwargs): - """ - List all output parameters. - """ - return PyMenu(self.service, "/define/parameters/list_parameters/output_parameters").execute(*args, **kwargs) - - class periodic_conditions(metaclass=PyMenuMeta): - """ - Enters the periodic conditions menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def massflow_rate_specification(self, *args, **kwargs): - """ - Enables/disables specification of mass flow rate at the periodic boundary. - """ - return PyMenu(self.service, "/define/periodic_conditions/massflow_rate_specification").execute(*args, **kwargs) - def pressure_gradient_specification(self, *args, **kwargs): - """ - Enables/disables specification of pressure gradient at the periodic boundary. - """ - return PyMenu(self.service, "/define/periodic_conditions/pressure_gradient_specification").execute(*args, **kwargs) - - class turbo_model(metaclass=PyMenuMeta): - """ - Enters the turbo menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.turbo_topology = self.__class__.turbo_topology(path + [("turbo_topology", None)], service) - self.general_turbo_interface_settings = self.__class__.general_turbo_interface_settings(path + [("general_turbo_interface_settings", None)], service) - self.blade_flutter_harmonics = self.__class__.blade_flutter_harmonics(path + [("blade_flutter_harmonics", None)], service) - def enable_turbo_model(self, *args, **kwargs): - """ - Enables/disables turbo model menu. - """ - return PyMenu(self.service, "/define/turbo_model/enable_turbo_model").execute(*args, **kwargs) - def separate_nonoverlapping_interface_boundary(self, *args, **kwargs): - """ - Split a general turbo interface non-overlapping zone. - """ - return PyMenu(self.service, "/define/turbo_model/separate_nonoverlapping_interface_boundary").execute(*args, **kwargs) - def turbo_create(self, *args, **kwargs): - """ - Creates a general turbo interface. - """ - return PyMenu(self.service, "/define/turbo_model/turbo_create").execute(*args, **kwargs) - def number_of_blades_in_row(self, *args, **kwargs): - """ - Defines the number of blades in the turbo machine, used for calculating interblade phase angle. - """ - return PyMenu(self.service, "/define/turbo_model/number_of_blades_in_row").execute(*args, **kwargs) - def create_turbomachine_description(self, *args, **kwargs): - """ - Define turbomachine description. - """ - return PyMenu(self.service, "/define/turbo_model/create_turbomachine_description").execute(*args, **kwargs) - def create_phaselag_spectral_content(self, *args, **kwargs): - """ - Define phaselag related spectral content. - """ - return PyMenu(self.service, "/define/turbo_model/create_phaselag_spectral_content").execute(*args, **kwargs) - def phaselag_extra_settings(self, *args, **kwargs): - """ - Define phaselag related extra settings. - """ - return PyMenu(self.service, "/define/turbo_model/phaselag_extra_settings").execute(*args, **kwargs) - def create_graphics_spectral_content(self, *args, **kwargs): - """ - Define post-processing related spectral content. - """ - return PyMenu(self.service, "/define/turbo_model/create_graphics_spectral_content").execute(*args, **kwargs) - def graphics_extra_settings(self, *args, **kwargs): - """ - Define phaselag related extra settings. - """ - return PyMenu(self.service, "/define/turbo_model/graphics_extra_settings").execute(*args, **kwargs) - def delete_turbomachine_description(self, *args, **kwargs): - """ - Delete turbomachine description. - """ - return PyMenu(self.service, "/define/turbo_model/delete_turbomachine_description").execute(*args, **kwargs) - def delete_phaselag_spectral_content(self, *args, **kwargs): - """ - Delete phaselag related spectral content. - """ - return PyMenu(self.service, "/define/turbo_model/delete_phaselag_spectral_content").execute(*args, **kwargs) - def delete_graphics_spectral_content(self, *args, **kwargs): - """ - Delete post-processing related spectral content. - """ - return PyMenu(self.service, "/define/turbo_model/delete_graphics_spectral_content").execute(*args, **kwargs) - def list_turbomachine_description(self, *args, **kwargs): - """ - List turbomachine description. - """ - return PyMenu(self.service, "/define/turbo_model/list_turbomachine_description").execute(*args, **kwargs) - def list_graphics_spectral_content(self, *args, **kwargs): - """ - List post-processing related spectral content. - """ - return PyMenu(self.service, "/define/turbo_model/list_graphics_spectral_content").execute(*args, **kwargs) - def list_phaselag_state(self, *args, **kwargs): - """ - List all phaselag related case settings. - """ - return PyMenu(self.service, "/define/turbo_model/list_phaselag_state").execute(*args, **kwargs) - def make_phaselag_from_boundaries(self, *args, **kwargs): - """ - Make interface zones phase lagged. - """ - return PyMenu(self.service, "/define/turbo_model/make_phaselag_from_boundaries").execute(*args, **kwargs) - def make_phaselag_from_periodic(self, *args, **kwargs): - """ - Convert periodic interface to phase lagged. - """ - return PyMenu(self.service, "/define/turbo_model/make_phaselag_from_periodic").execute(*args, **kwargs) - - class turbo_topology(metaclass=PyMenuMeta): - """ - Enters the turbo topology menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def define_topology(self, *args, **kwargs): - """ - Defines a turbo topology. - """ - return PyMenu(self.service, "/define/turbo_model/turbo_topology/define_topology").execute(*args, **kwargs) - def mesh_method(self, *args, **kwargs): - """ - Sets turbo structured mesh generation method. - """ - return PyMenu(self.service, "/define/turbo_model/turbo_topology/mesh_method").execute(*args, **kwargs) - def search_method(self, *args, **kwargs): - """ - Sets search method for a topology. - """ - return PyMenu(self.service, "/define/turbo_model/turbo_topology/search_method").execute(*args, **kwargs) - def projection_method(self, *args, **kwargs): - """ - Sets 2D projection method. - """ - return PyMenu(self.service, "/define/turbo_model/turbo_topology/projection_method").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes a previously created turbo topology. - """ - return PyMenu(self.service, "/define/turbo_model/turbo_topology/delete").execute(*args, **kwargs) - - class general_turbo_interface_settings(metaclass=PyMenuMeta): - """ - Enters the General Turbo Interface options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.mixing_plane_model_settings = self.__class__.mixing_plane_model_settings(path + [("mixing_plane_model_settings", None)], service) - self.pitch_scale_model_settings = self.__class__.pitch_scale_model_settings(path + [("pitch_scale_model_settings", None)], service) - self.no_pitch_scale_model_settings = self.__class__.no_pitch_scale_model_settings(path + [("no_pitch_scale_model_settings", None)], service) - self.expert = self.__class__.expert(path + [("expert", None)], service) - - class mixing_plane_model_settings(metaclass=PyMenuMeta): - """ - Defines settings for the mixing plane model. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.number_of_bands = self.__class__.number_of_bands(path + [("number_of_bands", None)], service) - def averaging_method(self, *args, **kwargs): - """ - Set the averaging method for the mixing. - """ - return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/mixing_plane_model_settings/averaging_method").execute(*args, **kwargs) - def mixing_set_constraint(self, *args, **kwargs): - """ - To set the mixing of primitive or total variable approach. - """ - return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/mixing_plane_model_settings/mixing_set_constraint").execute(*args, **kwargs) - def bands_type(self, *args, **kwargs): - """ - Specifies the averaging bands for mixing as fixed or variable width. - """ - return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/mixing_plane_model_settings/bands_type").execute(*args, **kwargs) - def number_of_inner_iterations(self, *args, **kwargs): - """ - Sets the number of iterations used in averaging. - """ - return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/mixing_plane_model_settings/number_of_inner_iterations").execute(*args, **kwargs) - def list_mixing_planes(self, *args, **kwargs): - """ - List the settings of mixing planes in the case. - """ - return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/mixing_plane_model_settings/list_mixing_planes").execute(*args, **kwargs) - - class number_of_bands(metaclass=PyMenuMeta): - """ - Sets the number of bands to be used for mixing. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def set_specific_interface(self, *args, **kwargs): - """ - Set number of band to be used for mixing. - """ - return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/mixing_plane_model_settings/number_of_bands/set_specific_interface").execute(*args, **kwargs) - def set_all_interfaces(self, *args, **kwargs): - """ - Set number of band to be used for mixing. - """ - return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/mixing_plane_model_settings/number_of_bands/set_all_interfaces").execute(*args, **kwargs) - - class pitch_scale_model_settings(metaclass=PyMenuMeta): - """ - Defines settings for the pitch-scale model. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def scale_mflux(self, *args, **kwargs): - """ - Scales mass flux to improve conservation. - """ - return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/pitch_scale_model_settings/scale_mflux").execute(*args, **kwargs) - - class no_pitch_scale_model_settings(metaclass=PyMenuMeta): - """ - Defines settings for the no pitch-scale model. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def scale_mflux(self, *args, **kwargs): - """ - Scales mass flux to improve conservation. - """ - return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/no_pitch_scale_model_settings/scale_mflux").execute(*args, **kwargs) - - class expert(metaclass=PyMenuMeta): - """ - Set the expert parameters for turbo interfaces. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enforce_flux_scaling(self, *args, **kwargs): - """ - Enforce flux scaling ON/OFF at the turbo interfaces. - """ - return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/expert/enforce_flux_scaling").execute(*args, **kwargs) - def list_settings(self, *args, **kwargs): - """ - List the flux scale settings at the turbo interfaces. - """ - return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/expert/list_settings").execute(*args, **kwargs) - - class blade_flutter_harmonics(metaclass=PyMenuMeta): - """ - Enters the blade flutter harmonics options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable_harmonic_postprocessing(self, *args, **kwargs): - """ - Calculates/Deletes Postprocessing Fourier coefficients data. - """ - return PyMenu(self.service, "/define/turbo_model/blade_flutter_harmonics/enable_harmonic_postprocessing").execute(*args, **kwargs) - def enable_harmonic_exports(self, *args, **kwargs): - """ - Calculates/Deletes flutter harmonic export data. - """ - return PyMenu(self.service, "/define/turbo_model/blade_flutter_harmonics/enable_harmonic_exports").execute(*args, **kwargs) - def write_harmonic_exports(self, *args, **kwargs): - """ - Writes harmonic export data. - """ - return PyMenu(self.service, "/define/turbo_model/blade_flutter_harmonics/write_harmonic_exports").execute(*args, **kwargs) - def write_aerodamping_vs_nodal_diameter(self, *args, **kwargs): - """ - Reads report definition file and Writes influence coefficient aerodynamic damping values vs nodal diameter. - """ - return PyMenu(self.service, "/define/turbo_model/blade_flutter_harmonics/write_aerodamping_vs_nodal_diameter").execute(*args, **kwargs) - - class phases(metaclass=PyMenuMeta): - """ - Enters the phases menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.set_domain_properties = self.__class__.set_domain_properties(path + [("set_domain_properties", None)], service) - self.iac_expert = self.__class__.iac_expert(path + [("iac_expert", None)], service) - - class set_domain_properties(metaclass=PyMenuMeta): - """ - Enters the menu to set phase domain properties. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.interaction_domain = self.__class__.interaction_domain(path + [("interaction_domain", None)], service) - def change_phases_names(self, *args, **kwargs): - """ - Allows you to change the names of all the phases in your simulation. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/change_phases_names").execute(*args, **kwargs) - def phase_domains(self, *args, **kwargs): - """ - Enters the menu to select a specific phase. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/phase_domains").execute(*args, **kwargs) - - class interaction_domain(metaclass=PyMenuMeta): - """ - Enters the menu to set the interaction domain properties. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.forces = self.__class__.forces(path + [("forces", None)], service) - self.heat_mass_reactions = self.__class__.heat_mass_reactions(path + [("heat_mass_reactions", None)], service) - self.interfacial_area = self.__class__.interfacial_area(path + [("interfacial_area", None)], service) - self.model_transition = self.__class__.model_transition(path + [("model_transition", None)], service) - self.numerics = self.__class__.numerics(path + [("numerics", None)], service) - - class forces(metaclass=PyMenuMeta): - """ - Enters the menu to set interfacial forces models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) - self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) - self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) - self.lift = self.__class__.lift(path + [("lift", None)], service) - self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) - self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) - def drag(self, *args, **kwargs): - """ - Specifies the drag function, drag modification, and drag factor for each pair of phases. This command is available only with the Eulerian and Mixture multiphase models. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/drag").execute(*args, **kwargs) - def heat_coeff(self, *args, **kwargs): - """ - Specify the heat transfer coefficient function between each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/heat_coeff").execute(*args, **kwargs) - def interfacial_area(self, *args, **kwargs): - """ - Set the interfacial area parameters for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interfacial_area").execute(*args, **kwargs) - def mass_transfer(self, *args, **kwargs): - """ - Specify the mass transfer mechanisms. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/mass_transfer").execute(*args, **kwargs) - def model_transition(self, *args, **kwargs): - """ - Set the model transition mechanism. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/model_transition").execute(*args, **kwargs) - def reactions(self, *args, **kwargs): - """ - Define multiple heterogeneous reactions and stoichiometry. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/reactions").execute(*args, **kwargs) - def restitution(self, *args, **kwargs): - """ - Specifies the restitution coefficient for collisions between each pair of granular phases, and for collisions between particles of the same granular phase. This command is available only for multiphase flows with two or more granular phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/restitution").execute(*args, **kwargs) - def slip_velocity(self, *args, **kwargs): - """ - Specifies the slip velocity function for each secondary phase with respect to the primary phase. This command is available only for the Mixture multiphase model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/slip_velocity").execute(*args, **kwargs) - def turbulence_interaction(self, *args, **kwargs): - """ - Specifies the turbulence interaction model for each primary-secondary phase pair. This command is available only with the Eulerian multiphase model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/turbulence_interaction").execute(*args, **kwargs) - def turbulent_dispersion(self, *args, **kwargs): - """ - Specifies the turbulent dispersion model for each primary-secondary phase pair. This command is available only with the Eulerian multiphase model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/turbulent_dispersion").execute(*args, **kwargs) - def wall_lubrication(self, *args, **kwargs): - """ - Specifies the wall lubrication model for each primary-secondary phase pair. This command is available only with the Eulerian multiphase model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/wall_lubrication").execute(*args, **kwargs) - - class cavitation(metaclass=PyMenuMeta): - """ - Enter the menu to set cavitation models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/wall_adhesion").execute(*args, **kwargs) - - class interphase_discretization(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase discretization models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - - class interphase_viscous_dissipation(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase viscous dissipation related models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - - class lift(metaclass=PyMenuMeta): - """ - Enters the menu to set the lift force. This item is available only with the Eulerian multiphase model. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - Specifies the lift function for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Enables/disables the Shaver-Podowski lift correction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/wall_adhesion").execute(*args, **kwargs) - - class surface_tension(metaclass=PyMenuMeta): - """ - Enters the menu to set surface tension models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enables/disables the treatment of the contact angle specification at the porous jump boundary. This command is available only for the VOF multiphase model with the continuum surface stress model option and when sfc-modeling? is enabled. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Selects the surface tension model. You can choose between the continuum surface force and continuum surface stress methods. This item is available only when sfc-modeling? is enabled. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Allows you to include the effects of surface tension along the fluid-fluid interface. This option is only available for the VOF and Eulerian multiphase models. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specifies the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enables/disables the specification for a wall adhesion angle. This item is available only whensfc-modeling? is enabled. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/wall_adhesion").execute(*args, **kwargs) - - class virtual_mass(metaclass=PyMenuMeta): - """ - Enters the menu to set virtual mass models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Allows you to include the virtual mass force effect that occurs when a secondary phase accelerates relative to the primary phase. This command is available only with the Eulerian multiphase model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specifies the virtual mass coefficient for each pair of phases. This option is available only ifvirtual-mass? is enabled. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Specifies what form of the implicit method to use (default, option-2, or option-3). default models the entire virtual mass force while option-2 and option-3 model truncated expressions which may further improve convergence. This option is available only if vmass-implicit? is enabled. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enables/disables the implicit method for the virtual mass force. This option can improve convergence in some cases. This option is available only if virtual-mass? is enabled. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/wall_adhesion").execute(*args, **kwargs) - - class heat_mass_reactions(metaclass=PyMenuMeta): - """ - Enters the menu to set heat, mass-transfer, and reaction models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) - self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) - self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) - self.lift = self.__class__.lift(path + [("lift", None)], service) - self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) - self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) - def drag(self, *args, **kwargs): - """ - Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/drag").execute(*args, **kwargs) - def heat_coeff(self, *args, **kwargs): - """ - Species the heat transfer coefficient function between each pair of phases (constant-htc, nusselt-number, ranz-marshall, hughmark, tomiyama, fixed-to-sat-temp, two-resistance, or user-defined). This command is enable only with the Eulerian multiphase model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/heat_coeff").execute(*args, **kwargs) - def interfacial_area(self, *args, **kwargs): - """ - Set the interfacial area parameters for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interfacial_area").execute(*args, **kwargs) - def mass_transfer(self, *args, **kwargs): - """ - Sets the mass transfer mechanisms. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/mass_transfer").execute(*args, **kwargs) - def model_transition(self, *args, **kwargs): - """ - Set the model transition mechanism. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/model_transition").execute(*args, **kwargs) - def reactions(self, *args, **kwargs): - """ - Allows you to define multiple heterogeneous reactions and stoichiometry. This option is available only with the species model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/reactions").execute(*args, **kwargs) - def restitution(self, *args, **kwargs): - """ - Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/restitution").execute(*args, **kwargs) - def slip_velocity(self, *args, **kwargs): - """ - Specify the slip velocity function for each secondary phase with respect to the primary phase. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/slip_velocity").execute(*args, **kwargs) - def turbulence_interaction(self, *args, **kwargs): - """ - Specify the turbulence interaction model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/turbulence_interaction").execute(*args, **kwargs) - def turbulent_dispersion(self, *args, **kwargs): - """ - Specify the turbulent dispersion model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/turbulent_dispersion").execute(*args, **kwargs) - def wall_lubrication(self, *args, **kwargs): - """ - Specify the wall lubrication model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/wall_lubrication").execute(*args, **kwargs) - - class cavitation(metaclass=PyMenuMeta): - """ - Enters the menu to set cavitation models. This option is available only for the Mixture multiphase model with the Singhal-et-al cavitation model enabled via solve/set/advanced/singhal-et-al-cavitation-model. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/wall_adhesion").execute(*args, **kwargs) - - class interphase_discretization(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase discretization models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - - class interphase_viscous_dissipation(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase viscous dissipation related models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - - class lift(metaclass=PyMenuMeta): - """ - Enter the menu to set lift models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/wall_adhesion").execute(*args, **kwargs) - - class surface_tension(metaclass=PyMenuMeta): - """ - Enter the menu to set surface tension models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/wall_adhesion").execute(*args, **kwargs) - - class virtual_mass(metaclass=PyMenuMeta): - """ - Enter the menu to set virtual mass models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/wall_adhesion").execute(*args, **kwargs) - - class interfacial_area(metaclass=PyMenuMeta): - """ - Enters the menu to set interfacial area models. This menu is available only for the Mixture and Eulerian multiphase models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) - self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) - self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) - self.lift = self.__class__.lift(path + [("lift", None)], service) - self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) - self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) - def drag(self, *args, **kwargs): - """ - Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/drag").execute(*args, **kwargs) - def heat_coeff(self, *args, **kwargs): - """ - Specify the heat transfer coefficient function between each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/heat_coeff").execute(*args, **kwargs) - def interfacial_area(self, *args, **kwargs): - """ - Specifies the interfacial area model for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interfacial_area").execute(*args, **kwargs) - def mass_transfer(self, *args, **kwargs): - """ - Specify the mass transfer mechanisms. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/mass_transfer").execute(*args, **kwargs) - def model_transition(self, *args, **kwargs): - """ - Set the model transition mechanism. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/model_transition").execute(*args, **kwargs) - def reactions(self, *args, **kwargs): - """ - Define multiple heterogeneous reactions and stoichiometry. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/reactions").execute(*args, **kwargs) - def restitution(self, *args, **kwargs): - """ - Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/restitution").execute(*args, **kwargs) - def slip_velocity(self, *args, **kwargs): - """ - Specify the slip velocity function for each secondary phase with respect to the primary phase. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/slip_velocity").execute(*args, **kwargs) - def turbulence_interaction(self, *args, **kwargs): - """ - Specify the turbulence interaction model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/turbulence_interaction").execute(*args, **kwargs) - def turbulent_dispersion(self, *args, **kwargs): - """ - Specify the turbulent dispersion model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/turbulent_dispersion").execute(*args, **kwargs) - def wall_lubrication(self, *args, **kwargs): - """ - Specify the wall lubrication model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/wall_lubrication").execute(*args, **kwargs) - - class cavitation(metaclass=PyMenuMeta): - """ - Enter the menu to set cavitation models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/wall_adhesion").execute(*args, **kwargs) - - class interphase_discretization(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase discretization models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - - class interphase_viscous_dissipation(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase viscous dissipation related models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - - class lift(metaclass=PyMenuMeta): - """ - Enter the menu to set lift models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/wall_adhesion").execute(*args, **kwargs) - - class surface_tension(metaclass=PyMenuMeta): - """ - Enter the menu to set surface tension models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/wall_adhesion").execute(*args, **kwargs) - - class virtual_mass(metaclass=PyMenuMeta): - """ - Enter the menu to set virtual mass models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/wall_adhesion").execute(*args, **kwargs) - - class model_transition(metaclass=PyMenuMeta): - """ - Enters the menu to set model transition mechanisms. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) - self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) - self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) - self.lift = self.__class__.lift(path + [("lift", None)], service) - self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) - self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) - def drag(self, *args, **kwargs): - """ - Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/drag").execute(*args, **kwargs) - def heat_coeff(self, *args, **kwargs): - """ - Specify the heat transfer coefficient function between each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/heat_coeff").execute(*args, **kwargs) - def interfacial_area(self, *args, **kwargs): - """ - Set the interfacial area parameters for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interfacial_area").execute(*args, **kwargs) - def mass_transfer(self, *args, **kwargs): - """ - Specify the mass transfer mechanisms. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/mass_transfer").execute(*args, **kwargs) - def model_transition(self, *args, **kwargs): - """ - Sets the VOF-to-DPM model transition mechanism. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/model_transition").execute(*args, **kwargs) - def reactions(self, *args, **kwargs): - """ - Define multiple heterogeneous reactions and stoichiometry. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/reactions").execute(*args, **kwargs) - def restitution(self, *args, **kwargs): - """ - Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/restitution").execute(*args, **kwargs) - def slip_velocity(self, *args, **kwargs): - """ - Specify the slip velocity function for each secondary phase with respect to the primary phase. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/slip_velocity").execute(*args, **kwargs) - def turbulence_interaction(self, *args, **kwargs): - """ - Specify the turbulence interaction model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/turbulence_interaction").execute(*args, **kwargs) - def turbulent_dispersion(self, *args, **kwargs): - """ - Specify the turbulent dispersion model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/turbulent_dispersion").execute(*args, **kwargs) - def wall_lubrication(self, *args, **kwargs): - """ - Specify the wall lubrication model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/wall_lubrication").execute(*args, **kwargs) - - class cavitation(metaclass=PyMenuMeta): - """ - Enter the menu to set cavitation models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/wall_adhesion").execute(*args, **kwargs) - - class interphase_discretization(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase discretization models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - - class interphase_viscous_dissipation(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase viscous dissipation related models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - - class lift(metaclass=PyMenuMeta): - """ - Enter the menu to set lift models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/wall_adhesion").execute(*args, **kwargs) - - class surface_tension(metaclass=PyMenuMeta): - """ - Enter the menu to set surface tension models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/wall_adhesion").execute(*args, **kwargs) - - class virtual_mass(metaclass=PyMenuMeta): - """ - Enter the menu to set virtual mass models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/wall_adhesion").execute(*args, **kwargs) - - class numerics(metaclass=PyMenuMeta): - """ - Enters the menu to set numerics models. This menu is available for multiphase models with the sharp-dispersed and phase localized discretization interface modeling options (set in define/models/multiphase/interface-modeling-options). - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) - self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) - self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) - self.lift = self.__class__.lift(path + [("lift", None)], service) - self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) - self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) - def drag(self, *args, **kwargs): - """ - Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/drag").execute(*args, **kwargs) - def heat_coeff(self, *args, **kwargs): - """ - Specify the heat transfer coefficient function between each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/heat_coeff").execute(*args, **kwargs) - def interfacial_area(self, *args, **kwargs): - """ - Set the interfacial area parameters for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interfacial_area").execute(*args, **kwargs) - def mass_transfer(self, *args, **kwargs): - """ - Specify the mass transfer mechanisms. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/mass_transfer").execute(*args, **kwargs) - def model_transition(self, *args, **kwargs): - """ - Set the model transition mechanism. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/model_transition").execute(*args, **kwargs) - def reactions(self, *args, **kwargs): - """ - Define multiple heterogeneous reactions and stoichiometry. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/reactions").execute(*args, **kwargs) - def restitution(self, *args, **kwargs): - """ - Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/restitution").execute(*args, **kwargs) - def slip_velocity(self, *args, **kwargs): - """ - Specify the slip velocity function for each secondary phase with respect to the primary phase. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/slip_velocity").execute(*args, **kwargs) - def turbulence_interaction(self, *args, **kwargs): - """ - Specify the turbulence interaction model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/turbulence_interaction").execute(*args, **kwargs) - def turbulent_dispersion(self, *args, **kwargs): - """ - Specify the turbulent dispersion model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/turbulent_dispersion").execute(*args, **kwargs) - def wall_lubrication(self, *args, **kwargs): - """ - Specify the wall lubrication model for each primary-secondary phase pair. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/wall_lubrication").execute(*args, **kwargs) - - class cavitation(metaclass=PyMenuMeta): - """ - Enter the menu to set cavitation models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/wall_adhesion").execute(*args, **kwargs) - - class interphase_discretization(metaclass=PyMenuMeta): - """ - Enters the menu to set interphase discretization models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enables/disables phase localized compressive scheme. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *args, **kwargs): - """ - Specifies the slope limiter to set a specific discretization scheme for each phase pair. A value of 0 corresponds to first order upwind, a value of 1 corresponds to second order upwind, a value of 2 applies the compressive scheme, and a value between 0 and 2 corresponds to a blended scheme. This option is available only wheninterphase-discr? is enabled. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - - class interphase_viscous_dissipation(metaclass=PyMenuMeta): - """ - Enter the menu to set interphase viscous dissipation related models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - - class lift(metaclass=PyMenuMeta): - """ - Enter the menu to set lift models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/wall_adhesion").execute(*args, **kwargs) - - class surface_tension(metaclass=PyMenuMeta): - """ - Enter the menu to set surface tension models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/wall_adhesion").execute(*args, **kwargs) - - class virtual_mass(metaclass=PyMenuMeta): - """ - Enter the menu to set virtual mass models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cavitation(self, *args, **kwargs): - """ - Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/cavitation").execute(*args, **kwargs) - def interphase_discr(self, *args, **kwargs): - """ - Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/interphase_discr").execute(*args, **kwargs) - def interphase_visc_disp(self, *args, **kwargs): - """ - Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) - def jump_adhesion(self, *args, **kwargs): - """ - Enable the treatment of the contact angle specification at the porous jump boundary?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/jump_adhesion").execute(*args, **kwargs) - def lift(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/lift").execute(*args, **kwargs) - def lift_montoya(self, *args, **kwargs): - """ - Include the Montoya correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/lift_montoya").execute(*args, **kwargs) - def lift_shaver_podowski(self, *args, **kwargs): - """ - Include the Shaver-Podowski correction for Lift. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) - def sfc_model_type(self, *args, **kwargs): - """ - Select the surface tension model. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/sfc_model_type").execute(*args, **kwargs) - def sfc_modeling(self, *args, **kwargs): - """ - Include the effects of surface tension along the fluid-fluid interface?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/sfc_modeling").execute(*args, **kwargs) - def sfc_tension_coeff(self, *args, **kwargs): - """ - Specify the surface tension coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) - def slope_limiter(self, *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. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/slope_limiter").execute(*args, **kwargs) - def virtual_mass(self, *args, **kwargs): - """ - Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/virtual_mass").execute(*args, **kwargs) - def visc_disp_factor(self, *args, **kwargs): - """ - Set the dissipation intensity. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/visc_disp_factor").execute(*args, **kwargs) - def vmass_coeff(self, *args, **kwargs): - """ - Specify the virtual mass coefficient for each pair of phases. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/vmass_coeff").execute(*args, **kwargs) - def vmass_implicit_options(self, *args, **kwargs): - """ - Select the virtual mass implicit option. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) - def vmass_implicit(self, *args, **kwargs): - """ - Enable the implicit method for the virtual mass force?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/vmass_implicit").execute(*args, **kwargs) - def wall_adhesion(self, *args, **kwargs): - """ - Enable the specification for a wall adhesion angle?. - """ - return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/wall_adhesion").execute(*args, **kwargs) - - class iac_expert(metaclass=PyMenuMeta): - """ - Enters the IAC expert setting menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def ishii_kim_model(self, *args, **kwargs): - """ - Sets Ishii-Kim model coefficients. - """ - return PyMenu(self.service, "/define/phases/iac_expert/ishii_kim_model").execute(*args, **kwargs) - def hibiki_ishii_model(self, *args, **kwargs): - """ - Sets Hibiki-Ishii model coefficients. - """ - return PyMenu(self.service, "/define/phases/iac_expert/hibiki_ishii_model").execute(*args, **kwargs) - def yao_morel_model(self, *args, **kwargs): - """ - Sets Yao-Morel model coefficients. - """ - return PyMenu(self.service, "/define/phases/iac_expert/yao_morel_model").execute(*args, **kwargs) - def iac_pseudo_time_step(self, *args, **kwargs): - """ - Set iac pseudo-time. - """ - return PyMenu(self.service, "/define/phases/iac_expert/iac_pseudo_time_step").execute(*args, **kwargs) - - class profiles(metaclass=PyMenuMeta): - """ - Enters the boundary profiles menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def display_profile_surface(self, *args, **kwargs): - """ - Display the profile as a surface (this option is only available if the specified profile contains node-connectivity data). - """ - return PyMenu(self.service, "/define/profiles/display_profile_surface").execute(*args, **kwargs) - def display_profile_point_cloud_data(self, *args, **kwargs): - """ - Display Profile Point Cloud Data. - """ - return PyMenu(self.service, "/define/profiles/display_profile_point_cloud_data").execute(*args, **kwargs) - def overlay_profile_surface(self, *args, **kwargs): - """ - Overlay Profile Surface. - """ - return PyMenu(self.service, "/define/profiles/overlay_profile_surface").execute(*args, **kwargs) - def overlay_profile_point_cloud_data(self, *args, **kwargs): - """ - Overlay Profile Point Cloud Data. - """ - return PyMenu(self.service, "/define/profiles/overlay_profile_point_cloud_data").execute(*args, **kwargs) - def set_preference_profile_point_cloud_data(self, *args, **kwargs): - """ - Set Preference Profile Point Cloud Data e.g., Point marker symbol,size,color. - """ - return PyMenu(self.service, "/define/profiles/set_preference_profile_point_cloud_data").execute(*args, **kwargs) - def list_profile_parameters(self, *args, **kwargs): - """ - List the parameters of a particular profile. - """ - return PyMenu(self.service, "/define/profiles/list_profile_parameters").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes a profile. - """ - return PyMenu(self.service, "/define/profiles/delete").execute(*args, **kwargs) - def delete_all(self, *args, **kwargs): - """ - Deletes all boundary-profiles. - """ - return PyMenu(self.service, "/define/profiles/delete_all").execute(*args, **kwargs) - def list_profiles(self, *args, **kwargs): - """ - Lists all profiles. - """ - return PyMenu(self.service, "/define/profiles/list_profiles").execute(*args, **kwargs) - def list_profile_fields(self, *args, **kwargs): - """ - Lists the fields of a particular profile. - """ - return PyMenu(self.service, "/define/profiles/list_profile_fields").execute(*args, **kwargs) - def interpolation_method(self, *args, **kwargs): - """ - Chooses the method for interpolation of profiles. - """ - return PyMenu(self.service, "/define/profiles/interpolation_method").execute(*args, **kwargs) - def morphing(self, *args, **kwargs): - """ - Enables/disables profile morphing options in Orient Profile panel. - """ - return PyMenu(self.service, "/define/profiles/morphing").execute(*args, **kwargs) - def update_interval(self, *args, **kwargs): - """ - Sets interval between updates of dynamic profiles. - """ - return PyMenu(self.service, "/define/profiles/update_interval").execute(*args, **kwargs) - def link_profile_to_reference_frame(self, *args, **kwargs): - """ - Attaches a profile to a reference frame so that the profile will rotate according to the reference frame. - """ - return PyMenu(self.service, "/define/profiles/link_profile_to_reference_frame").execute(*args, **kwargs) - def replicate_profile(self, *args, **kwargs): - """ - Replicate Profile. - """ - return PyMenu(self.service, "/define/profiles/replicate_profile").execute(*args, **kwargs) - def orient_profile(self, *args, **kwargs): - """ - Re-orient an existing profile. - """ - return PyMenu(self.service, "/define/profiles/orient_profile").execute(*args, **kwargs) - - class solution_strategy(metaclass=PyMenuMeta): - """ - Enters the automatic initialization and case modification strategy menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.automatic_case_modification = self.__class__.automatic_case_modification(path + [("automatic_case_modification", None)], service) - def enable_strategy(self, *args, **kwargs): - """ - Enables/disables automatic initialization and case modification. - """ - return PyMenu(self.service, "/define/solution_strategy/enable_strategy").execute(*args, **kwargs) - def execute_strategy(self, *args, **kwargs): - """ - Executes the currently defined automatic initialization and case modification strategy. - """ - return PyMenu(self.service, "/define/solution_strategy/execute_strategy").execute(*args, **kwargs) - def add_edit_modification(self, *args, **kwargs): - """ - Define a single case modification. - """ - return PyMenu(self.service, "/define/solution_strategy/add_edit_modification").execute(*args, **kwargs) - def copy_modification(self, *args, **kwargs): - """ - Copy a single case modification. - """ - return PyMenu(self.service, "/define/solution_strategy/copy_modification").execute(*args, **kwargs) - def delete_modification(self, *args, **kwargs): - """ - Delete a single case modification. - """ - return PyMenu(self.service, "/define/solution_strategy/delete_modification").execute(*args, **kwargs) - def enable_modification(self, *args, **kwargs): - """ - Enable a single defined case modification. - """ - return PyMenu(self.service, "/define/solution_strategy/enable_modification").execute(*args, **kwargs) - def disable_modification(self, *args, **kwargs): - """ - Disable a single defined case modification. - """ - return PyMenu(self.service, "/define/solution_strategy/disable_modification").execute(*args, **kwargs) - def import_modifications(self, *args, **kwargs): - """ - Import a list of case modifications from a tsv file. - """ - return PyMenu(self.service, "/define/solution_strategy/import_modifications").execute(*args, **kwargs) - def export_modifications(self, *args, **kwargs): - """ - Export all case modifications to a tsv file. - """ - return PyMenu(self.service, "/define/solution_strategy/export_modifications").execute(*args, **kwargs) - def continue_strategy_execution(self, *args, **kwargs): - """ - Continues execution of the currently defined automatic initialization and case modification strategy. - """ - return PyMenu(self.service, "/define/solution_strategy/continue_strategy_execution").execute(*args, **kwargs) - def automatic_initialization(self, *args, **kwargs): - """ - Defines how the case is to be automatically initialized. - """ - return PyMenu(self.service, "/define/solution_strategy/automatic_initialization").execute(*args, **kwargs) - - class automatic_case_modification(metaclass=PyMenuMeta): - """ - Enters the automatic case modification menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def before_init_modification(self, *args, **kwargs): - """ - Specifies modification to be performed before initialization. - """ - return PyMenu(self.service, "/define/solution_strategy/automatic_case_modification/before_init_modification").execute(*args, **kwargs) - def original_settings(self, *args, **kwargs): - """ - Specifies modification to be performed after initialization to restore to original settings. - """ - return PyMenu(self.service, "/define/solution_strategy/automatic_case_modification/original_settings").execute(*args, **kwargs) - def modifications(self, *args, **kwargs): - """ - Specifies modifications to be performed during solution. - """ - return PyMenu(self.service, "/define/solution_strategy/automatic_case_modification/modifications").execute(*args, **kwargs) - - class reference_frames(metaclass=PyMenuMeta): - """ - Enters the reference frames menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def add(self, *args, **kwargs): - """ - Creates a new reference frame. - """ - return PyMenu(self.service, "/define/reference_frames/add").execute(*args, **kwargs) - def display(self, *args, **kwargs): - """ - Displays the reference frame you specify. - """ - return PyMenu(self.service, "/define/reference_frames/display").execute(*args, **kwargs) - def display_edit(self, *args, **kwargs): - """ - Display and edit reference frame from graphics. - """ - return PyMenu(self.service, "/define/reference_frames/display_edit").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Allows you to edit a reference frame. - """ - return PyMenu(self.service, "/define/reference_frames/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes the reference frame you specify. - """ - return PyMenu(self.service, "/define/reference_frames/delete").execute(*args, **kwargs) - def hide(self, *args, **kwargs): - """ - Removes the specified reference frame from the graphics window. - """ - return PyMenu(self.service, "/define/reference_frames/hide").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Lists all of the reference frames. - """ - return PyMenu(self.service, "/define/reference_frames/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): - """ - Lists the properties of the reference frame you specify. - """ - return PyMenu(self.service, "/define/reference_frames/list_properties").execute(*args, **kwargs) - - class user_defined(metaclass=PyMenuMeta): - """ - Enters the user-defined functions and scalars menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.real_gas_models = self.__class__.real_gas_models(path + [("real_gas_models", None)], service) - def auto_compile_compiled_udfs(self, *args, **kwargs): - """ - For this Fluent session, specify whether to allow auto-compilation of compiled UDF when a case file (or settings file) is read. - """ - return PyMenu(self.service, "/define/user_defined/auto_compile_compiled_udfs").execute(*args, **kwargs) - def compiled_functions(self, *args, **kwargs): - """ - Opens user-defined function library. - """ - return PyMenu(self.service, "/define/user_defined/compiled_functions").execute(*args, **kwargs) - def use_built_in_compiler(self, *args, **kwargs): - """ - Enables/disables the use of a built-in compiler (Clang) when the define/user-defined/compiled-functions text command is used. This text command / compiler is available for Windows only, and is provided as part of the ANSYS Fluent installation. It is recommended that you enable this text command when the compiler you installed on your machine is an older version that is no longer supported. Note that the built-in compiler is used automatically if Fluent determines that you have not installed Microsoft Visual Studio or Clang on your computer, whether this text command is enabled or not. - """ - return PyMenu(self.service, "/define/user_defined/use_built_in_compiler").execute(*args, **kwargs) - def interpreted_functions(self, *args, **kwargs): - """ - Loads interpreted user-defined functions. - """ - return PyMenu(self.service, "/define/user_defined/interpreted_functions").execute(*args, **kwargs) - def function_hooks(self, *args, **kwargs): - """ - Hooks up user-defined functions. - """ - return PyMenu(self.service, "/define/user_defined/function_hooks").execute(*args, **kwargs) - def execute_on_demand(self, *args, **kwargs): - """ - Executes UDFs on demand. - """ - return PyMenu(self.service, "/define/user_defined/execute_on_demand").execute(*args, **kwargs) - def user_defined_memory(self, *args, **kwargs): - """ - Allocates user-defined memory. - """ - return PyMenu(self.service, "/define/user_defined/user_defined_memory").execute(*args, **kwargs) - def user_defined_node_memory(self, *args, **kwargs): - """ - Allocate user-defined node memory. - """ - return PyMenu(self.service, "/define/user_defined/user_defined_node_memory").execute(*args, **kwargs) - def use_contributed_cpp(self, *args, **kwargs): - """ - Enable/disable use of cpp from the Fluent.Inc/contrib directory. - """ - return PyMenu(self.service, "/define/user_defined/use_contributed_cpp").execute(*args, **kwargs) - def fan_model(self, *args, **kwargs): - """ - Configures user-defined fan model. - """ - return PyMenu(self.service, "/define/user_defined/fan_model").execute(*args, **kwargs) - def one_D_coupling(self, *args, **kwargs): - """ - Load 1D library. - """ - return PyMenu(self.service, "/define/user_defined/one_D_coupling").execute(*args, **kwargs) - def user_defined_scalars(self, *args, **kwargs): - """ - Defines user-defined scalars. - """ - return PyMenu(self.service, "/define/user_defined/user_defined_scalars").execute(*args, **kwargs) - def enable_udf_on_gpu(self, *args, **kwargs): - """ - Compile UDFs with OpenCL support. - """ - return PyMenu(self.service, "/define/user_defined/enable_udf_on_gpu").execute(*args, **kwargs) - def compile_customized_addon_module(self, *args, **kwargs): - """ - Compile customized addon module?. - """ - return PyMenu(self.service, "/define/user_defined/compile_customized_addon_module").execute(*args, **kwargs) - - class real_gas_models(metaclass=PyMenuMeta): - """ - Enters the real-gas menu to enable/configure real gas model. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def nist_real_gas_model(self, *args, **kwargs): - """ - Loads the NIST real-gas library. - """ - return PyMenu(self.service, "/define/user_defined/real_gas_models/nist_real_gas_model").execute(*args, **kwargs) - def nist_multispecies_real_gas_model(self, *args, **kwargs): - """ - Loads the NIST real-gas library. - """ - return PyMenu(self.service, "/define/user_defined/real_gas_models/nist_multispecies_real_gas_model").execute(*args, **kwargs) - def set_state(self, *args, **kwargs): - """ - Selects the state for NIST real gas model. - """ - return PyMenu(self.service, "/define/user_defined/real_gas_models/set_state").execute(*args, **kwargs) - def nist_settings(self, *args, **kwargs): - """ - Specifies the name and the location for the REFPROP library and fluid files. - """ - return PyMenu(self.service, "/define/user_defined/real_gas_models/nist_settings").execute(*args, **kwargs) - def user_defined_real_gas_model(self, *args, **kwargs): - """ - Loads the user-defined real-gas library. - """ - return PyMenu(self.service, "/define/user_defined/real_gas_models/user_defined_real_gas_model").execute(*args, **kwargs) - def user_defined_multispecies_real_gas_model(self, *args, **kwargs): - """ - Loads a user-defined multispecies real-gas library. - """ - return PyMenu(self.service, "/define/user_defined/real_gas_models/user_defined_multispecies_real_gas_model").execute(*args, **kwargs) - - class named_expressions(metaclass=PyMenuMeta): - """ - Enters the named expressions menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def add(self, *args, **kwargs): - """ - Creates a new named expression. - """ - return PyMenu(self.service, "/define/named_expressions/add").execute(*args, **kwargs) - def compute(self, *args, **kwargs): - """ - Computes and prints the value of an expression. This is only available for expressions that evaluate to a single value. - """ - return PyMenu(self.service, "/define/named_expressions/compute").execute(*args, **kwargs) - def copy(self, *args, **kwargs): - """ - Allows you to copy an existing named expression. - """ - return PyMenu(self.service, "/define/named_expressions/copy").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Allows you to edit the definition of a named expression. - """ - return PyMenu(self.service, "/define/named_expressions/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Allows you to delete a named expression, as long as it is not in use. - """ - return PyMenu(self.service, "/define/named_expressions/delete").execute(*args, **kwargs) - def export_to_tsv(self, *args, **kwargs): - """ - Export one or more named expressions to a file in TSV format. - """ - return PyMenu(self.service, "/define/named_expressions/export_to_tsv").execute(*args, **kwargs) - def import_from_tsv(self, *args, **kwargs): - """ - Import one or more named expressions saved in TSV format. - """ - return PyMenu(self.service, "/define/named_expressions/import_from_tsv").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Lists all of the currently defined named expressions. - """ - return PyMenu(self.service, "/define/named_expressions/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): - """ - Lists the definition of a named expression. - """ - return PyMenu(self.service, "/define/named_expressions/list_properties").execute(*args, **kwargs) - - class virtual_boundary(metaclass=PyMenuMeta): - """ - Manage Virtual Boundaries. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def boundary_interface(self, *args, **kwargs): - """ - Create a Boundary Interface. - """ - return PyMenu(self.service, "/define/virtual_boundary/boundary_interface").execute(*args, **kwargs) - def hole_geometry(self, *args, **kwargs): - """ - Create a Hole Geometry template. - """ - return PyMenu(self.service, "/define/virtual_boundary/hole_geometry").execute(*args, **kwargs) - - class curvilinear_coordinate_system(metaclass=PyMenuMeta): - """ - Curvilinear Coordinate System. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def calculation_settings(self, *args, **kwargs): - """ - Define Settings for curvilinear coordinate system. - """ - return PyMenu(self.service, "/define/curvilinear_coordinate_system/calculation_settings").execute(*args, **kwargs) - def new(self, *args, **kwargs): - """ - Define a new curvilinear coordinate system. - """ - return PyMenu(self.service, "/define/curvilinear_coordinate_system/new").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edit an existing curvilinear coordinate system. - """ - return PyMenu(self.service, "/define/curvilinear_coordinate_system/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Delete Curvilinear Coordinate System. - """ - return PyMenu(self.service, "/define/curvilinear_coordinate_system/delete").execute(*args, **kwargs) - def display_settings(self, *args, **kwargs): - """ - Display settings for Curvilinear Coordinate System. - """ - return PyMenu(self.service, "/define/curvilinear_coordinate_system/display_settings").execute(*args, **kwargs) - def display(self, *args, **kwargs): - """ - Display Curvilinear Coordinate System. - """ - return PyMenu(self.service, "/define/curvilinear_coordinate_system/display").execute(*args, **kwargs) - - class file(metaclass=PyMenuMeta): - """ - Enter the file menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_save = self.__class__.auto_save(path + [("auto_save", None)], service) - self.cffio_options = self.__class__.cffio_options(path + [("cffio_options", None)], service) - self.export = self.__class__.export(path + [("export", None)], service) - self.transient_export = self.__class__.transient_export(path + [("transient_export", None)], service) - self.em_mapping = self.__class__.em_mapping(path + [("em_mapping", None)], service) - self.import_ = self.__class__.import_(path + [("import", None)], service) - self.interpolate = self.__class__.interpolate(path + [("interpolate", None)], service) - self.fsi = self.__class__.fsi(path + [("fsi", None)], service) - self.parametric_project = self.__class__.parametric_project(path + [("parametric_project", None)], service) - self.project = self.__class__.project(path + [("project[beta]", None)], service) - self.table_manager = self.__class__.table_manager(path + [("table_manager", None)], service) - self.solution_files = self.__class__.solution_files(path + [("solution_files", None)], service) - def single_precision_coordinates(self, *args, **kwargs): - """ - Specifies whether the nodal coordinates should be written in single precision (rather than the default double precision). This text command is only available in the single-precision version of ANSYS Fluent. - """ - return PyMenu(self.service, "/file/single_precision_coordinates").execute(*args, **kwargs) - def binary_legacy_files(self, *args, **kwargs): - """ - Indicate whether to write binary or text format case and data files. - """ - return PyMenu(self.service, "/file/binary_legacy_files").execute(*args, **kwargs) - def cff_files(self, *args, **kwargs): - """ - Indicate whether to write ANSYS common fluids format (CFF) files or legacy case and data files. - """ - return PyMenu(self.service, "/file/cff_files").execute(*args, **kwargs) - def async_optimize(self, *args, **kwargs): - """ - Chooses whether to optimize file I/O using scratch disks and asynchronous operations. - """ - return PyMenu(self.service, "/file/async_optimize").execute(*args, **kwargs) - def write_pdat(self, *args, **kwargs): - """ - Enables / disables the attempt to save .pdat files. Note that this text command is no longer supported. - """ - return PyMenu(self.service, "/file/write_pdat").execute(*args, **kwargs) - def confirm_overwrite(self, *args, **kwargs): - """ - Indicate whether or not to confirm attempts to overwrite existing files. - """ - return PyMenu(self.service, "/file/confirm_overwrite").execute(*args, **kwargs) - def define_macro(self, *args, **kwargs): - """ - Saves input to a named macro. - """ - return PyMenu(self.service, "/file/define_macro").execute(*args, **kwargs) - def export_to_cfd_post(self, *args, **kwargs): - """ - Exports data files that are compatible with CFD-Post and EnSight (that is, .cdat and .cst files) and opens CFD-Post, if desired. - """ - return PyMenu(self.service, "/file/export_to_cfd_post").execute(*args, **kwargs) - def execute_macro(self, *args, **kwargs): - """ - Runs a previously defined macro. - """ - return PyMenu(self.service, "/file/execute_macro").execute(*args, **kwargs) - def read_settings(self, *args, **kwargs): - """ - Reads and sets boundary conditions from a specified file. - """ - return PyMenu(self.service, "/file/read_settings").execute(*args, **kwargs) - def read_case(self, *args, **kwargs): - """ - Read a case file. - - Parameters - ---------- - case_file_name : str - """ - return PyMenu(self.service, "/file/read_case").execute(*args, **kwargs) - def read_case_light(self, *args, **kwargs): - """ - Read a case file while skipping mesh elements. - """ - return PyMenu(self.service, "/file/read_case_light").execute(*args, **kwargs) - def read_case_data(self, *args, **kwargs): - """ - Reads a case and a data file. - """ - return PyMenu(self.service, "/file/read_case_data").execute(*args, **kwargs) - def read_data(self, *args, **kwargs): - """ - Reads a data file. - """ - return PyMenu(self.service, "/file/read_data").execute(*args, **kwargs) - def read_case_info(self, *args, **kwargs): - """ - Read basic case info. - """ - return PyMenu(self.service, "/file/read_case_info").execute(*args, **kwargs) - def read_field_functions(self, *args, **kwargs): - """ - Reads custom field function definitions from a file. - """ - return PyMenu(self.service, "/file/read_field_functions").execute(*args, **kwargs) - def read_injections(self, *args, **kwargs): - """ - Reads all DPM injections from a file. - """ - return PyMenu(self.service, "/file/read_injections").execute(*args, **kwargs) - def read_journal(self, *args, **kwargs): - """ - Read a journal file. - """ - return PyMenu(self.service, "/file/read_journal").execute(*args, **kwargs) - def read_macros(self, *args, **kwargs): - """ - Reads macro definitions from a file. - """ - return PyMenu(self.service, "/file/read_macros").execute(*args, **kwargs) - def read_profile(self, *args, **kwargs): - """ - Reads boundary profile data. - """ - return PyMenu(self.service, "/file/read_profile").execute(*args, **kwargs) - def read_transient_table(self, *args, **kwargs): - """ - Reads table of transient boundary profile data. - """ - return PyMenu(self.service, "/file/read_transient_table").execute(*args, **kwargs) - def read_pdf(self, *args, **kwargs): - """ - Reads a PDF file. - """ - return PyMenu(self.service, "/file/read_pdf").execute(*args, **kwargs) - def read_rays(self, *args, **kwargs): - """ - Reads a ray file. - """ - return PyMenu(self.service, "/file/read_rays").execute(*args, **kwargs) - def read_surface_clusters(self, *args, **kwargs): - """ - Reads surface clusters from a file. - """ - return PyMenu(self.service, "/file/read_surface_clusters").execute(*args, **kwargs) - def read_viewfactors(self, *args, **kwargs): - """ - Reads view factors from a file. - """ - return PyMenu(self.service, "/file/read_viewfactors").execute(*args, **kwargs) - def read_isat_table(self, *args, **kwargs): - """ - Reads ISAT Table. - """ - return PyMenu(self.service, "/file/read_isat_table").execute(*args, **kwargs) - def replace_mesh(self, *args, **kwargs): - """ - Replaces the mesh with a new one while preserving settings. - """ - return PyMenu(self.service, "/file/replace_mesh").execute(*args, **kwargs) - def reload_setup(self, *args, **kwargs): - """ - Discards any changes in the current ANSYS Fluent in Workbench session and removes any corresponding data from the Solution cell. This command is only available when running ANSYS Fluent in Workbench. - """ - return PyMenu(self.service, "/file/reload_setup").execute(*args, **kwargs) - def close_without_save(self, *args, **kwargs): - """ - Exits ANSYS Fluent without saving data in Workbench. This command is only available when running ANSYS Fluent in Workbench. - """ - return PyMenu(self.service, "/file/close_without_save").execute(*args, **kwargs) - def sync_workbench(self, *args, **kwargs): - """ - Directly updates Workbench with the most recent Fluent changes. This command is only available when running ANSYS Fluent in Workbench. - """ - return PyMenu(self.service, "/file/sync_workbench").execute(*args, **kwargs) - def set_batch_options(self, *args, **kwargs): - """ - Sets the batch options. - """ - return PyMenu(self.service, "/file/set_batch_options").execute(*args, **kwargs) - def set_idle_timeout(self, *args, **kwargs): - """ - Set the idle timeout. - """ - return PyMenu(self.service, "/file/set_idle_timeout").execute(*args, **kwargs) - def show_configuration(self, *args, **kwargs): - """ - Display current release and version information. - """ - return PyMenu(self.service, "/file/show_configuration").execute(*args, **kwargs) - def start_journal(self, *args, **kwargs): - """ - Start recording all input in a file. - """ - return PyMenu(self.service, "/file/start_journal").execute(*args, **kwargs) - def stop_journal(self, *args, **kwargs): - """ - Stop recording input and close the journal file. - """ - return PyMenu(self.service, "/file/stop_journal").execute(*args, **kwargs) - def stop_macro(self, *args, **kwargs): - """ - Stops recording input to a macro. - """ - return PyMenu(self.service, "/file/stop_macro").execute(*args, **kwargs) - def start_transcript(self, *args, **kwargs): - """ - Start recording input and output in a file. - """ - return PyMenu(self.service, "/file/start_transcript").execute(*args, **kwargs) - def stop_transcript(self, *args, **kwargs): - """ - Stop recording input and output and close the transcript file. - """ - return PyMenu(self.service, "/file/stop_transcript").execute(*args, **kwargs) - def write_settings(self, *args, **kwargs): - """ - Writes out current boundary conditions in use. - """ - return PyMenu(self.service, "/file/write_settings").execute(*args, **kwargs) - def write_boundary_mesh(self, *args, **kwargs): - """ - Writes the boundary mesh to a file. - """ - return PyMenu(self.service, "/file/write_boundary_mesh").execute(*args, **kwargs) - def write_case(self, *args, **kwargs): - """ - Write a case file. - """ - return PyMenu(self.service, "/file/write_case").execute(*args, **kwargs) - def write_case_light(self, *args, **kwargs): - """ - Save the case file in light-weight mode,i.e. mesh not touched. - """ - return PyMenu(self.service, "/file/write_case_light").execute(*args, **kwargs) - def data_file_options(self, *args, **kwargs): - """ - Sets derived quantities to be written in data file. - """ - return PyMenu(self.service, "/file/data_file_options").execute(*args, **kwargs) - def write_case_data(self, *args, **kwargs): - """ - Writes a case and a data file. - """ - return PyMenu(self.service, "/file/write_case_data").execute(*args, **kwargs) - def write_data(self, *args, **kwargs): - """ - Writes a data file. - """ - return PyMenu(self.service, "/file/write_data").execute(*args, **kwargs) - def write_fan_profile(self, *args, **kwargs): - """ - Computes radial profiles for a fan zone and writes them to a profile file. - """ - return PyMenu(self.service, "/file/write_fan_profile").execute(*args, **kwargs) - def write_field_functions(self, *args, **kwargs): - """ - Writes the currently defined custom field functions to a file. - """ - return PyMenu(self.service, "/file/write_field_functions").execute(*args, **kwargs) - def write_profile(self, *args, **kwargs): - """ - Writes surface data as a boundary profile file. - """ - return PyMenu(self.service, "/file/write_profile").execute(*args, **kwargs) - def write_currently_defined_profiles(self, *args, **kwargs): - """ - Write currently defined profiles. To use \*.csv format specify filename with .csv suffix. - """ - return PyMenu(self.service, "/file/write_currently_defined_profiles").execute(*args, **kwargs) - def set_target_reference_frame_for_write_profiles(self, *args, **kwargs): - """ - Set reference frame options, which will be used for position transformation during writing of profiles. - """ - return PyMenu(self.service, "/file/set_target_reference_frame_for_write_profiles").execute(*args, **kwargs) - def write_circumferential_averaged_profile(self, *args, **kwargs): - """ - Write surface data as a boundary profile file. To use \*.csv format specify filename with .csv suffix. - """ - return PyMenu(self.service, "/file/write_circumferential_averaged_profile").execute(*args, **kwargs) - def write_merge_profiles(self, *args, **kwargs): - """ - Writes a .csv file with the selected surfaces consolidated into one set of data points. - """ - return PyMenu(self.service, "/file/write_merge_profiles").execute(*args, **kwargs) - def write_pdf(self, *args, **kwargs): - """ - Writes a pdf file. - """ - return PyMenu(self.service, "/file/write_pdf").execute(*args, **kwargs) - def write_flamelet(self, *args, **kwargs): - """ - Writes a flamelet file. - """ - return PyMenu(self.service, "/file/write_flamelet").execute(*args, **kwargs) - def write_injections(self, *args, **kwargs): - """ - Writes out selected DPM injections to a file. - """ - return PyMenu(self.service, "/file/write_injections").execute(*args, **kwargs) - def write_macros(self, *args, **kwargs): - """ - Writes the currently defined macros to a file. - """ - return PyMenu(self.service, "/file/write_macros").execute(*args, **kwargs) - def write_isat_table(self, *args, **kwargs): - """ - Writes ISAT Table. - """ - return PyMenu(self.service, "/file/write_isat_table").execute(*args, **kwargs) - def write_cleanup_script(self, *args, **kwargs): - """ - Writes the cleanup-script-file for ANSYS Fluent. - """ - return PyMenu(self.service, "/file/write_cleanup_script").execute(*args, **kwargs) - def load_act_tool(self, *args, **kwargs): - """ - Load ACT Start Page. - """ - return PyMenu(self.service, "/file/load_act_tool").execute(*args, **kwargs) - def set_tui_version(self, *args, **kwargs): - """ - Set the version of the TUI commands. - """ - return PyMenu(self.service, "/file/set_tui_version").execute(*args, **kwargs) - - class auto_save(metaclass=PyMenuMeta): - """ - Enters the auto save menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def case_frequency(self, *args, **kwargs): - """ - Specifies the frequency (in iterations, time steps, or flow time) with which case files are saved. - """ - return PyMenu(self.service, "/file/auto_save/case_frequency").execute(*args, **kwargs) - def data_frequency(self, *args, **kwargs): - """ - Specifies the frequency (in iterations, time steps, or flow time) with which data files are saved. - """ - return PyMenu(self.service, "/file/auto_save/data_frequency").execute(*args, **kwargs) - def root_name(self, *args, **kwargs): - """ - Specifies the root name for the files that are saved. - """ - return PyMenu(self.service, "/file/auto_save/root_name").execute(*args, **kwargs) - def retain_most_recent_files(self, *args, **kwargs): - """ - Sets autosave to retain the 5 most recent files. - """ - return PyMenu(self.service, "/file/auto_save/retain_most_recent_files").execute(*args, **kwargs) - def max_files(self, *args, **kwargs): - """ - Sets the maximum number of files. Once the maximum is reached, files will be erased as new files are written. - """ - return PyMenu(self.service, "/file/auto_save/max_files").execute(*args, **kwargs) - def append_file_name_with(self, *args, **kwargs): - """ - Sets the suffix for auto-saved files. The file name can be appended by flow-time, time-step value, or by user-specified flags in file name. - """ - return PyMenu(self.service, "/file/auto_save/append_file_name_with").execute(*args, **kwargs) - def save_data_file_every(self, *args, **kwargs): - """ - Specifies the type and frequency of the data file to be saved. - """ - return PyMenu(self.service, "/file/auto_save/save_data_file_every").execute(*args, **kwargs) - - class cffio_options(metaclass=PyMenuMeta): - """ - Enters the cffio options menu, which provides options for the I/O of case and data files in the Common Fluids Format (CFF). - """ - def __init__(self, path, service): - self.path = path - self.service = service - def io_mode(self, *args, **kwargs): - """ - Sets the I/O mode for writing CFF files. - - - 1. HOST: I/O is done serially by the host process. - - 2. NODE0: I/O is done serially by the node 0 process. - - 3. PARALLEL INDEPENDENT: I/O is done in parallel using the independent mode of MPI I/O. - - 4. PARALLEL COLLECTIVE: I/O is done in parallel using the collective mode of MPI I/O. - - - - """ - return PyMenu(self.service, "/file/cffio_options/io_mode").execute(*args, **kwargs) - def compression_level(self, *args, **kwargs): - """ - Sets the compression level for CFF files. The compression level can be set between 0 and 9 with 0 being least compression (fastest) and 9 being highest compression (slowest). - """ - return PyMenu(self.service, "/file/cffio_options/compression_level").execute(*args, **kwargs) - def single_precision_data(self, *args, **kwargs): - """ - Specifies whether the double-precision solver saves single-precision data when writing CFF data files, in order to reduce the size of the files. - """ - return PyMenu(self.service, "/file/cffio_options/single_precision_data").execute(*args, **kwargs) - - class export(metaclass=PyMenuMeta): - """ - Enter the export menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.system_coupling_definition_file_settings = self.__class__.system_coupling_definition_file_settings(path + [("system_coupling_definition_file_settings", None)], service) - self.settings = self.__class__.settings(path + [("settings", None)], service) - def abaqus(self, *args, **kwargs): - """ - Writes an ABAQUS file. - """ - return PyMenu(self.service, "/file/export/abaqus").execute(*args, **kwargs) - def mechanical_apdl(self, *args, **kwargs): - """ - Write an Mechanical APDL file. - """ - return PyMenu(self.service, "/file/export/mechanical_apdl").execute(*args, **kwargs) - def mechanical_apdl_input(self, *args, **kwargs): - """ - Writes a Mechanical APDL Input file. - """ - return PyMenu(self.service, "/file/export/mechanical_apdl_input").execute(*args, **kwargs) - def ascii(self, *args, **kwargs): - """ - Writes an ASCII file. - """ - return PyMenu(self.service, "/file/export/ascii").execute(*args, **kwargs) - def common_fluids_format_post(self, *args, **kwargs): - """ - Writes common fluids format files (.cas.post and .dat.post) for mesh and data, respectively. These files are saved in the hierarchical data format. - """ - return PyMenu(self.service, "/file/export/common_fluids_format_post").execute(*args, **kwargs) - def avs(self, *args, **kwargs): - """ - Writes an AVS UCD file. - """ - return PyMenu(self.service, "/file/export/avs").execute(*args, **kwargs) - def cdat_for_cfd_post__and__ensight(self, *args, **kwargs): - """ - Write a CDAT for CFD-Post & EnSight file. - """ - return PyMenu(self.service, "/file/export/cdat_for_cfd_post__and__ensight").execute(*args, **kwargs) - def cgns(self, *args, **kwargs): - """ - Write a CGNS file. - """ - return PyMenu(self.service, "/file/export/cgns").execute(*args, **kwargs) - def custom_heat_flux(self, *args, **kwargs): - """ - Writes a generic file for heat transfer. - """ - return PyMenu(self.service, "/file/export/custom_heat_flux").execute(*args, **kwargs) - def dx(self, *args, **kwargs): - """ - Writes an IBM Data Explorer format file. - """ - return PyMenu(self.service, "/file/export/dx").execute(*args, **kwargs) - def ensight(self, *args, **kwargs): - """ - Writes EnSight geometry, velocity, and scalar files. - """ - return PyMenu(self.service, "/file/export/ensight").execute(*args, **kwargs) - def ensight_gold(self, *args, **kwargs): - """ - Writes EnSight Gold geometry, velocity, and scalar files. - """ - return PyMenu(self.service, "/file/export/ensight_gold").execute(*args, **kwargs) - def ensight_gold_parallel_surfaces(self, *args, **kwargs): - """ - Writes EnSight Gold geometry, velocity, and scalar files for surfaces in a parallel format suitable for ANSYS Ensight Enterprise. - """ - return PyMenu(self.service, "/file/export/ensight_gold_parallel_surfaces").execute(*args, **kwargs) - def ensight_gold_parallel_volume(self, *args, **kwargs): - """ - Writes EnSight Gold geometry, velocity, and scalar files for cell zones in a parallel format suitable for ANSYS Ensight Enterprise. - """ - return PyMenu(self.service, "/file/export/ensight_gold_parallel_volume").execute(*args, **kwargs) - def ensight_dvs_surfaces(self, *args, **kwargs): - """ - Write post-processing data(geometry, velocity and scalars) for surfaces using EnSight Dynamic Visualization Store Interface. - """ - return PyMenu(self.service, "/file/export/ensight_dvs_surfaces").execute(*args, **kwargs) - def ensight_dvs_volume(self, *args, **kwargs): - """ - Write post-processing data(geometry, velocity and scalars) for cell zones and boundaries attached to them using EnSight Dynamic Visualization Store Interface. - """ - return PyMenu(self.service, "/file/export/ensight_dvs_volume").execute(*args, **kwargs) - def icemcfd_for_icepak(self, *args, **kwargs): - """ - Writes a binary ICEM CFD domain file. - """ - return PyMenu(self.service, "/file/export/icemcfd_for_icepak").execute(*args, **kwargs) - def fast_mesh(self, *args, **kwargs): - """ - Writes FAST/Plot3D unstructured mesh file. - """ - return PyMenu(self.service, "/file/export/fast_mesh").execute(*args, **kwargs) - def fast_scalar(self, *args, **kwargs): - """ - Writes FAST/Plot3D unstructured scalar function file. - """ - return PyMenu(self.service, "/file/export/fast_scalar").execute(*args, **kwargs) - def fast_solution(self, *args, **kwargs): - """ - Writes FAST/Plot3D unstructured solution file. - """ - return PyMenu(self.service, "/file/export/fast_solution").execute(*args, **kwargs) - def fast_velocity(self, *args, **kwargs): - """ - Writes FAST/Plot3D unstructured vector function file. - """ - return PyMenu(self.service, "/file/export/fast_velocity").execute(*args, **kwargs) - def fieldview(self, *args, **kwargs): - """ - Writes FIELDVIEW case and data files. - """ - return PyMenu(self.service, "/file/export/fieldview").execute(*args, **kwargs) - def fieldview_data(self, *args, **kwargs): - """ - Writes FIELDVIEW case and data files. - """ - return PyMenu(self.service, "/file/export/fieldview_data").execute(*args, **kwargs) - def fieldview_unstruct(self, *args, **kwargs): - """ - Writes FIELDVIEW unstructured combined file. - """ - return PyMenu(self.service, "/file/export/fieldview_unstruct").execute(*args, **kwargs) - def fieldview_unstruct_mesh(self, *args, **kwargs): - """ - Writes FIELDVIEW unstructured mesh-only file. - """ - return PyMenu(self.service, "/file/export/fieldview_unstruct_mesh").execute(*args, **kwargs) - def fieldview_unstruct_data(self, *args, **kwargs): - """ - Writes FIELDVIEW unstructured results-only file. - """ - return PyMenu(self.service, "/file/export/fieldview_unstruct_data").execute(*args, **kwargs) - def fieldview_unstruct_surfaces(self, *args, **kwargs): - """ - Writes FIELDVIEW unstructured file for surfaces. You are prompted to select either [1], [2] or [3] to write either mesh-only, results-only, or combined for surfaces (respectively). - """ - return PyMenu(self.service, "/file/export/fieldview_unstruct_surfaces").execute(*args, **kwargs) - def fieldview_xdb(self, *args, **kwargs): - """ - Write a FieldView XDB format file. - """ - return PyMenu(self.service, "/file/export/fieldview_xdb").execute(*args, **kwargs) - def gambit(self, *args, **kwargs): - """ - Writes GAMBIT neutral file. - """ - return PyMenu(self.service, "/file/export/gambit").execute(*args, **kwargs) - def ideas(self, *args, **kwargs): - """ - Writes an I-deas universal file. - """ - return PyMenu(self.service, "/file/export/ideas").execute(*args, **kwargs) - def nastran(self, *args, **kwargs): - """ - Write a NASTRAN file. - """ - return PyMenu(self.service, "/file/export/nastran").execute(*args, **kwargs) - def patran_neutral(self, *args, **kwargs): - """ - Writes a PATRAN neutral file. - """ - return PyMenu(self.service, "/file/export/patran_neutral").execute(*args, **kwargs) - def patran_nodal(self, *args, **kwargs): - """ - Writes a PATRAN nodal results file. - """ - return PyMenu(self.service, "/file/export/patran_nodal").execute(*args, **kwargs) - def taitherm(self, *args, **kwargs): - """ - Exports TAITherm file. - """ - return PyMenu(self.service, "/file/export/taitherm").execute(*args, **kwargs) - def tecplot(self, *args, **kwargs): - """ - Writes a Tecplot+3DV format file. - """ - return PyMenu(self.service, "/file/export/tecplot").execute(*args, **kwargs) - def particle_history_data(self, *args, **kwargs): - """ - Exports particle-history data. - """ - return PyMenu(self.service, "/file/export/particle_history_data").execute(*args, **kwargs) - - class system_coupling_definition_file_settings(metaclass=PyMenuMeta): - """ - Enters the system coupling file (.scp) menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable_automatic_creation_of_scp_file(self, *args, **kwargs): - """ - Enables/disables automatically writing a .scp every time a case file is written. - """ - return PyMenu(self.service, "/file/export/system_coupling_definition_file_settings/enable_automatic_creation_of_scp_file").execute(*args, **kwargs) - def write_system_coupling_file(self, *args, **kwargs): - """ - Writes a system coupling (.scp) file. - """ - return PyMenu(self.service, "/file/export/system_coupling_definition_file_settings/write_system_coupling_file").execute(*args, **kwargs) - - class settings(metaclass=PyMenuMeta): - """ - Enter the export settings menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def set_cgns_export_filetype(self, *args, **kwargs): - """ - Select HDF5 or ADF as file format for CGNS. - """ - return PyMenu(self.service, "/file/export/settings/set_cgns_export_filetype").execute(*args, **kwargs) - - class transient_export(metaclass=PyMenuMeta): - """ - Enter the export menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.settings = self.__class__.settings(path + [("settings", None)], service) - def abaqus(self, *args, **kwargs): - """ - Writes an ABAQUS file. - """ - return PyMenu(self.service, "/file/transient_export/abaqus").execute(*args, **kwargs) - def mechanical_apdl_input(self, *args, **kwargs): - """ - Writes a Mechanical APDL input file. - """ - return PyMenu(self.service, "/file/transient_export/mechanical_apdl_input").execute(*args, **kwargs) - def ascii(self, *args, **kwargs): - """ - Writes an ASCII file. - """ - return PyMenu(self.service, "/file/transient_export/ascii").execute(*args, **kwargs) - def avs(self, *args, **kwargs): - """ - Writes an AVS UCD file. - """ - return PyMenu(self.service, "/file/transient_export/avs").execute(*args, **kwargs) - def cdat_for_cfd_post__and__ensight(self, *args, **kwargs): - """ - Write a CDAT for CFD-Post & EnSight file. - """ - return PyMenu(self.service, "/file/transient_export/cdat_for_cfd_post__and__ensight").execute(*args, **kwargs) - def common_fluids_format_post(self, *args, **kwargs): - """ - Write an CFF Post-Only file. - """ - return PyMenu(self.service, "/file/transient_export/common_fluids_format_post").execute(*args, **kwargs) - def cgns(self, *args, **kwargs): - """ - Writes a CGNS file. - """ - return PyMenu(self.service, "/file/transient_export/cgns").execute(*args, **kwargs) - def dx(self, *args, **kwargs): - """ - Writes an IBM Data Explorer format file. - """ - return PyMenu(self.service, "/file/transient_export/dx").execute(*args, **kwargs) - def ensight_gold_transient(self, *args, **kwargs): - """ - Writes EnSight Gold geometry, velocity, and scalar files. - """ - return PyMenu(self.service, "/file/transient_export/ensight_gold_transient").execute(*args, **kwargs) - def ensight_gold_parallel_surfaces(self, *args, **kwargs): - """ - Writes EnSight Gold geometry, velocity, and scalar files for surfaces in a parallel format suitable for ANSYS Ensight Enterprise. - """ - return PyMenu(self.service, "/file/transient_export/ensight_gold_parallel_surfaces").execute(*args, **kwargs) - def ensight_gold_parallel_volume(self, *args, **kwargs): - """ - Writes EnSight Gold geometry, velocity, and scalar files for cell zones in a parallel format suitable for ANSYS Ensight Enterprise. - """ - return PyMenu(self.service, "/file/transient_export/ensight_gold_parallel_volume").execute(*args, **kwargs) - def ensight_dvs_surfaces(self, *args, **kwargs): - """ - Write post-processing data(geometry, velocity and scalars) for surfaces using EnSight Dynamic Visualization Store Interface. - """ - return PyMenu(self.service, "/file/transient_export/ensight_dvs_surfaces").execute(*args, **kwargs) - def ensight_dvs_volume(self, *args, **kwargs): - """ - Write post-processing data(geometry, velocity and scalars) for cell zones and boundaries attached to them using EnSight Dynamic Visualization Store Interface. - """ - return PyMenu(self.service, "/file/transient_export/ensight_dvs_volume").execute(*args, **kwargs) - def ensight_gold_from_existing_files(self, *args, **kwargs): - """ - Writes EnSight Gold files using ANSYS Fluent case files. - """ - return PyMenu(self.service, "/file/transient_export/ensight_gold_from_existing_files").execute(*args, **kwargs) - def fast(self, *args, **kwargs): - """ - Writes a FAST/Plot3D unstructured mesh velocity scalar file. - """ - return PyMenu(self.service, "/file/transient_export/fast").execute(*args, **kwargs) - def fast_solution(self, *args, **kwargs): - """ - Writes a FAST/Plot3D unstructured solution file. - """ - return PyMenu(self.service, "/file/transient_export/fast_solution").execute(*args, **kwargs) - def fieldview_unstruct(self, *args, **kwargs): - """ - Writes a FIELDVIEW unstructured combined file. - """ - return PyMenu(self.service, "/file/transient_export/fieldview_unstruct").execute(*args, **kwargs) - def fieldview_unstruct_mesh(self, *args, **kwargs): - """ - Writes a FIELDVIEW unstructured mesh only file. - """ - return PyMenu(self.service, "/file/transient_export/fieldview_unstruct_mesh").execute(*args, **kwargs) - def fieldview_unstruct_data(self, *args, **kwargs): - """ - Writes a FIELDVIEW unstructured results only file. - """ - return PyMenu(self.service, "/file/transient_export/fieldview_unstruct_data").execute(*args, **kwargs) - def fieldview_unstruct_surfaces(self, *args, **kwargs): - """ - Writes FIELDVIEW unstructured combined file for surfaces. - """ - return PyMenu(self.service, "/file/transient_export/fieldview_unstruct_surfaces").execute(*args, **kwargs) - def fieldview_xdb(self, *args, **kwargs): - """ - Write a FieldView XDB format file. - """ - return PyMenu(self.service, "/file/transient_export/fieldview_xdb").execute(*args, **kwargs) - def ideas(self, *args, **kwargs): - """ - Writes an I-deas universal file. - """ - return PyMenu(self.service, "/file/transient_export/ideas").execute(*args, **kwargs) - def nastran(self, *args, **kwargs): - """ - Writes a NASTRAN file. - """ - return PyMenu(self.service, "/file/transient_export/nastran").execute(*args, **kwargs) - def patran_neutral(self, *args, **kwargs): - """ - Writes a PATRAN neutral file. - """ - return PyMenu(self.service, "/file/transient_export/patran_neutral").execute(*args, **kwargs) - def taitherm(self, *args, **kwargs): - """ - Writes a TAITherm file. - """ - return PyMenu(self.service, "/file/transient_export/taitherm").execute(*args, **kwargs) - def tecplot(self, *args, **kwargs): - """ - Write a Tecplot+3DV format file. - """ - return PyMenu(self.service, "/file/transient_export/tecplot").execute(*args, **kwargs) - def particle_history_data(self, *args, **kwargs): - """ - Sets up an automatic particle-history data export. - """ - return PyMenu(self.service, "/file/transient_export/particle_history_data").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edits transient exports. - """ - return PyMenu(self.service, "/file/transient_export/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes transient exports. - """ - return PyMenu(self.service, "/file/transient_export/delete").execute(*args, **kwargs) - - class settings(metaclass=PyMenuMeta): - """ - Enters the automatic export settings menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def cfd_post_compatible(self, *args, **kwargs): - """ - Specifies when case files are written with the .cdat and .cst files exported for Ansys CFD-Post. Note that this setting is ignored if the Write Case File Every Time option is enabled in the Automatic Export dialog box, which is always the case starting in Release 2021 R1. - """ - return PyMenu(self.service, "/file/transient_export/settings/cfd_post_compatible").execute(*args, **kwargs) - - class em_mapping(metaclass=PyMenuMeta): - """ - Enters the electromagnetic loss mapping menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def volumetric_energy_source(self, *args, **kwargs): - """ - Loss data provided by Ansoft will be assigned to Fluent for selected cell zones. - """ - return PyMenu(self.service, "/file/em_mapping/volumetric_energy_source").execute(*args, **kwargs) - def surface_energy_source(self, *args, **kwargs): - """ - Loss data provided by Ansoft will be assigned to Fluent for selected wall zones. - """ - return PyMenu(self.service, "/file/em_mapping/surface_energy_source").execute(*args, **kwargs) - def remove_loss_only(self, *args, **kwargs): - """ - Removes the loss data provided by Maxwell and keeps all other solution data. - """ - return PyMenu(self.service, "/file/em_mapping/remove_loss_only").execute(*args, **kwargs) - def maintain_loss_on_initialization(self, *args, **kwargs): - """ - Maintains the loss data provided by Maxwell even if solution is initialized. - """ - return PyMenu(self.service, "/file/em_mapping/maintain_loss_on_initialization").execute(*args, **kwargs) - - class import_(metaclass=PyMenuMeta): - """ - Enter the import menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.mechanical_apdl = self.__class__.mechanical_apdl(path + [("mechanical_apdl", None)], service) - self.abaqus = self.__class__.abaqus(path + [("abaqus", None)], service) - self.cfx = self.__class__.cfx(path + [("cfx", None)], service) - self.cgns = self.__class__.cgns(path + [("cgns", None)], service) - self.fmu_file = self.__class__.fmu_file(path + [("fmu_file", None)], service) - self.flamelet = self.__class__.flamelet(path + [("flamelet", None)], service) - self.lstc = self.__class__.lstc(path + [("lstc", None)], service) - self.nastran = self.__class__.nastran(path + [("nastran", None)], service) - self.partition = self.__class__.partition(path + [("partition", None)], service) - self.patran = self.__class__.patran(path + [("patran", None)], service) - self.plot3d = self.__class__.plot3d(path + [("plot3d", None)], service) - self.tecplot = self.__class__.tecplot(path + [("tecplot", None)], service) - def chemkin_mechanism(self, *args, **kwargs): - """ - Reads a CHEMKIN mechanism file. - """ - return PyMenu(self.service, "/file/import/chemkin_mechanism").execute(*args, **kwargs) - def chemkin_report_each_line(self, *args, **kwargs): - """ - Enables/disables reporting after reading each line. - """ - return PyMenu(self.service, "/file/import/chemkin_report_each_line").execute(*args, **kwargs) - def fidap(self, *args, **kwargs): - """ - Imports a FIDAP neutral file. - """ - return PyMenu(self.service, "/file/import/fidap").execute(*args, **kwargs) - def fluent4_case(self, *args, **kwargs): - """ - Imports a formatted ANSYS Fluent 4 case file. - """ - return PyMenu(self.service, "/file/import/fluent4_case").execute(*args, **kwargs) - def gambit(self, *args, **kwargs): - """ - Imports a GAMBIT neutral file. - """ - return PyMenu(self.service, "/file/import/gambit").execute(*args, **kwargs) - def hypermesh(self, *args, **kwargs): - """ - Reads a HYPERMESH file as a case file. - """ - return PyMenu(self.service, "/file/import/hypermesh").execute(*args, **kwargs) - def ensight(self, *args, **kwargs): - """ - Reads an EnSight file as a case file. - """ - return PyMenu(self.service, "/file/import/ensight").execute(*args, **kwargs) - def ideas_universal(self, *args, **kwargs): - """ - Imports an I-deas Universal file. - """ - return PyMenu(self.service, "/file/import/ideas_universal").execute(*args, **kwargs) - def marc_post(self, *args, **kwargs): - """ - Reads a MARC POST file as a case file. - """ - return PyMenu(self.service, "/file/import/marc_post").execute(*args, **kwargs) - def ptc_mechanica(self, *args, **kwargs): - """ - Reads a PTC Mechanica Design file as a case file. - """ - return PyMenu(self.service, "/file/import/ptc_mechanica").execute(*args, **kwargs) - def prebfc_structured(self, *args, **kwargs): - """ - Imports a formatted PreBFC structured mesh file. - """ - return PyMenu(self.service, "/file/import/prebfc_structured").execute(*args, **kwargs) - - class mechanical_apdl(metaclass=PyMenuMeta): - """ - Imports a Mechanical APDL file. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def input(self, *args, **kwargs): - """ - Reads a Mechanical APDL file as a case file. - """ - return PyMenu(self.service, "/file/import/mechanical_apdl/input").execute(*args, **kwargs) - def result(self, *args, **kwargs): - """ - Reads a Mechanical APDL result file as a case file. - """ - return PyMenu(self.service, "/file/import/mechanical_apdl/result").execute(*args, **kwargs) - - class abaqus(metaclass=PyMenuMeta): - """ - Imports an ABAQUS file. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def fil(self, *args, **kwargs): - """ - Reads an ABAQUS .fil result file as a case file. - """ - return PyMenu(self.service, "/file/import/abaqus/fil").execute(*args, **kwargs) - def input(self, *args, **kwargs): - """ - Reads an ABAQUS input file as a case file. - """ - return PyMenu(self.service, "/file/import/abaqus/input").execute(*args, **kwargs) - def odb(self, *args, **kwargs): - """ - Reads an ABAQUS odb file as a case file. - """ - return PyMenu(self.service, "/file/import/abaqus/odb").execute(*args, **kwargs) - - class cfx(metaclass=PyMenuMeta): - """ - Imports a CFX file. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def definition(self, *args, **kwargs): - """ - Reads a CFX definition file as a case file. - """ - return PyMenu(self.service, "/file/import/cfx/definition").execute(*args, **kwargs) - def result(self, *args, **kwargs): - """ - Reads a CFX definition file as a case file. - """ - return PyMenu(self.service, "/file/import/cfx/result").execute(*args, **kwargs) - - class cgns(metaclass=PyMenuMeta): - """ - Imports a CGNS file. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def mesh(self, *args, **kwargs): - """ - Imports a CGNS mesh file. - """ - return PyMenu(self.service, "/file/import/cgns/mesh").execute(*args, **kwargs) - def data(self, *args, **kwargs): - """ - Reads data from CGNS file. - """ - return PyMenu(self.service, "/file/import/cgns/data").execute(*args, **kwargs) - def mesh_data(self, *args, **kwargs): - """ - Imports a CGNS mesh file and data file. - """ - return PyMenu(self.service, "/file/import/cgns/mesh_data").execute(*args, **kwargs) - - class fmu_file(metaclass=PyMenuMeta): - """ - Enters the import FMU file menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def import_fmu(self, *args, **kwargs): - """ - Imports an FMU file. - """ - return PyMenu(self.service, "/file/import/fmu_file/import_fmu").execute(*args, **kwargs) - def define_fmu(self, *args, **kwargs): - """ - Links the FMU variables with the Fluent output parameters. - """ - return PyMenu(self.service, "/file/import/fmu_file/define_fmu").execute(*args, **kwargs) - def select_fmu_local(self, *args, **kwargs): - """ - Allows you to select FMU local variables to be monitored during the calculation. - """ - return PyMenu(self.service, "/file/import/fmu_file/select_fmu_local").execute(*args, **kwargs) - def set_fmu_parameter(self, *args, **kwargs): - """ - Allows you to select FMU parameter variables and change their values. - """ - return PyMenu(self.service, "/file/import/fmu_file/set_fmu_parameter").execute(*args, **kwargs) - - class flamelet(metaclass=PyMenuMeta): - """ - Imports a flamelet file. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def standard(self, *args, **kwargs): - """ - Reads a standard format flamelet file. - """ - return PyMenu(self.service, "/file/import/flamelet/standard").execute(*args, **kwargs) - def cfx_rif(self, *args, **kwargs): - """ - Reads a CFX-RIF format flamelet file. - """ - return PyMenu(self.service, "/file/import/flamelet/cfx_rif").execute(*args, **kwargs) - - class lstc(metaclass=PyMenuMeta): - """ - Imports an LSTC file. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def input(self, *args, **kwargs): - """ - Reads an LSTC input file as a case file. - """ - return PyMenu(self.service, "/file/import/lstc/input").execute(*args, **kwargs) - def state(self, *args, **kwargs): - """ - Reads an LSTC result file as a case file. - """ - return PyMenu(self.service, "/file/import/lstc/state").execute(*args, **kwargs) - - class nastran(metaclass=PyMenuMeta): - """ - Imports a NASTRAN file. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def bulkdata(self, *args, **kwargs): - """ - Reads a NASTRAN file as a case file. - """ - return PyMenu(self.service, "/file/import/nastran/bulkdata").execute(*args, **kwargs) - def output2(self, *args, **kwargs): - """ - Reads a NASTRAN op2 file as a case file. - """ - return PyMenu(self.service, "/file/import/nastran/output2").execute(*args, **kwargs) - - class partition(metaclass=PyMenuMeta): - """ - Enters the partition menu to set conditions for partitioning an ANSYS Fluent case file during read. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def metis(self, *args, **kwargs): - """ - Reads and partitions an ANSYS Fluent case file. - """ - return PyMenu(self.service, "/file/import/partition/metis").execute(*args, **kwargs) - def metis_zone(self, *args, **kwargs): - """ - Reads and partitions an ANSYS Fluent case file. - """ - return PyMenu(self.service, "/file/import/partition/metis_zone").execute(*args, **kwargs) - - class patran(metaclass=PyMenuMeta): - """ - Imports a PATRAN neutral file (zones defined by named components). - """ - def __init__(self, path, service): - self.path = path - self.service = service - def neutral(self, *args, **kwargs): - """ - Reads a PATRAN Neutral file (zones defined by named components) as a case file. - """ - return PyMenu(self.service, "/file/import/patran/neutral").execute(*args, **kwargs) - - class plot3d(metaclass=PyMenuMeta): - """ - Imports a PLOT3D file. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def mesh(self, *args, **kwargs): - """ - Reads a PLOT3D file as a case file. - """ - return PyMenu(self.service, "/file/import/plot3d/mesh").execute(*args, **kwargs) - - class tecplot(metaclass=PyMenuMeta): - """ - Enters the Tecplot menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def mesh(self, *args, **kwargs): - """ - Reads a Tecplot binary file as a case file. - """ - return PyMenu(self.service, "/file/import/tecplot/mesh").execute(*args, **kwargs) - - class interpolate(metaclass=PyMenuMeta): - """ - Interpolates data to/from another grid. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def write_data(self, *args, **kwargs): - """ - Writes data for interpolation. - """ - return PyMenu(self.service, "/file/interpolate/write_data").execute(*args, **kwargs) - def read_data(self, *args, **kwargs): - """ - Reads and interpolates data. - """ - return PyMenu(self.service, "/file/interpolate/read_data").execute(*args, **kwargs) - def zone_selection(self, *args, **kwargs): - """ - Defines a list of cell zone IDs. If specified, interpolation data will be read/written for these cell zones only. - """ - return PyMenu(self.service, "/file/interpolate/zone_selection").execute(*args, **kwargs) - - class fsi(metaclass=PyMenuMeta): - """ - Enters the fluid-structure interaction menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def read_fsi_mesh(self, *args, **kwargs): - """ - Reads an FEM mesh for one-way data mapping from ANSYS Fluent. - """ - return PyMenu(self.service, "/file/fsi/read_fsi_mesh").execute(*args, **kwargs) - def display_fsi_mesh(self, *args, **kwargs): - """ - Displays the mesh for a fluid-structure interaction. - """ - return PyMenu(self.service, "/file/fsi/display_fsi_mesh").execute(*args, **kwargs) - def write_fsi_mesh(self, *args, **kwargs): - """ - Writes a fluid-structure interaction mesh file. - """ - return PyMenu(self.service, "/file/fsi/write_fsi_mesh").execute(*args, **kwargs) - def conserve_force(self, *args, **kwargs): - """ - Conserve the forces for linear line, tri and tet elements. - """ - return PyMenu(self.service, "/file/fsi/conserve_force").execute(*args, **kwargs) - - class parametric_project(metaclass=PyMenuMeta): - """ - Enter to open, save, archive parametric project. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def open(self, *args, **kwargs): - """ - Open project. - """ - return PyMenu(self.service, "/file/parametric_project/open").execute(*args, **kwargs) - def save(self, *args, **kwargs): - """ - Save Project. - """ - return PyMenu(self.service, "/file/parametric_project/save").execute(*args, **kwargs) - def save_as(self, *args, **kwargs): - """ - Save As Project. - """ - return PyMenu(self.service, "/file/parametric_project/save_as").execute(*args, **kwargs) - def save_as_copy(self, *args, **kwargs): - """ - Save As Copy. - """ - return PyMenu(self.service, "/file/parametric_project/save_as_copy").execute(*args, **kwargs) - def archive(self, *args, **kwargs): - """ - Archive Project. - """ - return PyMenu(self.service, "/file/parametric_project/archive").execute(*args, **kwargs) - - class project(metaclass=PyMenuMeta): - """ - Enter to create new project, open project, save and archive project. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def new(self, *args, **kwargs): - """ - Create New Project. - """ - return PyMenu(self.service, "/file/project[beta]/new").execute(*args, **kwargs) - def open(self, *args, **kwargs): - """ - Open project. - """ - return PyMenu(self.service, "/file/project[beta]/open").execute(*args, **kwargs) - def save(self, *args, **kwargs): - """ - Save Project. - """ - return PyMenu(self.service, "/file/project[beta]/save").execute(*args, **kwargs) - def save_as(self, *args, **kwargs): - """ - Save As Project. - """ - return PyMenu(self.service, "/file/project[beta]/save_as").execute(*args, **kwargs) - def save_as_copy(self, *args, **kwargs): - """ - Save As Copy. - """ - return PyMenu(self.service, "/file/project[beta]/save_as_copy").execute(*args, **kwargs) - def archive(self, *args, **kwargs): - """ - Archive Project. - """ - return PyMenu(self.service, "/file/project[beta]/archive").execute(*args, **kwargs) - - class table_manager(metaclass=PyMenuMeta): - """ - Enters the table file manager menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def delete(self, *args, **kwargs): - """ - Deletes a table from local storage. - """ - return PyMenu(self.service, "/file/table_manager/delete").execute(*args, **kwargs) - def list_matrix_data(self, *args, **kwargs): - """ - Lists the data of a “matrix” type locally-stored table. - """ - return PyMenu(self.service, "/file/table_manager/list_matrix_data").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): - """ - Lists the properties of a locally-stored table. - """ - return PyMenu(self.service, "/file/table_manager/list_properties").execute(*args, **kwargs) - def list_tables(self, *args, **kwargs): - """ - Lists all locally-stored tables. - """ - return PyMenu(self.service, "/file/table_manager/list_tables").execute(*args, **kwargs) - def read_matrix_data_file(self, *args, **kwargs): - """ - Imports a “matrix” type table from a file into local storage. - """ - return PyMenu(self.service, "/file/table_manager/read_matrix_data_file").execute(*args, **kwargs) - def read_rgp_file(self, *args, **kwargs): - """ - Imports a set of Real Gas Property (RGP) tables from a file into local storage. - """ - return PyMenu(self.service, "/file/table_manager/read_rgp_file").execute(*args, **kwargs) - def rename(self, *args, **kwargs): - """ - Renames a locally-stored table. - """ - return PyMenu(self.service, "/file/table_manager/rename").execute(*args, **kwargs) - def store_in_case_file(self, *args, **kwargs): - """ - Sets the persistence mode for RGP tables (embedded in case file or rely on external file). - """ - return PyMenu(self.service, "/file/table_manager/store_in_case_file").execute(*args, **kwargs) - - class solution_files(metaclass=PyMenuMeta): - """ - Enters the solution files menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def print_solution_files(self, *args, **kwargs): - """ - Prints a list of available solution files. - """ - return PyMenu(self.service, "/file/solution_files/print_solution_files").execute(*args, **kwargs) - def load_solution(self, *args, **kwargs): - """ - Loads a solution file. - """ - return PyMenu(self.service, "/file/solution_files/load_solution").execute(*args, **kwargs) - def delete_solution(self, *args, **kwargs): - """ - Deletes solution files. - """ - return PyMenu(self.service, "/file/solution_files/delete_solution").execute(*args, **kwargs) - - class icing(metaclass=PyMenuMeta): - """ - FENSAP-ICE options. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def file(self, *args, **kwargs): - """ - File menu. - """ - return PyMenu(self.service, "/icing/file").execute(*args, **kwargs) - def flow(self, *args, **kwargs): - """ - Flow solver menu. - """ - return PyMenu(self.service, "/icing/flow").execute(*args, **kwargs) - def drop(self, *args, **kwargs): - """ - Droplet impingement menu. - """ - return PyMenu(self.service, "/icing/drop").execute(*args, **kwargs) - def ice(self, *args, **kwargs): - """ - Ice accretion menu. - """ - return PyMenu(self.service, "/icing/ice").execute(*args, **kwargs) - def multishot(self, *args, **kwargs): - """ - Multi-shot accretion menu. - """ - return PyMenu(self.service, "/icing/multishot").execute(*args, **kwargs) - def settings(self, *args, **kwargs): - """ - Global settings menu. - """ - return PyMenu(self.service, "/icing/settings").execute(*args, **kwargs) - - class mesh(metaclass=PyMenuMeta): - """ - Enter the mesh menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.adapt = self.__class__.adapt(path + [("adapt", None)], service) - self.modify_zones = self.__class__.modify_zones(path + [("modify_zones", None)], service) - self.polyhedra = self.__class__.polyhedra(path + [("polyhedra", None)], service) - self.reorder = self.__class__.reorder(path + [("reorder", None)], service) - self.repair_improve = self.__class__.repair_improve(path + [("repair_improve", None)], service) - self.surface_mesh = self.__class__.surface_mesh(path + [("surface_mesh", None)], service) - def adjacency(self, *args, **kwargs): - """ - Views and renames face zones adjacent to selected cell zones. - """ - return PyMenu(self.service, "/mesh/adjacency").execute(*args, **kwargs) - def check(self, *args, **kwargs): - """ - Performs various mesh consistency checks and displays a report in the console that lists the domain extents, the volume statistics, the face area statistics, and any warnings, as well as details about the various checks and mesh failures (depending on the setting specified for mesh/check-verbosity). - """ - return PyMenu(self.service, "/mesh/check").execute(*args, **kwargs) - def check_before_solve(self, *args, **kwargs): - """ - The default value for mesh/check-before-solve is “no”. If mesh/check-before-solve is set to “yes”, a mesh check operation will be invoked prior to starting solver. If grid check fails, solver will be interrupted, and relevant information will be printed in the Fluent console. - """ - return PyMenu(self.service, "/mesh/check_before_solve").execute(*args, **kwargs) - def check_verbosity(self, *args, **kwargs): - """ - Sets the level of details that will be added to the mesh check report generated by mesh/check. A value of 0 (the default) notes when checks are being performed, but does not list them individually. A value of 1 lists the individual checks as they are performed. A value of 2 enables the availability of additional mesh field variables, lists the individual checks as they are performed, and provides additional details (for example, the location of the problem, the affected cells). The check-verbosity text command can also be used to set the level of detail displayed in the mesh quality report generated by mesh/quality. A value of 0 (the default) or 1 lists the minimum orthogonal quality and the maximum aspect ratio. A value of 2 adds information about the zones that contain the cells with the lowest quality, and additional metrics such as the maximum cell squish index and the minimum expansion ratio. - """ - return PyMenu(self.service, "/mesh/check_verbosity").execute(*args, **kwargs) - def enhanced_orthogonal_quality(self, *args, **kwargs): - """ - Enables / disables an enhanced definition when calculating the orthogonal quality. When enabled, the orthogonal quality is defined using a variety quality measures, including: the orthogonality of a face relative to a vector between the face and cell centroids; a metric that detects poor cell shape at a local edge (such as twisting and/or concavity); and the variation of normals between the faces that can be constructed from the cell face. This enhanced definition is optimal for evaluating thin prism cells. - """ - return PyMenu(self.service, "/mesh/enhanced_orthogonal_quality").execute(*args, **kwargs) - def mesh_info(self, *args, **kwargs): - """ - Prints zone information size. - """ - return PyMenu(self.service, "/mesh/mesh_info").execute(*args, **kwargs) - def memory_usage(self, *args, **kwargs): - """ - Reports solver memory use. - """ - return PyMenu(self.service, "/mesh/memory_usage").execute(*args, **kwargs) - def quality(self, *args, **kwargs): - """ - Displays information about the quality of the mesh in the console, including the minimum orthogonal quality and the maximum aspect ratio. The level of detail displayed depends on the setting specified for mesh/check-verbosity. - """ - return PyMenu(self.service, "/mesh/quality").execute(*args, **kwargs) - def redistribute_boundary_layer(self, *args, **kwargs): - """ - Redistributes the nodes in a boundary layer zone to achieve a desired growth rate after anisotropic adaption. - """ - return PyMenu(self.service, "/mesh/redistribute_boundary_layer").execute(*args, **kwargs) - def replace(self, *args, **kwargs): - """ - Replace mesh and interpolate data. - """ - return PyMenu(self.service, "/mesh/replace").execute(*args, **kwargs) - def rotate(self, *args, **kwargs): - """ - Rotates the mesh. - """ - return PyMenu(self.service, "/mesh/rotate").execute(*args, **kwargs) - def scale(self, *args, **kwargs): - """ - Prompts for the scaling factors in each of the active Cartesian coordinate directions. - """ - return PyMenu(self.service, "/mesh/scale").execute(*args, **kwargs) - def size_info(self, *args, **kwargs): - """ - Prints mesh size. - """ - return PyMenu(self.service, "/mesh/size_info").execute(*args, **kwargs) - def smooth_mesh(self, *args, **kwargs): - """ - Smooths the mesh using quality-based, Laplacian, or skewness methods. - """ - return PyMenu(self.service, "/mesh/smooth_mesh").execute(*args, **kwargs) - def swap_mesh_faces(self, *args, **kwargs): - """ - Swaps mesh faces. - """ - return PyMenu(self.service, "/mesh/swap_mesh_faces").execute(*args, **kwargs) - def show_periodic_shadow_zones(self, *args, **kwargs): - """ - Option to show periodic shadow zones in user interface. - """ - return PyMenu(self.service, "/mesh/show_periodic_shadow_zones").execute(*args, **kwargs) - def translate(self, *args, **kwargs): - """ - Prompts for the translation offset in each of the active Cartesian coordinate directions. - """ - return PyMenu(self.service, "/mesh/translate").execute(*args, **kwargs) - def set_unit_system(self, *args, **kwargs): - """ - To apply standard set of units to all quantities. - """ - return PyMenu(self.service, "/mesh/set_unit_system").execute(*args, **kwargs) - def units(self, *args, **kwargs): - """ - Set unit conversion factors. - """ - return PyMenu(self.service, "/mesh/units").execute(*args, **kwargs) - - class adapt(metaclass=PyMenuMeta): - """ - Enters the mesh adaption menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.set = self.__class__.set(path + [("set", None)], service) - self.profile = self.__class__.profile(path + [("profile", None)], service) - self.cell_registers = self.__class__.cell_registers(path + [("cell_registers", None)], service) - self.manage_criteria = self.__class__.manage_criteria(path + [("manage_criteria", None)], service) - self.multi_layer_refinement = self.__class__.multi_layer_refinement(path + [("multi_layer_refinement", None)], service) - self.geometry = self.__class__.geometry(path + [("geometry", None)], service) - def refinement_criteria(self, *args, **kwargs): - """ - Allows you to provide an expression for the refinement criterion. - """ - return PyMenu(self.service, "/mesh/adapt/refinement_criteria").execute(*args, **kwargs) - def coarsening_criteria(self, *args, **kwargs): - """ - Allows you to provide an expression for the coarsening criterion. - """ - return PyMenu(self.service, "/mesh/adapt/coarsening_criteria").execute(*args, **kwargs) - def manual_refinement_criteria(self, *args, **kwargs): - """ - Set expression for manual refinement criterion. - """ - return PyMenu(self.service, "/mesh/adapt/manual_refinement_criteria").execute(*args, **kwargs) - def manual_coarsening_criteria(self, *args, **kwargs): - """ - Set expression for manual coarsening criterion. - """ - return PyMenu(self.service, "/mesh/adapt/manual_coarsening_criteria").execute(*args, **kwargs) - def adapt_mesh(self, *args, **kwargs): - """ - Performs manual adaption on the mesh according to the methods and settings that you specified. - """ - return PyMenu(self.service, "/mesh/adapt/adapt_mesh").execute(*args, **kwargs) - def display_adaption_cells(self, *args, **kwargs): - """ - Displays the cells that are marked for adaption in the graphics window. - """ - return PyMenu(self.service, "/mesh/adapt/display_adaption_cells").execute(*args, **kwargs) - def list_adaption_cells(self, *args, **kwargs): - """ - Prints the number of cells marked for refinement, coarsening, and both to the console. - """ - return PyMenu(self.service, "/mesh/adapt/list_adaption_cells").execute(*args, **kwargs) - def free_hierarchy(self, *args, **kwargs): - """ - Deletes the defined adaption hierarchy. - """ - return PyMenu(self.service, "/mesh/adapt/free_hierarchy").execute(*args, **kwargs) - def anisotropic_adaption(self, *args, **kwargs): - """ - Applies legacy anisotropic adaption to refine the boundary layers or registers. Cells will be split in the normal direction to the boundary face. Note that this text command is only available for 3D cases that have the adaption method set to hanging node. - """ - return PyMenu(self.service, "/mesh/adapt/anisotropic_adaption").execute(*args, **kwargs) - - class set(metaclass=PyMenuMeta): - """ - Enters the set menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def method(self, *args, **kwargs): - """ - Sets the adaption method. - """ - return PyMenu(self.service, "/mesh/adapt/set/method").execute(*args, **kwargs) - def cell_zones(self, *args, **kwargs): - """ - Sets cell zones to be used for marking adaption. An empty list specifies that all zones are considered for adaption. - """ - return PyMenu(self.service, "/mesh/adapt/set/cell_zones").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Allows you set how much information about the adaption is printed to the console. - """ - return PyMenu(self.service, "/mesh/adapt/set/verbosity").execute(*args, **kwargs) - def encapsulate_children(self, *args, **kwargs): - """ - Encapsulate all children of parent cells on the same partition. - """ - return PyMenu(self.service, "/mesh/adapt/set/encapsulate_children").execute(*args, **kwargs) - def maximum_refinement_level(self, *args, **kwargs): - """ - Controls the number of levels of refinement used to split cells during the adaption. - """ - return PyMenu(self.service, "/mesh/adapt/set/maximum_refinement_level").execute(*args, **kwargs) - def minimum_edge_length(self, *args, **kwargs): - """ - Sets an approximate limit to the edge length for cells that are considered for refinement. Even if a cell is marked for refinement, it will not be refined if (for 3D) its volume is less than the cube of this field or (for 2D) its area is less than the square of this field. The default value of zero places no limits on the size of cells that are refined. - """ - return PyMenu(self.service, "/mesh/adapt/set/minimum_edge_length").execute(*args, **kwargs) - def minimum_cell_quality(self, *args, **kwargs): - """ - Sets the minimum value allowed for the orthogonal quality of cells during adaption. If your solution diverges, you may find that using a higher minimum quality value resolves the issue. This text command is only available with the PUMA 3D adaption method. - """ - return PyMenu(self.service, "/mesh/adapt/set/minimum_cell_quality").execute(*args, **kwargs) - def maximum_cell_count(self, *args, **kwargs): - """ - Sets an approximate limit to the total cell count of the mesh during adaption. Fluent uses this value to determine when to stop marking cells for refinement. A value of zero places no limits on the number of cells. - """ - return PyMenu(self.service, "/mesh/adapt/set/maximum_cell_count").execute(*args, **kwargs) - def additional_refinement_layers(self, *args, **kwargs): - """ - Allows you to specify additional refinement layers (this is an advanced control). - """ - return PyMenu(self.service, "/mesh/adapt/set/additional_refinement_layers").execute(*args, **kwargs) - def anisotropic_adaption(self, *args, **kwargs): - """ - Enables / disables anisotropic adaption for prismatic cells as part of manual adaption. Note that this text command requires that the adaption method is set to PUMA. - """ - return PyMenu(self.service, "/mesh/adapt/set/anisotropic_adaption").execute(*args, **kwargs) - def anisotropic_boundary_zones(self, *args, **kwargs): - """ - Allows you to select the boundary zones that specify directions for anisotropic refinement with the PUMA method. - """ - return PyMenu(self.service, "/mesh/adapt/set/anisotropic_boundary_zones").execute(*args, **kwargs) - def anisotropic_split_ratio(self, *args, **kwargs): - """ - Sets the split ratio for the cells as part of anisotropic refinement with the PUMA method. - """ - return PyMenu(self.service, "/mesh/adapt/set/anisotropic_split_ratio").execute(*args, **kwargs) - def display_settings(self, *args, **kwargs): - """ - Sets the graphics display options for the refinement, coarsening, and common cells. - """ - return PyMenu(self.service, "/mesh/adapt/set/display_settings").execute(*args, **kwargs) - def dynamic_adaption(self, *args, **kwargs): - """ - Adapt the mesh during solution. - """ - return PyMenu(self.service, "/mesh/adapt/set/dynamic_adaption").execute(*args, **kwargs) - def dynamic_adaption_frequency(self, *args, **kwargs): - """ - Set frequency for dynamic adaption. - """ - return PyMenu(self.service, "/mesh/adapt/set/dynamic_adaption_frequency").execute(*args, **kwargs) - def overset_adapt_dead_cells(self, *args, **kwargs): - """ - Enables/disables the adaption of dead cells in overset meshes. - """ - return PyMenu(self.service, "/mesh/adapt/set/overset_adapt_dead_cells").execute(*args, **kwargs) - - class profile(metaclass=PyMenuMeta): - """ - Enters the profile menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable(self, *args, **kwargs): - """ - Enables adaption profiling. - """ - return PyMenu(self.service, "/mesh/adapt/profile/enable").execute(*args, **kwargs) - def disable(self, *args, **kwargs): - """ - Disables adaption profiling. - """ - return PyMenu(self.service, "/mesh/adapt/profile/disable").execute(*args, **kwargs) - def print(self, *args, **kwargs): - """ - Prints adaption profiling results. - """ - return PyMenu(self.service, "/mesh/adapt/profile/print").execute(*args, **kwargs) - def clear(self, *args, **kwargs): - """ - Clears the adaption profiling counters. - """ - return PyMenu(self.service, "/mesh/adapt/profile/clear").execute(*args, **kwargs) - - class cell_registers(metaclass=PyMenuMeta): - """ - Enters the cell registers menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def adapt(self, *args, **kwargs): - """ - Adapt cell register objects. - """ - return PyMenu(self.service, "/mesh/adapt/cell_registers/adapt").execute(*args, **kwargs) - def add(self, *args, **kwargs): - """ - Creates a new cell register. - """ - return PyMenu(self.service, "/mesh/adapt/cell_registers/add").execute(*args, **kwargs) - def apply_poor_mesh_numerics(self, *args, **kwargs): - """ - Applies poor mesh numerics to the mesh of a cell register. - """ - return PyMenu(self.service, "/mesh/adapt/cell_registers/apply_poor_mesh_numerics").execute(*args, **kwargs) - def coarsen(self, *args, **kwargs): - """ - Coarsen the mesh based on a cell register. - """ - return PyMenu(self.service, "/mesh/adapt/cell_registers/coarsen").execute(*args, **kwargs) - def display(self, *args, **kwargs): - """ - Displays a cell register. - """ - return PyMenu(self.service, "/mesh/adapt/cell_registers/display").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edits an existing cell register. - """ - return PyMenu(self.service, "/mesh/adapt/cell_registers/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes a cell register. - """ - return PyMenu(self.service, "/mesh/adapt/cell_registers/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Lists all of the currently defined cell registers. - """ - return PyMenu(self.service, "/mesh/adapt/cell_registers/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): - """ - Lists the properties of a cell register. - """ - return PyMenu(self.service, "/mesh/adapt/cell_registers/list_properties").execute(*args, **kwargs) - def refine(self, *args, **kwargs): - """ - Refine the mesh based on a cell register. - """ - return PyMenu(self.service, "/mesh/adapt/cell_registers/refine").execute(*args, **kwargs) - - class manage_criteria(metaclass=PyMenuMeta): - """ - Enters the manage criteria menu, which provides text commands for managing automatic adaption criteria. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def add(self, *args, **kwargs): - """ - Adds a new automatic adaption criterion. - """ - return PyMenu(self.service, "/mesh/adapt/manage_criteria/add").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edits an existing automatic adaption criterion. - """ - return PyMenu(self.service, "/mesh/adapt/manage_criteria/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes an existing automatic adaption criterion. - """ - return PyMenu(self.service, "/mesh/adapt/manage_criteria/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Lists all the existing automatic adaption criteria. - """ - return PyMenu(self.service, "/mesh/adapt/manage_criteria/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): - """ - Lists the properties of an existing automatic adaption criterion. - """ - return PyMenu(self.service, "/mesh/adapt/manage_criteria/list_properties").execute(*args, **kwargs) - - class multi_layer_refinement(metaclass=PyMenuMeta): - """ - Enter the multiple boundary layer refinement menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def refine_mesh(self, *args, **kwargs): - """ - Refine the mesh for multiple boundary layers. - """ - return PyMenu(self.service, "/mesh/adapt/multi_layer_refinement/refine_mesh").execute(*args, **kwargs) - def boundary_zones(self, *args, **kwargs): - """ - Specify boundary zones for refinement. - """ - return PyMenu(self.service, "/mesh/adapt/multi_layer_refinement/boundary_zones").execute(*args, **kwargs) - def layer_count(self, *args, **kwargs): - """ - Specify the layer count for refinement. - """ - return PyMenu(self.service, "/mesh/adapt/multi_layer_refinement/layer_count").execute(*args, **kwargs) - def parameters(self, *args, **kwargs): - """ - Specify parameters for multiple boundary layer refinement. - """ - return PyMenu(self.service, "/mesh/adapt/multi_layer_refinement/parameters").execute(*args, **kwargs) - - class geometry(metaclass=PyMenuMeta): - """ - Enters the geometry menu. Note that this text command menu is not available unless the adaption method is set to hanging node. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def reconstruct_geometry(self, *args, **kwargs): - """ - Enables/disables geometry-based adaption. - """ - return PyMenu(self.service, "/mesh/adapt/geometry/reconstruct_geometry").execute(*args, **kwargs) - def set_geometry_controls(self, *args, **kwargs): - """ - Sets geometry controls for wall zones. - """ - return PyMenu(self.service, "/mesh/adapt/geometry/set_geometry_controls").execute(*args, **kwargs) - - class modify_zones(metaclass=PyMenuMeta): - """ - Enters the zone modification menu. For a description of the items in this menu, see define/boundary-conditions/modify-zones. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def activate_cell_zone(self, *args, **kwargs): - """ - Activate a cell thread. - """ - return PyMenu(self.service, "/mesh/modify_zones/activate_cell_zone").execute(*args, **kwargs) - def append_mesh(self, *args, **kwargs): - """ - Append new mesh. - """ - return PyMenu(self.service, "/mesh/modify_zones/append_mesh").execute(*args, **kwargs) - def append_mesh_data(self, *args, **kwargs): - """ - Append new mesh with data. - """ - return PyMenu(self.service, "/mesh/modify_zones/append_mesh_data").execute(*args, **kwargs) - def copy_move_cell_zone(self, *args, **kwargs): - """ - Copy and translate or rotate a cell zone. - """ - return PyMenu(self.service, "/mesh/modify_zones/copy_move_cell_zone").execute(*args, **kwargs) - def create_all_shell_threads(self, *args, **kwargs): - """ - Mark all finite thickness wall for shell creation. Shell zones will be created at the start of iterations. - """ - return PyMenu(self.service, "/mesh/modify_zones/create_all_shell_threads").execute(*args, **kwargs) - def deactivate_cell_zone(self, *args, **kwargs): - """ - Deactivate cell thread. - """ - return PyMenu(self.service, "/mesh/modify_zones/deactivate_cell_zone").execute(*args, **kwargs) - def recreate_all_shells(self, *args, **kwargs): - """ - Create shell on all the walls where which were deleted using the command delete-all-shells. - """ - return PyMenu(self.service, "/mesh/modify_zones/recreate_all_shells").execute(*args, **kwargs) - def delete_all_shells(self, *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. - """ - return PyMenu(self.service, "/mesh/modify_zones/delete_all_shells").execute(*args, **kwargs) - def delete_cell_zone(self, *args, **kwargs): - """ - Delete a cell thread. - """ - return PyMenu(self.service, "/mesh/modify_zones/delete_cell_zone").execute(*args, **kwargs) - def extrude_face_zone_delta(self, *args, **kwargs): - """ - Extrude a face thread a specified distance based on a list of deltas. - """ - return PyMenu(self.service, "/mesh/modify_zones/extrude_face_zone_delta").execute(*args, **kwargs) - def extrude_face_zone_para(self, *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). - """ - return PyMenu(self.service, "/mesh/modify_zones/extrude_face_zone_para").execute(*args, **kwargs) - def fuse_face_zones(self, *args, **kwargs): - """ - Attempt to fuse zones by removing duplicate faces and nodes. - """ - return PyMenu(self.service, "/mesh/modify_zones/fuse_face_zones").execute(*args, **kwargs) - def list_zones(self, *args, **kwargs): - """ - List zone IDs, types, kinds, and names. - """ - return PyMenu(self.service, "/mesh/modify_zones/list_zones").execute(*args, **kwargs) - def make_periodic(self, *args, **kwargs): - """ - Attempt to establish periodic/shadow face zone connectivity. - """ - return PyMenu(self.service, "/mesh/modify_zones/make_periodic").execute(*args, **kwargs) - def create_periodic_interface(self, *args, **kwargs): - """ - Create a conformal or non-conformal periodic interface. - """ - return PyMenu(self.service, "/mesh/modify_zones/create_periodic_interface").execute(*args, **kwargs) - def scale_zone(self, *args, **kwargs): - """ - Scale nodal coordinates of input cell zones. - """ - return PyMenu(self.service, "/mesh/modify_zones/scale_zone").execute(*args, **kwargs) - def rotate_zone(self, *args, **kwargs): - """ - Rotate nodal coordinates of input cell zones. - """ - return PyMenu(self.service, "/mesh/modify_zones/rotate_zone").execute(*args, **kwargs) - def translate_zone(self, *args, **kwargs): - """ - Translate nodal coordinates of input cell zones. - """ - return PyMenu(self.service, "/mesh/modify_zones/translate_zone").execute(*args, **kwargs) - def matching_tolerance(self, *args, **kwargs): - """ - Set the normalized tolerance used for finding coincident nodes. - """ - return PyMenu(self.service, "/mesh/modify_zones/matching_tolerance").execute(*args, **kwargs) - def merge_zones(self, *args, **kwargs): - """ - Merge zones of the same type and condition into one. - """ - return PyMenu(self.service, "/mesh/modify_zones/merge_zones").execute(*args, **kwargs) - def mrf_to_sliding_mesh(self, *args, **kwargs): - """ - Change motion specification from MRF to moving mesh. - """ - return PyMenu(self.service, "/mesh/modify_zones/mrf_to_sliding_mesh").execute(*args, **kwargs) - def convert_all_solid_mrf_to_solid_motion(self, *args, **kwargs): - """ - Change all solid zones motion specification from MRF to solid motion. - """ - return PyMenu(self.service, "/mesh/modify_zones/convert_all_solid_mrf_to_solid_motion").execute(*args, **kwargs) - def orient_face_zone(self, *args, **kwargs): - """ - Orient the face zone. - """ - return PyMenu(self.service, "/mesh/modify_zones/orient_face_zone").execute(*args, **kwargs) - def replace_zone(self, *args, **kwargs): - """ - Replace a cell zone. - """ - return PyMenu(self.service, "/mesh/modify_zones/replace_zone").execute(*args, **kwargs) - def sep_cell_zone_mark(self, *args, **kwargs): - """ - Separate a cell zone based on cell marking. - """ - return PyMenu(self.service, "/mesh/modify_zones/sep_cell_zone_mark").execute(*args, **kwargs) - def sep_cell_zone_region(self, *args, **kwargs): - """ - Separate a cell zone based on contiguous regions. - """ - return PyMenu(self.service, "/mesh/modify_zones/sep_cell_zone_region").execute(*args, **kwargs) - def sep_face_zone_angle(self, *args, **kwargs): - """ - Separate a face zone based on significant angle. - """ - return PyMenu(self.service, "/mesh/modify_zones/sep_face_zone_angle").execute(*args, **kwargs) - def sep_face_zone_face(self, *args, **kwargs): - """ - Separate each face in a zone into unique zone. - """ - return PyMenu(self.service, "/mesh/modify_zones/sep_face_zone_face").execute(*args, **kwargs) - def sep_face_zone_mark(self, *args, **kwargs): - """ - Separate a face zone based on cell marking. - """ - return PyMenu(self.service, "/mesh/modify_zones/sep_face_zone_mark").execute(*args, **kwargs) - def sep_face_zone_region(self, *args, **kwargs): - """ - Separate a face zone based on contiguous regions. - """ - return PyMenu(self.service, "/mesh/modify_zones/sep_face_zone_region").execute(*args, **kwargs) - def slit_periodic(self, *args, **kwargs): - """ - Slit a periodic zone into two symmetry zones. - """ - return PyMenu(self.service, "/mesh/modify_zones/slit_periodic").execute(*args, **kwargs) - def slit_face_zone(self, *args, **kwargs): - """ - Slit a two-sided wall into two connected wall zones. - """ - return PyMenu(self.service, "/mesh/modify_zones/slit_face_zone").execute(*args, **kwargs) - def slit_interior_between_diff_solids(self, *args, **kwargs): - """ - Slit interior created between different solids into coupled walls. - """ - return PyMenu(self.service, "/mesh/modify_zones/slit_interior_between_diff_solids").execute(*args, **kwargs) - def zone_name(self, *args, **kwargs): - """ - Give a zone a new name. - """ - return PyMenu(self.service, "/mesh/modify_zones/zone_name").execute(*args, **kwargs) - def zone_type(self, *args, **kwargs): - """ - Set a zone's type. - """ - return PyMenu(self.service, "/mesh/modify_zones/zone_type").execute(*args, **kwargs) - def copy_mrf_to_mesh_motion(self, *args, **kwargs): - """ - Copy motion variable values for origin, axis and velocities from Frame Motion to Mesh Motion. - """ - return PyMenu(self.service, "/mesh/modify_zones/copy_mrf_to_mesh_motion").execute(*args, **kwargs) - def copy_mesh_to_mrf_motion(self, *args, **kwargs): - """ - Copy motion variable values for origin, axis and velocities from Mesh Motion to Frame Motion. - """ - return PyMenu(self.service, "/mesh/modify_zones/copy_mesh_to_mrf_motion").execute(*args, **kwargs) - def change_zone_state(self, *args, **kwargs): - """ - Change the realgas material state for a zone. - """ - return PyMenu(self.service, "/mesh/modify_zones/change_zone_state").execute(*args, **kwargs) - def change_zone_phase(self, *args, **kwargs): - """ - Change the realgas phase for a zone. - """ - return PyMenu(self.service, "/mesh/modify_zones/change_zone_phase").execute(*args, **kwargs) - - class polyhedra(metaclass=PyMenuMeta): - """ - Enters the polyhedra menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.options = self.__class__.options(path + [("options", None)], service) - def convert_domain(self, *args, **kwargs): - """ - Converts the entire domain to polyhedra cells. - """ - return PyMenu(self.service, "/mesh/polyhedra/convert_domain").execute(*args, **kwargs) - def convert_hanging_nodes(self, *args, **kwargs): - """ - Converts cells with hanging nodes/edges to polyhedra. - """ - return PyMenu(self.service, "/mesh/polyhedra/convert_hanging_nodes").execute(*args, **kwargs) - def convert_hanging_nodes_zones(self, *args, **kwargs): - """ - Convert selected cell zones with hanging nodes and faces to polyhedra. - The selected cell zones cannot be connected to other zones. - """ - return PyMenu(self.service, "/mesh/polyhedra/convert_hanging_nodes_zones").execute(*args, **kwargs) - def convert_skewed_cells(self, *args, **kwargs): - """ - Converts skewed cells to polyhedra. - """ - return PyMenu(self.service, "/mesh/polyhedra/convert_skewed_cells").execute(*args, **kwargs) - - class options(metaclass=PyMenuMeta): - """ - Enters the polyhedra options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def migrate_and_reorder(self, *args, **kwargs): - """ - Enables / disables the migration of newly created partitions to the compute-nodes and the reordering of the domain as part of polyhedra conversion. This is disabled by default, because it requires significant additional memory; when disabled, it is recommended that you save the case file after conversion, read it in a new Fluent session (so that the new / stored partitions become active), and then manually reorder using the mesh/reorder/reorder-domain text command. If you want to run the calculation in the current Fluent session you can enable the migrate-and-reorder? text command prior to conversion, but you must ensure that no more than half of the available memory of your system is currently used. - """ - return PyMenu(self.service, "/mesh/polyhedra/options/migrate_and_reorder").execute(*args, **kwargs) - def preserve_boundary_layer(self, *args, **kwargs): - """ - Specifies whether boundary layer cells will be preserved when the domain is converted to polyhedra. When the value is set to 0 (default) ANSYS Fluent checks for high aspect ratio cells at the boundary layer and if any are found, Fluent asks if you want to preserve the boundary layer. When the value is set to 1, the boundary layer cells are never preserved; when it is set to 2, the boundary layer cells are always preserved (regardless of the aspect ratio of the boundary layer cells). - """ - return PyMenu(self.service, "/mesh/polyhedra/options/preserve_boundary_layer").execute(*args, **kwargs) - def preserve_interior_zones(self, *args, **kwargs): - """ - Enables the preservation of surfaces (that is, manifold zones of type interior) during the conversion of the domain to polyhedra. Note that only those zones with a name that includes the string you specify will be preserved. - """ - return PyMenu(self.service, "/mesh/polyhedra/options/preserve_interior_zones").execute(*args, **kwargs) - - class reorder(metaclass=PyMenuMeta): - """ - Reorders domain menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def band_width(self, *args, **kwargs): - """ - Prints cell bandwidth. - """ - return PyMenu(self.service, "/mesh/reorder/band_width").execute(*args, **kwargs) - def reorder_domain(self, *args, **kwargs): - """ - Reorders cells and faces using the reverse Cuthill-McKee algorithm. Note that you must save a new case file (and a data file, if data exists) after reordering with this text command, as well as recreate any ray files and/or surface cluster information. - """ - return PyMenu(self.service, "/mesh/reorder/reorder_domain").execute(*args, **kwargs) - def reorder_zones(self, *args, **kwargs): - """ - Reorders zones by partition, type, and ID. - """ - return PyMenu(self.service, "/mesh/reorder/reorder_zones").execute(*args, **kwargs) - - class repair_improve(metaclass=PyMenuMeta): - """ - Enter the repair and improve quality menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def report_poor_elements(self, *args, **kwargs): - """ - Reports invalid and poor quality elements. - """ - return PyMenu(self.service, "/mesh/repair_improve/report_poor_elements").execute(*args, **kwargs) - def improve_quality(self, *args, **kwargs): - """ - Improves poor quality cells in the mesh, if possible. - """ - return PyMenu(self.service, "/mesh/repair_improve/improve_quality").execute(*args, **kwargs) - def repair(self, *args, **kwargs): - """ - Repairs mesh problems identified by the mesh check, if possible. The repairs include fixing cells that have the wrong node order, the wrong face handedness, faces that are small or nonexistent, or very poor quality. Only interior nodes are repositioned by default; boundary nodes may be repositioned if the mesh/repair-improve/allow-repair-at-boundaries text command is enabled. Note that highly skewed cells may be converted into polyhedra, depending on whether the mesh/repair-improve/include-local-polyhedra-conversion-in-repair text command is enabled. - """ - return PyMenu(self.service, "/mesh/repair_improve/repair").execute(*args, **kwargs) - def repair_face_handedness(self, *args, **kwargs): - """ - Modifies cell centroids to repair meshes that contain left-handed faces without face node order problems. - """ - return PyMenu(self.service, "/mesh/repair_improve/repair_face_handedness").execute(*args, **kwargs) - def repair_face_node_order(self, *args, **kwargs): - """ - Modifies face nodes to repair faces with improper face node order and, therefore, eliminates any resulting left-handed faces. - """ - return PyMenu(self.service, "/mesh/repair_improve/repair_face_node_order").execute(*args, **kwargs) - def repair_periodic(self, *args, **kwargs): - """ - Modifies the mesh to enforce a rotational angle or translational distance for periodic boundaries. For translationally periodic boundaries, the command computes an average translation distance and adjusts the node coordinates on the shadow face zone to match this distance. For rotationally periodic boundaries, the command prompts for an angle and adjusts the node coordinates on the shadow face zone using this angle and the defined rotational axis for the cell zone. - """ - return PyMenu(self.service, "/mesh/repair_improve/repair_periodic").execute(*args, **kwargs) - def repair_wall_distance(self, *args, **kwargs): - """ - Corrects wall distance at very high aspect ratio hexahedral/polyhedral cells. - """ - return PyMenu(self.service, "/mesh/repair_improve/repair_wall_distance").execute(*args, **kwargs) - def allow_repair_at_boundaries(self, *args, **kwargs): - """ - Allows the adjustment of the positions of nodes on boundaries as part of the mesh repairs performed by the mesh/repair-improve/repair text command. - """ - return PyMenu(self.service, "/mesh/repair_improve/allow_repair_at_boundaries").execute(*args, **kwargs) - def include_local_polyhedra_conversion_in_repair(self, *args, **kwargs): - """ - Enables/disables the local conversion of degenerate cells into polyhedra based on skewness criteria as part of the mesh repairs performed by the mesh/repair-improve/repair text command. - """ - return PyMenu(self.service, "/mesh/repair_improve/include_local_polyhedra_conversion_in_repair").execute(*args, **kwargs) - - class surface_mesh(metaclass=PyMenuMeta): - """ - Enters the Surface Mesh menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def delete(self, *args, **kwargs): - """ - Deletes surface mesh. - """ - return PyMenu(self.service, "/mesh/surface_mesh/delete").execute(*args, **kwargs) - def display(self, *args, **kwargs): - """ - Displays surface meshes. - """ - return PyMenu(self.service, "/mesh/surface_mesh/display").execute(*args, **kwargs) - def read(self, *args, **kwargs): - """ - Reads surface meshes. - """ - return PyMenu(self.service, "/mesh/surface_mesh/read").execute(*args, **kwargs) - - class parameters__and__customization(metaclass=PyMenuMeta): - """ - Enter Parameters and custom menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.parameters = self.__class__.parameters(path + [("parameters", None)], service) - self.user_defined = self.__class__.user_defined(path + [("user_defined", None)], service) - - class parameters(metaclass=PyMenuMeta): - """ - Enter the parameters menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.input_parameters = self.__class__.input_parameters(path + [("input_parameters", None)], service) - self.output_parameters = self.__class__.output_parameters(path + [("output_parameters", None)], service) - self.list_parameters = self.__class__.list_parameters(path + [("list_parameters", None)], service) - def enable_in_TUI(self, *args, **kwargs): - """ - Enable/disable parameters in the text user interface. - """ - return PyMenu(self.service, "/parameters__and__customization/parameters/enable_in_TUI").execute(*args, **kwargs) - - class input_parameters(metaclass=PyMenuMeta): - """ - Enter the input-parameters menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.advance = self.__class__.advance(path + [("advance", None)], service) - def edit(self, *args, **kwargs): - """ - Edit an input parameter. - """ - return PyMenu(self.service, "/parameters__and__customization/parameters/input_parameters/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Delete an input parameter. - """ - return PyMenu(self.service, "/parameters__and__customization/parameters/input_parameters/delete").execute(*args, **kwargs) - - class advance(metaclass=PyMenuMeta): - """ - Define custom variable to use input parameter. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def use_in(self, *args, **kwargs): - """ - Use input parameter in solver-udf or in scheme-procedure. - """ - return PyMenu(self.service, "/parameters__and__customization/parameters/input_parameters/advance/use_in").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - List of custom-input-parameters. - """ - return PyMenu(self.service, "/parameters__and__customization/parameters/input_parameters/advance/list").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Delete selected custom-input-parameters. - """ - return PyMenu(self.service, "/parameters__and__customization/parameters/input_parameters/advance/delete").execute(*args, **kwargs) - - class output_parameters(metaclass=PyMenuMeta): - """ - Enter the output-parameters menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def create(self, *args, **kwargs): - """ - Create an output parameter. - """ - return PyMenu(self.service, "/parameters__and__customization/parameters/output_parameters/create").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edit an output parameter. - """ - return PyMenu(self.service, "/parameters__and__customization/parameters/output_parameters/edit").execute(*args, **kwargs) - def rename(self, *args, **kwargs): - """ - Rename an output parameter. - """ - return PyMenu(self.service, "/parameters__and__customization/parameters/output_parameters/rename").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Delete an output parameter. - """ - return PyMenu(self.service, "/parameters__and__customization/parameters/output_parameters/delete").execute(*args, **kwargs) - def print_to_console(self, *args, **kwargs): - """ - Print parameter value to console. - """ - return PyMenu(self.service, "/parameters__and__customization/parameters/output_parameters/print_to_console").execute(*args, **kwargs) - def print_all_to_console(self, *args, **kwargs): - """ - Print all parameter values to console. - """ - return PyMenu(self.service, "/parameters__and__customization/parameters/output_parameters/print_all_to_console").execute(*args, **kwargs) - def write_to_file(self, *args, **kwargs): - """ - Write parameter value to file. - """ - return PyMenu(self.service, "/parameters__and__customization/parameters/output_parameters/write_to_file").execute(*args, **kwargs) - def write_all_to_file(self, *args, **kwargs): - """ - Write all parameter values to file. - """ - return PyMenu(self.service, "/parameters__and__customization/parameters/output_parameters/write_all_to_file").execute(*args, **kwargs) - - class list_parameters(metaclass=PyMenuMeta): - """ - Enter list-param menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def input_parameters(self, *args, **kwargs): - """ - List all input parameters. - """ - return PyMenu(self.service, "/parameters__and__customization/parameters/list_parameters/input_parameters").execute(*args, **kwargs) - def output_parameters(self, *args, **kwargs): - """ - List all output parameters. - """ - return PyMenu(self.service, "/parameters__and__customization/parameters/list_parameters/output_parameters").execute(*args, **kwargs) - - class user_defined(metaclass=PyMenuMeta): - """ - Enter the user-defined functions and scalars menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.real_gas_models = self.__class__.real_gas_models(path + [("real_gas_models", None)], service) - def auto_compile_compiled_udfs(self, *args, **kwargs): - """ - For this Fluent session, specify whether to allow auto-compilation of compiled UDF when a case file (or settings file) is read. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/auto_compile_compiled_udfs").execute(*args, **kwargs) - def compiled_functions(self, *args, **kwargs): - """ - Open user-defined function library. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/compiled_functions").execute(*args, **kwargs) - def use_built_in_compiler(self, *args, **kwargs): - """ - Enable/disable the use of the built-in compiler. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/use_built_in_compiler").execute(*args, **kwargs) - def interpreted_functions(self, *args, **kwargs): - """ - Load interpreted user-defined functions. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/interpreted_functions").execute(*args, **kwargs) - def function_hooks(self, *args, **kwargs): - """ - Hook up user-defined functions. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/function_hooks").execute(*args, **kwargs) - def execute_on_demand(self, *args, **kwargs): - """ - Execute UDFs on demand. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/execute_on_demand").execute(*args, **kwargs) - def user_defined_memory(self, *args, **kwargs): - """ - Allocate user-defined memory. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/user_defined_memory").execute(*args, **kwargs) - def user_defined_node_memory(self, *args, **kwargs): - """ - Allocate user-defined node memory. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/user_defined_node_memory").execute(*args, **kwargs) - def use_contributed_cpp(self, *args, **kwargs): - """ - Enable/disable use of cpp from the Fluent.Inc/contrib directory. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/use_contributed_cpp").execute(*args, **kwargs) - def fan_model(self, *args, **kwargs): - """ - Configure user-defined fan model. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/fan_model").execute(*args, **kwargs) - def one_D_coupling(self, *args, **kwargs): - """ - Load 1D library. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/one_D_coupling").execute(*args, **kwargs) - def user_defined_scalars(self, *args, **kwargs): - """ - Define user-defined scalars. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/user_defined_scalars").execute(*args, **kwargs) - def enable_udf_on_gpu(self, *args, **kwargs): - """ - Compile UDFs with OpenCL support. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/enable_udf_on_gpu").execute(*args, **kwargs) - def compile_customized_addon_module(self, *args, **kwargs): - """ - Compile customized addon module?. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/compile_customized_addon_module").execute(*args, **kwargs) - - class real_gas_models(metaclass=PyMenuMeta): - """ - Enable/configure real gas model. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def nist_real_gas_model(self, *args, **kwargs): - """ - Load NIST real gas library. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/real_gas_models/nist_real_gas_model").execute(*args, **kwargs) - def nist_multispecies_real_gas_model(self, *args, **kwargs): - """ - Load NIST real gas library. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/real_gas_models/nist_multispecies_real_gas_model").execute(*args, **kwargs) - def set_state(self, *args, **kwargs): - """ - Select state for NIST real gas model. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/real_gas_models/set_state").execute(*args, **kwargs) - def nist_settings(self, *args, **kwargs): - """ - Select refprop library. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/real_gas_models/nist_settings").execute(*args, **kwargs) - def user_defined_real_gas_model(self, *args, **kwargs): - """ - Load user-defined real gas library. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/real_gas_models/user_defined_real_gas_model").execute(*args, **kwargs) - def user_defined_multispecies_real_gas_model(self, *args, **kwargs): - """ - Load user-defined multispecies real gas library. - """ - return PyMenu(self.service, "/parameters__and__customization/user_defined/real_gas_models/user_defined_multispecies_real_gas_model").execute(*args, **kwargs) - - class parallel(metaclass=PyMenuMeta): - """ - Enter the parallel processing menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.network = self.__class__.network(path + [("network", None)], service) - self.partition = self.__class__.partition(path + [("partition", None)], service) - self.set = self.__class__.set(path + [("set", None)], service) - self.load_balance = self.__class__.load_balance(path + [("load_balance", None)], service) - self.gpgpu = self.__class__.gpgpu(path + [("gpgpu", None)], service) - self.timer = self.__class__.timer(path + [("timer", None)], service) - self.multidomain = self.__class__.multidomain(path + [("multidomain", None)], service) - def check(self, *args, **kwargs): - """ - Performs checks of various factors that affect parallel performance. - """ - return PyMenu(self.service, "/parallel/check").execute(*args, **kwargs) - def check_verbosity(self, *args, **kwargs): - """ - Sets verbosity output of the parallel check. Higher verbosity corresponds to more detailed information. - """ - return PyMenu(self.service, "/parallel/check_verbosity").execute(*args, **kwargs) - def show_connectivity(self, *args, **kwargs): - """ - Prints the network connectivity for the selected compute node. - """ - return PyMenu(self.service, "/parallel/show_connectivity").execute(*args, **kwargs) - def latency(self, *args, **kwargs): - """ - Shows network latency. - """ - return PyMenu(self.service, "/parallel/latency").execute(*args, **kwargs) - def bandwidth(self, *args, **kwargs): - """ - Shows network bandwidth. - """ - return PyMenu(self.service, "/parallel/bandwidth").execute(*args, **kwargs) - def thread_number_control(self, *args, **kwargs): - """ - Thread number control. - """ - return PyMenu(self.service, "/parallel/thread_number_control").execute(*args, **kwargs) - - class network(metaclass=PyMenuMeta): - """ - Enter the network configuration menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def kill_all_nodes(self, *args, **kwargs): - """ - Delete all compute nodes from virtual machine. - """ - return PyMenu(self.service, "/parallel/network/kill_all_nodes").execute(*args, **kwargs) - def kill_node(self, *args, **kwargs): - """ - Kill a compute node process specified by ID. - """ - return PyMenu(self.service, "/parallel/network/kill_node").execute(*args, **kwargs) - def load_hosts(self, *args, **kwargs): - """ - Read a hosts file. - """ - return PyMenu(self.service, "/parallel/network/load_hosts").execute(*args, **kwargs) - def path(self, *args, **kwargs): - """ - Set the Fluent shell script path. - """ - return PyMenu(self.service, "/parallel/network/path").execute(*args, **kwargs) - def save_hosts(self, *args, **kwargs): - """ - Write a hosts file. - """ - return PyMenu(self.service, "/parallel/network/save_hosts").execute(*args, **kwargs) - def spawn_node(self, *args, **kwargs): - """ - Spawn a compute node process on a specified machine. - """ - return PyMenu(self.service, "/parallel/network/spawn_node").execute(*args, **kwargs) - - class partition(metaclass=PyMenuMeta): - """ - Enters the partition domain menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.automatic = self.__class__.automatic(path + [("automatic", None)], service) - self.set = self.__class__.set(path + [("set", None)], service) - def combine_partition(self, *args, **kwargs): - """ - Merges every N partitions. - """ - return PyMenu(self.service, "/parallel/partition/combine_partition").execute(*args, **kwargs) - def merge_clusters(self, *args, **kwargs): - """ - Calls the optimizer that attempts to decrease the number of interfaces by eliminating orphan cell clusters. (An orphan cluster is a group of connected cells such that each member has at least one face that is part of an interface boundary.) - """ - return PyMenu(self.service, "/parallel/partition/merge_clusters").execute(*args, **kwargs) - def method(self, *args, **kwargs): - """ - Sets the partition method. - """ - return PyMenu(self.service, "/parallel/partition/method").execute(*args, **kwargs) - def print_partitions(self, *args, **kwargs): - """ - Print partition information. - """ - return PyMenu(self.service, "/parallel/partition/print_partitions").execute(*args, **kwargs) - def print_active_partitions(self, *args, **kwargs): - """ - Prints active partition information (parallel solver). - """ - return PyMenu(self.service, "/parallel/partition/print_active_partitions").execute(*args, **kwargs) - def print_stored_partitions(self, *args, **kwargs): - """ - Prints stored partition information (parallel solver). - """ - return PyMenu(self.service, "/parallel/partition/print_stored_partitions").execute(*args, **kwargs) - def reorder_partitions(self, *args, **kwargs): - """ - Reorders partitions. - """ - return PyMenu(self.service, "/parallel/partition/reorder_partitions").execute(*args, **kwargs) - def reorder_partitions_to_architecture(self, *args, **kwargs): - """ - Reorders partitions to architecture. - """ - return PyMenu(self.service, "/parallel/partition/reorder_partitions_to_architecture").execute(*args, **kwargs) - def smooth_partition(self, *args, **kwargs): - """ - Calls the optimizer that attempts to minimize the number of interfaces by modifying the partition boundaries to reduce surface area. - """ - return PyMenu(self.service, "/parallel/partition/smooth_partition").execute(*args, **kwargs) - def use_stored_partitions(self, *args, **kwargs): - """ - Uses this partitioning. - """ - return PyMenu(self.service, "/parallel/partition/use_stored_partitions").execute(*args, **kwargs) - - class automatic(metaclass=PyMenuMeta): - """ - Enter the menu to set auto partition parameters. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def across_zones(self, *args, **kwargs): - """ - Enable auto partitioning by zone or by domain. - """ - return PyMenu(self.service, "/parallel/partition/automatic/across_zones").execute(*args, **kwargs) - def method(self, *args, **kwargs): - """ - Set the method for auto partitioning the domain. - """ - return PyMenu(self.service, "/parallel/partition/automatic/method").execute(*args, **kwargs) - def load_vector(self, *args, **kwargs): - """ - Set auto the partition load vector. - """ - return PyMenu(self.service, "/parallel/partition/automatic/load_vector").execute(*args, **kwargs) - def pre_test(self, *args, **kwargs): - """ - Set auto partition pre-testing optimization. - """ - return PyMenu(self.service, "/parallel/partition/automatic/pre_test").execute(*args, **kwargs) - def use_case_file_method(self, *args, **kwargs): - """ - Enable the use-case-file method for auto partitioning. - """ - return PyMenu(self.service, "/parallel/partition/automatic/use_case_file_method").execute(*args, **kwargs) - - class set(metaclass=PyMenuMeta): - """ - Enters the set partition parameters menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def across_zones(self, *args, **kwargs): - """ - Allows partitions to cross zone boundaries (the default). If turned off, it will restrict partitioning to within each cell zone. This is recommended only when cells in different zones require significantly different amounts of computation during the solution phase; for example, if the domain contains both solid and fluid zones. - """ - return PyMenu(self.service, "/parallel/partition/set/across_zones").execute(*args, **kwargs) - def all_off(self, *args, **kwargs): - """ - Disables all optimizations. - """ - return PyMenu(self.service, "/parallel/partition/set/all_off").execute(*args, **kwargs) - def all_on(self, *args, **kwargs): - """ - Enables all optimizations. - """ - return PyMenu(self.service, "/parallel/partition/set/all_on").execute(*args, **kwargs) - def cell_function(self, *args, **kwargs): - """ - Sets cell function. - """ - return PyMenu(self.service, "/parallel/partition/set/cell_function").execute(*args, **kwargs) - def load_distribution(self, *args, **kwargs): - """ - Sets the number of cells desired for each partition. This is useful, for example, when computing on multiple machines with significantly different performance characteristics. If left unset, each partition will contain an approximately equal number of cells. Normalized relative values may be used for the entries. - """ - return PyMenu(self.service, "/parallel/partition/set/load_distribution").execute(*args, **kwargs) - def merge(self, *args, **kwargs): - """ - Toggles the optimizer that attempts to decrease the number of interfaces by eliminating orphan cell clusters. - """ - return PyMenu(self.service, "/parallel/partition/set/merge").execute(*args, **kwargs) - def origin(self, *args, **kwargs): - """ - Sets the , , and coordinate of the origin used by those partitioning functions that require a radial distance. By default, the origin is set to (0, 0, 0). - """ - return PyMenu(self.service, "/parallel/partition/set/origin").execute(*args, **kwargs) - def pre_test(self, *args, **kwargs): - """ - Enables the operation that determines the best coordinate-splitting direction. - """ - return PyMenu(self.service, "/parallel/partition/set/pre_test").execute(*args, **kwargs) - def smooth(self, *args, **kwargs): - """ - Toggles the optimizer that attempts to minimize the number of interfaces by modifying the partition boundaries to reduce surface area. - """ - return PyMenu(self.service, "/parallel/partition/set/smooth").execute(*args, **kwargs) - def laplace_smoothing(self, *args, **kwargs): - """ - Laplace smoothing for mesh with stretched cells. - """ - return PyMenu(self.service, "/parallel/partition/set/laplace_smoothing").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Controls the amount of information that is printed out during partitioning. If set to 1 (the default), a text character. is displayed during each bisection, and partition statistics are displayed once the partitioning completes. If set to 2, additional information about the bisection operation is displayed during each bisection. If set to 0, partition statistics and information during each bisection are not displayed. - """ - return PyMenu(self.service, "/parallel/partition/set/verbosity").execute(*args, **kwargs) - def nfaces_as_weights(self, *args, **kwargs): - """ - Uses number of faces as weights. - """ - return PyMenu(self.service, "/parallel/partition/set/nfaces_as_weights").execute(*args, **kwargs) - def face_area_as_weights(self, *args, **kwargs): - """ - Uses face area as connection weights. - """ - return PyMenu(self.service, "/parallel/partition/set/face_area_as_weights").execute(*args, **kwargs) - def stretched_mesh_enhancement(self, *args, **kwargs): - """ - Enhancement for mesh with stretched cells. - """ - return PyMenu(self.service, "/parallel/partition/set/stretched_mesh_enhancement").execute(*args, **kwargs) - def layering(self, *args, **kwargs): - """ - Use layering for partitioning. - """ - return PyMenu(self.service, "/parallel/partition/set/layering").execute(*args, **kwargs) - def solid_thread_weight(self, *args, **kwargs): - """ - Uses solid thread weights. - """ - return PyMenu(self.service, "/parallel/partition/set/solid_thread_weight").execute(*args, **kwargs) - def particle_weight(self, *args, **kwargs): - """ - Sets DPM particle weight. - """ - return PyMenu(self.service, "/parallel/partition/set/particle_weight").execute(*args, **kwargs) - def vof_free_surface_weight(self, *args, **kwargs): - """ - Sets VOF free surface weight. - """ - return PyMenu(self.service, "/parallel/partition/set/vof_free_surface_weight").execute(*args, **kwargs) - def isat_weight(self, *args, **kwargs): - """ - Sets ISAT weight. - """ - return PyMenu(self.service, "/parallel/partition/set/isat_weight").execute(*args, **kwargs) - def model_weighted_partition(self, *args, **kwargs): - """ - Enables / disables model-weighted partitioning. This option works with the METIS partitioning method, and specifies that Fluent automatically calculates the weighting based on the cell count and the models and attributes specified as weights (using the parallel/partition/set/isat-weight text command, for example). - """ - return PyMenu(self.service, "/parallel/partition/set/model_weighted_partition").execute(*args, **kwargs) - def fluid_solid_rebalance_after_read_case(self, *args, **kwargs): - """ - Use optimal repartitioning after reading case file with significant solid and fluid zones. - """ - return PyMenu(self.service, "/parallel/partition/set/fluid_solid_rebalance_after_read_case").execute(*args, **kwargs) - def dpm_load_balancing(self, *args, **kwargs): - """ - Enables / disables dynamic load balancing for discrete phase model cases that use a second domain for DPM particle tracking (that is, cases for which you have enabled the define/models/dpm/parallel/hybrid-2domain? text command). - """ - return PyMenu(self.service, "/parallel/partition/set/dpm_load_balancing").execute(*args, **kwargs) - - class set(metaclass=PyMenuMeta): - """ - Enters the set parallel parameters menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def partition_mask(self, *args, **kwargs): - """ - Sets partition mask. - """ - return PyMenu(self.service, "/parallel/set/partition_mask").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Sets the parallel verbosity. - """ - return PyMenu(self.service, "/parallel/set/verbosity").execute(*args, **kwargs) - def time_out(self, *args, **kwargs): - """ - Sets spawn time-out in seconds. - """ - return PyMenu(self.service, "/parallel/set/time_out").execute(*args, **kwargs) - def fast_i(self, *args, **kwargs): - """ - Use fast I/O option. - """ - return PyMenu(self.service, "/parallel/set/fast_i").execute(*args, **kwargs) - - class load_balance(metaclass=PyMenuMeta): - """ - Enters the load balancing parameters menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def physical_models(self, *args, **kwargs): - """ - Uses physical-models load balancing? - """ - return PyMenu(self.service, "/parallel/load_balance/physical_models").execute(*args, **kwargs) - def dynamic_mesh(self, *args, **kwargs): - """ - Uses load balancing for dynamic mesh? - """ - return PyMenu(self.service, "/parallel/load_balance/dynamic_mesh").execute(*args, **kwargs) - def mesh_adaption(self, *args, **kwargs): - """ - Uses load balancing for mesh adaption? - """ - return PyMenu(self.service, "/parallel/load_balance/mesh_adaption").execute(*args, **kwargs) - - class gpgpu(metaclass=PyMenuMeta): - """ - Enters the GPGPU menu - """ - def __init__(self, path, service): - self.path = path - self.service = service - def show(self, *args, **kwargs): - """ - Lists the available GPGPUs. GPGPUs selected for use are indicated by the presence of an asterisk (*). - """ - return PyMenu(self.service, "/parallel/gpgpu/show").execute(*args, **kwargs) - def select(self, *args, **kwargs): - """ - Selects which GPGPUs to use for AMG acceleration - """ - return PyMenu(self.service, "/parallel/gpgpu/select").execute(*args, **kwargs) - - class timer(metaclass=PyMenuMeta): - """ - Enters the timer menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def usage(self, *args, **kwargs): - """ - Prints performance statistics in the console window. - """ - return PyMenu(self.service, "/parallel/timer/usage").execute(*args, **kwargs) - def reset(self, *args, **kwargs): - """ - Adjusts domain timers. - """ - return PyMenu(self.service, "/parallel/timer/reset").execute(*args, **kwargs) - - class multidomain(metaclass=PyMenuMeta): - """ - Enters the multidomain architecture menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.conjugate_heat_transfer = self.__class__.conjugate_heat_transfer(path + [("conjugate_heat_transfer", None)], service) - self.solve = self.__class__.solve(path + [("solve", None)], service) - - class conjugate_heat_transfer(metaclass=PyMenuMeta): - """ - Enters the conjugate heat transfer menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.set = self.__class__.set(path + [("set", None)], service) - def enable(self, *args, **kwargs): - """ - Enables/disables loosely coupled conjugate heat transfer. This works in conjunction with the solve/set/transient-controls/solid-time-step-size text command (and thereby enables the use of a user-specified time step size for solid zones that can be larger than that used for the fluid zones) to increase the robustness of the energy equation calculation, and specifies that multidomain architecture is used within a single Fluent session to enhance the performance of the simulation. - """ - return PyMenu(self.service, "/parallel/multidomain/conjugate_heat_transfer/enable").execute(*args, **kwargs) - - class set(metaclass=PyMenuMeta): - """ - Enters the set menu for loosely coupled conjugate heat transfer. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def session_mode(self, *args, **kwargs): - """ - Setup session mode (single/multiple) for multidomain conjugate heat transfer. - """ - return PyMenu(self.service, "/parallel/multidomain/conjugate_heat_transfer/set/session_mode").execute(*args, **kwargs) - def coupling(self, *args, **kwargs): - """ - Specifies when the fluid and solid zone calculations are coupled, either at a defined time period or number of fluid time steps. - """ - return PyMenu(self.service, "/parallel/multidomain/conjugate_heat_transfer/set/coupling").execute(*args, **kwargs) - def helper_session(self, *args, **kwargs): - """ - Setup helper session for multidomain conjugate heat transfer. - """ - return PyMenu(self.service, "/parallel/multidomain/conjugate_heat_transfer/set/helper_session").execute(*args, **kwargs) - - class solve(metaclass=PyMenuMeta): - """ - Enter the multi-domain simulation solver menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def iterate(self, *args, **kwargs): - """ - Iteration the multidomain conjugate heat transfer. - """ - return PyMenu(self.service, "/parallel/multidomain/solve/iterate").execute(*args, **kwargs) - def dual_time_iterate(self, *args, **kwargs): - """ - Dual-time iterate the multidomain conjugate heat transfer. - """ - return PyMenu(self.service, "/parallel/multidomain/solve/dual_time_iterate").execute(*args, **kwargs) - - class plot(metaclass=PyMenuMeta): - """ - Enter the XY plot menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.ansys_sound_analysis = self.__class__.ansys_sound_analysis(path + [("ansys_sound_analysis", None)], service) - self.cumulative_plot = self.__class__.cumulative_plot(path + [("cumulative_plot", None)], service) - self.flamelet_curves = self.__class__.flamelet_curves(path + [("flamelet_curves", None)], service) - def circum_avg_axial(self, *args, **kwargs): - """ - Computes iso-axial band surfaces and plots data vs. axial coordinate on them. - """ - return PyMenu(self.service, "/plot/circum_avg_axial").execute(*args, **kwargs) - def circum_avg_radial(self, *args, **kwargs): - """ - Computes iso-radial band surfaces and plots data vs. radius on them. - """ - return PyMenu(self.service, "/plot/circum_avg_radial").execute(*args, **kwargs) - def change_fft_ref_pressure(self, *args, **kwargs): - """ - Changes reference acoustic pressure. - """ - return PyMenu(self.service, "/plot/change_fft_ref_pressure").execute(*args, **kwargs) - def fft(self, *args, **kwargs): - """ - Plots fast Fourier transform (FFT) of file data. If you respond yes to Acoustic Analysis?, then additional Y axis functions are made available. - """ - return PyMenu(self.service, "/plot/fft").execute(*args, **kwargs) - def fft_set(self, *args, **kwargs): - """ - Enter the menu to set histogram plot parameters. - """ - return PyMenu(self.service, "/plot/fft_set").execute(*args, **kwargs) - def file(self, *args, **kwargs): - """ - Plots data from an external file. - """ - return PyMenu(self.service, "/plot/file").execute(*args, **kwargs) - def datasources(self, *args, **kwargs): - """ - Enters the menu for creating and modifying plots containing multiple data sources. - """ - return PyMenu(self.service, "/plot/datasources").execute(*args, **kwargs) - def display_profile_data(self, *args, **kwargs): - """ - Plots profile data. - """ - return PyMenu(self.service, "/plot/display_profile_data").execute(*args, **kwargs) - def file_list(self, *args, **kwargs): - """ - Plots data from multiple external files. - """ - return PyMenu(self.service, "/plot/file_list").execute(*args, **kwargs) - def file_set(self, *args, **kwargs): - """ - Sets file plot parameters. - """ - return PyMenu(self.service, "/plot/file_set").execute(*args, **kwargs) - def histogram(self, *args, **kwargs): - """ - Plots a histogram of the specified solution variable using the defined range and number of intervals. - """ - return PyMenu(self.service, "/plot/histogram").execute(*args, **kwargs) - def histogram_set(self, *args, **kwargs): - """ - Sets histogram plot parameters. Sub-menu items are the same as file-set/ above. - """ - return PyMenu(self.service, "/plot/histogram_set").execute(*args, **kwargs) - def plot(self, *args, **kwargs): - """ - Plots solution on surfaces. - """ - return PyMenu(self.service, "/plot/plot").execute(*args, **kwargs) - def plot_direction(self, *args, **kwargs): - """ - Sets plot direction for XY plot. - """ - return PyMenu(self.service, "/plot/plot_direction").execute(*args, **kwargs) - def residuals(self, *args, **kwargs): - """ - Contains commands that allow you to select the variables for which you want to display XY plots of residual histories in the active graphics window. - """ - return PyMenu(self.service, "/plot/residuals").execute(*args, **kwargs) - def residuals_set(self, *args, **kwargs): - """ - Sets residual plot parameters. Sub-menu items are the same as file-set/ above. - """ - return PyMenu(self.service, "/plot/residuals_set").execute(*args, **kwargs) - def solution(self, *args, **kwargs): - """ - Plots solution on surfaces and/or zones. Zone and surface names can be indicated using a wildcard (*). - """ - return PyMenu(self.service, "/plot/solution").execute(*args, **kwargs) - def solution_set(self, *args, **kwargs): - """ - Sets solution plot parameters. Sub-menu items are the same as file-set/ above. - """ - return PyMenu(self.service, "/plot/solution_set").execute(*args, **kwargs) - def set_boundary_val_off(self, *args, **kwargs): - """ - Disables the use of boundary face values when node values are disabled in solution XY plots. This option is disabled by default, that is, boundary face values are used when node values are disabled. - """ - return PyMenu(self.service, "/plot/set_boundary_val_off").execute(*args, **kwargs) - def label_alignment(self, *args, **kwargs): - """ - Set the orientation of XY plot axis labels as either horizontal or axis-aligned. - """ - return PyMenu(self.service, "/plot/label_alignment").execute(*args, **kwargs) - - class ansys_sound_analysis(metaclass=PyMenuMeta): - """ - Enter the Ansys sound analysis menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def write_files(self, *args, **kwargs): - """ - Read in a pressure signal or spectrum file, then optionally read in a frequency response function (FRF) or transfer function file, before writing a WAV, output pressure, and/or acoustic indicators file. - """ - return PyMenu(self.service, "/plot/ansys_sound_analysis/write_files").execute(*args, **kwargs) - def print_indicators(self, *args, **kwargs): - """ - Read in a pressure signal or spectrum file, then optionally read in a frequency response function (FRF) or transfer function file, before printing the acoustics indicators. - """ - return PyMenu(self.service, "/plot/ansys_sound_analysis/print_indicators").execute(*args, **kwargs) - - class cumulative_plot(metaclass=PyMenuMeta): - """ - Plot the development of force, force coefficient, moment, or moment coefficient across the specified wall zones. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def add(self, *args, **kwargs): - """ - Create a new cumulative plot. - """ - return PyMenu(self.service, "/plot/cumulative_plot/add").execute(*args, **kwargs) - def axes(self, *args, **kwargs): - """ - Set axes options of an object. - """ - return PyMenu(self.service, "/plot/cumulative_plot/axes").execute(*args, **kwargs) - def curves(self, *args, **kwargs): - """ - Set curves options of an object. - """ - return PyMenu(self.service, "/plot/cumulative_plot/curves").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edit an existing cumulative plot object. - """ - return PyMenu(self.service, "/plot/cumulative_plot/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Delete an existing cumulative plot object. - """ - return PyMenu(self.service, "/plot/cumulative_plot/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Print the names of the existing cumulative plot objects to the console. - """ - return PyMenu(self.service, "/plot/cumulative_plot/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): - """ - Print the properties of the specified cumulative plot object to the console. - """ - return PyMenu(self.service, "/plot/cumulative_plot/list_properties").execute(*args, **kwargs) - def plot(self, *args, **kwargs): - """ - Plot a cumulative plot in the graphics window. - """ - return PyMenu(self.service, "/plot/cumulative_plot/plot").execute(*args, **kwargs) - def print(self, *args, **kwargs): - """ - Print the value of a cumulative plot to the console. - """ - return PyMenu(self.service, "/plot/cumulative_plot/print").execute(*args, **kwargs) - def write(self, *args, **kwargs): - """ - Write a cumulative plot to a file. - """ - return PyMenu(self.service, "/plot/cumulative_plot/write").execute(*args, **kwargs) - - class flamelet_curves(metaclass=PyMenuMeta): - """ - Enters the flamelet curves menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def write_to_file(self, *args, **kwargs): - """ - Writes curve to a file instead of plot. - """ - return PyMenu(self.service, "/plot/flamelet_curves/write_to_file").execute(*args, **kwargs) - def plot_curves(self, *args, **kwargs): - """ - Plots of a curve property. - """ - return PyMenu(self.service, "/plot/flamelet_curves/plot_curves").execute(*args, **kwargs) - - class preferences(metaclass=PyMenuMeta): - """ - Set preferences. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.appearance = self.__class__.appearance(path + [("appearance", None)], service) - self.general = self.__class__.general(path + [("general", None)], service) - self.gpuapp = self.__class__.gpuapp(path + [("gpuapp", None)], service) - self.graphics = self.__class__.graphics(path + [("graphics", None)], service) - self.mat_pro_app = self.__class__.mat_pro_app(path + [("mat_pro_app", None)], service) - self.meshing_workflow = self.__class__.meshing_workflow(path + [("meshing_workflow", None)], service) - self.navigation = self.__class__.navigation(path + [("navigation", None)], service) - self.prj_app = self.__class__.prj_app(path + [("prj_app", None)], service) - self.simulation = self.__class__.simulation(path + [("simulation", None)], service) - self.turbo_workflow = self.__class__.turbo_workflow(path + [("turbo_workflow", None)], service) - - class appearance(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.ansys_logo = self.__class__.ansys_logo(path + [("ansys_logo", None)], service) - self.charts = self.__class__.charts(path + [("charts", None)], service) - self.selections = self.__class__.selections(path + [("selections", None)], service) - def application_font_size(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/application_font_size").execute(*args, **kwargs) - def axis_triad(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/axis_triad").execute(*args, **kwargs) - def color_theme(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/color_theme").execute(*args, **kwargs) - def completer(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/completer").execute(*args, **kwargs) - def custom_title_bar(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/custom_title_bar").execute(*args, **kwargs) - def default_view(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/default_view").execute(*args, **kwargs) - def graphics_background_color1(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/graphics_background_color1").execute(*args, **kwargs) - def graphics_background_color2(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/graphics_background_color2").execute(*args, **kwargs) - def graphics_background_style(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/graphics_background_style").execute(*args, **kwargs) - def graphics_color_theme(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/graphics_color_theme").execute(*args, **kwargs) - def graphics_default_manual_face_color(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/graphics_default_manual_face_color").execute(*args, **kwargs) - def graphics_default_manual_node_color(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/graphics_default_manual_node_color").execute(*args, **kwargs) - def graphics_edge_color(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/graphics_edge_color").execute(*args, **kwargs) - def graphics_foreground_color(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/graphics_foreground_color").execute(*args, **kwargs) - def graphics_partition_boundary_color(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/graphics_partition_boundary_color").execute(*args, **kwargs) - def graphics_surface_color(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/graphics_surface_color").execute(*args, **kwargs) - def graphics_title_window_framecolor(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/graphics_title_window_framecolor").execute(*args, **kwargs) - def graphics_view(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/graphics_view").execute(*args, **kwargs) - def graphics_wall_face_color(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/graphics_wall_face_color").execute(*args, **kwargs) - def group_by_tree_view(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/group_by_tree_view").execute(*args, **kwargs) - def model_color_scheme(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/model_color_scheme").execute(*args, **kwargs) - def number_of_files_recently_used(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/number_of_files_recently_used").execute(*args, **kwargs) - def number_of_pastel_colors(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/number_of_pastel_colors").execute(*args, **kwargs) - def pastel_color_saturation(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/pastel_color_saturation").execute(*args, **kwargs) - def pastel_color_value(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/pastel_color_value").execute(*args, **kwargs) - def quick_property_view(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/quick_property_view").execute(*args, **kwargs) - def ruler(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/ruler").execute(*args, **kwargs) - def show_enabled_models(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/show_enabled_models").execute(*args, **kwargs) - def show_interface_children_zone(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/show_interface_children_zone").execute(*args, **kwargs) - def show_model_edges(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/show_model_edges").execute(*args, **kwargs) - def solution_mode_edge_color_in_meshing_mode(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/solution_mode_edge_color_in_meshing_mode").execute(*args, **kwargs) - def startup_page(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/startup_page").execute(*args, **kwargs) - def surface_emissivity(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/surface_emissivity").execute(*args, **kwargs) - def surface_specularity(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/surface_specularity").execute(*args, **kwargs) - def surface_specularity_for_contours(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/surface_specularity_for_contours").execute(*args, **kwargs) - def titles(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/titles").execute(*args, **kwargs) - def titles_border_offset(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/titles_border_offset").execute(*args, **kwargs) - - class ansys_logo(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/ansys_logo/color").execute(*args, **kwargs) - def visible(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/ansys_logo/visible").execute(*args, **kwargs) - - class charts(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.font = self.__class__.font(path + [("font", None)], service) - self.text_color = self.__class__.text_color(path + [("text_color", None)], service) - def curve_colors(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/curve_colors").execute(*args, **kwargs) - def enable_open_glfor_modern_plots(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/enable_open_glfor_modern_plots").execute(*args, **kwargs) - def legend_alignment(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/legend_alignment").execute(*args, **kwargs) - def legend_visibility(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/legend_visibility").execute(*args, **kwargs) - def modern_plots_enabled(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/modern_plots_enabled").execute(*args, **kwargs) - def modern_plots_points_threshold(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/modern_plots_points_threshold").execute(*args, **kwargs) - def plots_behavior(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/plots_behavior").execute(*args, **kwargs) - def print_plot_data(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/print_plot_data").execute(*args, **kwargs) - def print_residuals_data(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/print_residuals_data").execute(*args, **kwargs) - def threshold(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/threshold").execute(*args, **kwargs) - - class font(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def axes(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/font/axes").execute(*args, **kwargs) - def axes_titles(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/font/axes_titles").execute(*args, **kwargs) - def legend(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/font/legend").execute(*args, **kwargs) - def title(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/font/title").execute(*args, **kwargs) - - class text_color(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def axes(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/text_color/axes").execute(*args, **kwargs) - def axes_titles(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/text_color/axes_titles").execute(*args, **kwargs) - def legend(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/text_color/legend").execute(*args, **kwargs) - def title(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/charts/text_color/title").execute(*args, **kwargs) - - class selections(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def general_displacement(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/selections/general_displacement").execute(*args, **kwargs) - def highlight_edge_color(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/selections/highlight_edge_color").execute(*args, **kwargs) - def highlight_edge_weight(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/selections/highlight_edge_weight").execute(*args, **kwargs) - def highlight_face_color(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/selections/highlight_face_color").execute(*args, **kwargs) - def highlight_gloss(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/selections/highlight_gloss").execute(*args, **kwargs) - def highlight_specular_component(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/selections/highlight_specular_component").execute(*args, **kwargs) - def highlight_transparency(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/selections/highlight_transparency").execute(*args, **kwargs) - def mouse_hover_probe_values_enabled(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/selections/mouse_hover_probe_values_enabled").execute(*args, **kwargs) - def mouse_over_highlight_enabled(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/selections/mouse_over_highlight_enabled").execute(*args, **kwargs) - def probe_tooltip_hide_delay_timer(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/selections/probe_tooltip_hide_delay_timer").execute(*args, **kwargs) - def probe_tooltip_show_delay_timer(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/appearance/selections/probe_tooltip_show_delay_timer").execute(*args, **kwargs) - - class general(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def advanced_partition(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/general/advanced_partition").execute(*args, **kwargs) - def automatic_transcript(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/general/automatic_transcript").execute(*args, **kwargs) - def default_ioformat(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/general/default_ioformat").execute(*args, **kwargs) - def dock_editor(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/general/dock_editor").execute(*args, **kwargs) - def enable_parametric_study(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/general/enable_parametric_study").execute(*args, **kwargs) - def flow_model(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/general/flow_model").execute(*args, **kwargs) - def idle_timeout(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/general/idle_timeout").execute(*args, **kwargs) - def key_behavioral_changes_message(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/general/key_behavioral_changes_message").execute(*args, **kwargs) - def qaservice_message(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/general/qaservice_message").execute(*args, **kwargs) - def utlcreate_physics_on_mode_change(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/general/utlcreate_physics_on_mode_change").execute(*args, **kwargs) - def utlmode(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/general/utlmode").execute(*args, **kwargs) - - class gpuapp(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def alpha_features(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/gpuapp/alpha_features").execute(*args, **kwargs) - - class graphics(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.boundary_markers = self.__class__.boundary_markers(path + [("boundary_markers", None)], service) - self.colormap_settings = self.__class__.colormap_settings(path + [("colormap_settings", None)], service) - self.embedded_windows = self.__class__.embedded_windows(path + [("embedded_windows", None)], service) - self.export_video_settings = self.__class__.export_video_settings(path + [("export_video_settings", None)], service) - self.graphics_effects = self.__class__.graphics_effects(path + [("graphics_effects", None)], service) - self.hardcopy_settings = self.__class__.hardcopy_settings(path + [("hardcopy_settings", None)], service) - self.lighting = self.__class__.lighting(path + [("lighting", None)], service) - self.manage_hoops_memory = self.__class__.manage_hoops_memory(path + [("manage_hoops_memory", None)], service) - self.material_effects = self.__class__.material_effects(path + [("material_effects", None)], service) - self.meshing_mode = self.__class__.meshing_mode(path + [("meshing_mode", None)], service) - self.performance = self.__class__.performance(path + [("performance", None)], service) - self.transparency = self.__class__.transparency(path + [("transparency", None)], service) - self.vector_settings = self.__class__.vector_settings(path + [("vector_settings", None)], service) - def animation_option(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/animation_option").execute(*args, **kwargs) - def double_buffering(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/double_buffering").execute(*args, **kwargs) - def enable_non_object_based_workflow(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/enable_non_object_based_workflow").execute(*args, **kwargs) - def event_poll_interval(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/event_poll_interval").execute(*args, **kwargs) - def event_poll_timeout(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/event_poll_timeout").execute(*args, **kwargs) - def force_key_frame_animation_markers_to_off(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/force_key_frame_animation_markers_to_off").execute(*args, **kwargs) - def graphics_window_line_width(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_window_line_width").execute(*args, **kwargs) - def graphics_window_point_symbol(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_window_point_symbol").execute(*args, **kwargs) - def hidden_surface_removal_method(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/hidden_surface_removal_method").execute(*args, **kwargs) - def higher_resolution_graphics_window_line_width(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/higher_resolution_graphics_window_line_width").execute(*args, **kwargs) - def lower_resolution_graphics_window_line_width(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/lower_resolution_graphics_window_line_width").execute(*args, **kwargs) - def marker_drawing_mode(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/marker_drawing_mode").execute(*args, **kwargs) - def max_graphics_text_size(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/max_graphics_text_size").execute(*args, **kwargs) - def min_graphics_text_size(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/min_graphics_text_size").execute(*args, **kwargs) - def new_material_infra(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/new_material_infra").execute(*args, **kwargs) - def plot_legend_margin(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/plot_legend_margin").execute(*args, **kwargs) - def point_tool_size(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/point_tool_size").execute(*args, **kwargs) - def remove_partition_lines(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/remove_partition_lines").execute(*args, **kwargs) - def remove_partition_lines_tolerance(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/remove_partition_lines_tolerance").execute(*args, **kwargs) - def rotation_centerpoint_visible(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/rotation_centerpoint_visible").execute(*args, **kwargs) - def scroll_wheel_event_end_timer(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/scroll_wheel_event_end_timer").execute(*args, **kwargs) - def set_camera_normal_to_surface_increments(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/set_camera_normal_to_surface_increments").execute(*args, **kwargs) - def show_hidden_lines(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/show_hidden_lines").execute(*args, **kwargs) - def show_hidden_surfaces(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/show_hidden_surfaces").execute(*args, **kwargs) - def switch_to_open_glfor_remote_visualization(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/switch_to_open_glfor_remote_visualization").execute(*args, **kwargs) - def test_use_external_function(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/test_use_external_function").execute(*args, **kwargs) - def text_window_line_width(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/text_window_line_width").execute(*args, **kwargs) - - class boundary_markers(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color_option(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/boundary_markers/color_option").execute(*args, **kwargs) - def enabled(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/boundary_markers/enabled").execute(*args, **kwargs) - def exclude_from_bounding(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/boundary_markers/exclude_from_bounding").execute(*args, **kwargs) - def inlet_color(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/boundary_markers/inlet_color").execute(*args, **kwargs) - def marker_fraction(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/boundary_markers/marker_fraction").execute(*args, **kwargs) - def marker_size_limiting_scale_multiplier(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/boundary_markers/marker_size_limiting_scale_multiplier").execute(*args, **kwargs) - def markers_limit(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/boundary_markers/markers_limit").execute(*args, **kwargs) - def outlet_color(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/boundary_markers/outlet_color").execute(*args, **kwargs) - def scale_marker(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/boundary_markers/scale_marker").execute(*args, **kwargs) - def show_inlet_markers(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/boundary_markers/show_inlet_markers").execute(*args, **kwargs) - def show_outlet_markers(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/boundary_markers/show_outlet_markers").execute(*args, **kwargs) - - class colormap_settings(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def alignment(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/alignment").execute(*args, **kwargs) - def aspect_ratio_when_horizontal(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/aspect_ratio_when_horizontal").execute(*args, **kwargs) - def aspect_ratio_when_vertical(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/aspect_ratio_when_vertical").execute(*args, **kwargs) - def auto_refit_on_resize(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/auto_refit_on_resize").execute(*args, **kwargs) - def automatic_resize(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/automatic_resize").execute(*args, **kwargs) - def border_style(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/border_style").execute(*args, **kwargs) - def colormap(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/colormap").execute(*args, **kwargs) - def isolines_position_offset(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/isolines_position_offset").execute(*args, **kwargs) - def labels(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/labels").execute(*args, **kwargs) - def levels(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/levels").execute(*args, **kwargs) - def log_scale(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/log_scale").execute(*args, **kwargs) - def major_length_to_screen_ratio_when_horizontal(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/major_length_to_screen_ratio_when_horizontal").execute(*args, **kwargs) - def major_length_to_screen_ratio_when_vertical(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/major_length_to_screen_ratio_when_vertical").execute(*args, **kwargs) - def margin_from_edge_to_screen_ratio(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/margin_from_edge_to_screen_ratio").execute(*args, **kwargs) - def max_size_scale_factor(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/max_size_scale_factor").execute(*args, **kwargs) - def min_size_scale_factor(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/min_size_scale_factor").execute(*args, **kwargs) - def number_format_precision(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/number_format_precision").execute(*args, **kwargs) - def number_format_type(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/number_format_type").execute(*args, **kwargs) - def show_colormap(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/show_colormap").execute(*args, **kwargs) - def skip_value(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/skip_value").execute(*args, **kwargs) - def text_behavior(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_behavior").execute(*args, **kwargs) - def text_font_automatic_horizontal_size(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_automatic_horizontal_size").execute(*args, **kwargs) - def text_font_automatic_size(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_automatic_size").execute(*args, **kwargs) - def text_font_automatic_units(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_automatic_units").execute(*args, **kwargs) - def text_font_automatic_vertical_size(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_automatic_vertical_size").execute(*args, **kwargs) - def text_font_fixed_horizontal_size(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_fixed_horizontal_size").execute(*args, **kwargs) - def text_font_fixed_size(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_fixed_size").execute(*args, **kwargs) - def text_font_fixed_units(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_fixed_units").execute(*args, **kwargs) - def text_font_fixed_vertical_size(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_fixed_vertical_size").execute(*args, **kwargs) - def text_font_name(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_name").execute(*args, **kwargs) - def text_truncation_limit_for_horizontal_colormaps(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_truncation_limit_for_horizontal_colormaps").execute(*args, **kwargs) - def text_truncation_limit_for_vertical_colormaps(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_truncation_limit_for_vertical_colormaps").execute(*args, **kwargs) - def type(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/type").execute(*args, **kwargs) - def use_no_sub_windows(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/colormap_settings/use_no_sub_windows").execute(*args, **kwargs) - - class embedded_windows(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def default_embedded_mesh_windows_view(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/embedded_windows/default_embedded_mesh_windows_view").execute(*args, **kwargs) - def default_embedded_windows_view(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/embedded_windows/default_embedded_windows_view").execute(*args, **kwargs) - def save_embedded_window_layout(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/embedded_windows/save_embedded_window_layout").execute(*args, **kwargs) - def show_border_for_embedded_window(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/embedded_windows/show_border_for_embedded_window").execute(*args, **kwargs) - - class export_video_settings(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.advanced_video_quality_options = self.__class__.advanced_video_quality_options(path + [("advanced_video_quality_options", None)], service) - def video_format(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/export_video_settings/video_format").execute(*args, **kwargs) - def video_fps(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/export_video_settings/video_fps").execute(*args, **kwargs) - def video_quality(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/export_video_settings/video_quality").execute(*args, **kwargs) - def video_resoution_x(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/export_video_settings/video_resoution_x").execute(*args, **kwargs) - def video_resoution_y(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/export_video_settings/video_resoution_y").execute(*args, **kwargs) - def video_scale(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/export_video_settings/video_scale").execute(*args, **kwargs) - def video_smooth_scaling(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/export_video_settings/video_smooth_scaling").execute(*args, **kwargs) - def video_use_frame_resolution(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/export_video_settings/video_use_frame_resolution").execute(*args, **kwargs) - - class advanced_video_quality_options(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def bit_rate_quality(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/export_video_settings/advanced_video_quality_options/bit_rate_quality").execute(*args, **kwargs) - def bitrate(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/export_video_settings/advanced_video_quality_options/bitrate").execute(*args, **kwargs) - def compression_method(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/export_video_settings/advanced_video_quality_options/compression_method").execute(*args, **kwargs) - def enable_h264(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/export_video_settings/advanced_video_quality_options/enable_h264").execute(*args, **kwargs) - def key_frames(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/export_video_settings/advanced_video_quality_options/key_frames").execute(*args, **kwargs) - - class graphics_effects(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def ambient_occlusion_enabled(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/ambient_occlusion_enabled").execute(*args, **kwargs) - def ambient_occlusion_quality(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/ambient_occlusion_quality").execute(*args, **kwargs) - def ambient_occlusion_strength(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/ambient_occlusion_strength").execute(*args, **kwargs) - def anti_aliasing(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/anti_aliasing").execute(*args, **kwargs) - def bloom_blur(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/bloom_blur").execute(*args, **kwargs) - def bloom_enabled(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/bloom_enabled").execute(*args, **kwargs) - def bloom_strength(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/bloom_strength").execute(*args, **kwargs) - def grid_color(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/grid_color").execute(*args, **kwargs) - def grid_plane_count(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/grid_plane_count").execute(*args, **kwargs) - def grid_plane_enabled(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/grid_plane_enabled").execute(*args, **kwargs) - def grid_plane_offset(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/grid_plane_offset").execute(*args, **kwargs) - def grid_plane_size_factor(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/grid_plane_size_factor").execute(*args, **kwargs) - def plane_direction(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/plane_direction").execute(*args, **kwargs) - def reflections_enabled(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/reflections_enabled").execute(*args, **kwargs) - def shadow_map_enabled(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/shadow_map_enabled").execute(*args, **kwargs) - def show_edge_reflections(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/show_edge_reflections").execute(*args, **kwargs) - def show_marker_reflections(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/show_marker_reflections").execute(*args, **kwargs) - def simple_shadows_enabled(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/simple_shadows_enabled").execute(*args, **kwargs) - def update_after_mouse_release(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/graphics_effects/update_after_mouse_release").execute(*args, **kwargs) - - class hardcopy_settings(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def export_edges_for_avz(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/hardcopy_settings/export_edges_for_avz").execute(*args, **kwargs) - def hardcopy_driver(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/hardcopy_settings/hardcopy_driver").execute(*args, **kwargs) - def hardcopy_line_width(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/hardcopy_settings/hardcopy_line_width").execute(*args, **kwargs) - def hardware_image_accel(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/hardcopy_settings/hardware_image_accel").execute(*args, **kwargs) - def post_script_permission_override(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/hardcopy_settings/post_script_permission_override").execute(*args, **kwargs) - def save_embedded_hardcopies_separately(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/hardcopy_settings/save_embedded_hardcopies_separately").execute(*args, **kwargs) - def save_embedded_windows_in_hardcopy(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/hardcopy_settings/save_embedded_windows_in_hardcopy").execute(*args, **kwargs) - def transparent_embedded_windows(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/hardcopy_settings/transparent_embedded_windows").execute(*args, **kwargs) - - class lighting(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def ambient_light_intensity(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/lighting/ambient_light_intensity").execute(*args, **kwargs) - def headlight(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/lighting/headlight").execute(*args, **kwargs) - def headlight_intensity(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/lighting/headlight_intensity").execute(*args, **kwargs) - def lighting_method(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/lighting/lighting_method").execute(*args, **kwargs) - - class manage_hoops_memory(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enabled(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/manage_hoops_memory/enabled").execute(*args, **kwargs) - def hsfimport_limit(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/manage_hoops_memory/hsfimport_limit").execute(*args, **kwargs) - - class material_effects(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def decimation_filter(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/material_effects/decimation_filter").execute(*args, **kwargs) - def parameterization_source(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/material_effects/parameterization_source").execute(*args, **kwargs) - def tiling_style(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/material_effects/tiling_style").execute(*args, **kwargs) - - class meshing_mode(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def graphics_window_display_timeout(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/meshing_mode/graphics_window_display_timeout").execute(*args, **kwargs) - def graphics_window_display_timeout_value(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/meshing_mode/graphics_window_display_timeout_value").execute(*args, **kwargs) - - class performance(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.fast_display_mode = self.__class__.fast_display_mode(path + [("fast_display_mode", None)], service) - self.minimum_frame_rate = self.__class__.minimum_frame_rate(path + [("minimum_frame_rate", None)], service) - def optimize_for(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/performance/optimize_for").execute(*args, **kwargs) - def ratio_of_target_frame_rate_to_classify_heavy_geometry(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/performance/ratio_of_target_frame_rate_to_classify_heavy_geometry").execute(*args, **kwargs) - def ratio_of_target_frame_rate_to_declassify_heavy_geometry(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/performance/ratio_of_target_frame_rate_to_declassify_heavy_geometry").execute(*args, **kwargs) - - class fast_display_mode(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def culling(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/performance/fast_display_mode/culling").execute(*args, **kwargs) - def faces_shown(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/performance/fast_display_mode/faces_shown").execute(*args, **kwargs) - def markers_decimation(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/performance/fast_display_mode/markers_decimation").execute(*args, **kwargs) - def nodes_shown(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/performance/fast_display_mode/nodes_shown").execute(*args, **kwargs) - def perimeter_edges_shown(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/performance/fast_display_mode/perimeter_edges_shown").execute(*args, **kwargs) - def silhouette_shown(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/performance/fast_display_mode/silhouette_shown").execute(*args, **kwargs) - def status(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/performance/fast_display_mode/status").execute(*args, **kwargs) - def transparency(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/performance/fast_display_mode/transparency").execute(*args, **kwargs) - - class minimum_frame_rate(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def dynamic_adjustment(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/performance/minimum_frame_rate/dynamic_adjustment").execute(*args, **kwargs) - def enabled(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/performance/minimum_frame_rate/enabled").execute(*args, **kwargs) - def fixed_culling_value(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/performance/minimum_frame_rate/fixed_culling_value").execute(*args, **kwargs) - def maximum_culling_threshold(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/performance/minimum_frame_rate/maximum_culling_threshold").execute(*args, **kwargs) - def minimum_culling_threshold(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/performance/minimum_frame_rate/minimum_culling_threshold").execute(*args, **kwargs) - def target_fps(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/performance/minimum_frame_rate/target_fps").execute(*args, **kwargs) - - class transparency(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def algorithm_for_modern_drivers(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/transparency/algorithm_for_modern_drivers").execute(*args, **kwargs) - def depth_peeling_layers(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/transparency/depth_peeling_layers").execute(*args, **kwargs) - def depth_peeling_preference(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/transparency/depth_peeling_preference").execute(*args, **kwargs) - def quick_moves(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/transparency/quick_moves").execute(*args, **kwargs) - def zsort_options(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/transparency/zsort_options").execute(*args, **kwargs) - - class vector_settings(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def arrow3_dradius1_factor(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/vector_settings/arrow3_dradius1_factor").execute(*args, **kwargs) - def arrow3_dradius2_factor(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/vector_settings/arrow3_dradius2_factor").execute(*args, **kwargs) - def arrowhead3_dradius1_factor(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/vector_settings/arrowhead3_dradius1_factor").execute(*args, **kwargs) - def line_arrow3_dperpendicular_radius(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/graphics/vector_settings/line_arrow3_dperpendicular_radius").execute(*args, **kwargs) - - class mat_pro_app(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def beta_features(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/mat_pro_app/beta_features").execute(*args, **kwargs) - def focus(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/mat_pro_app/focus").execute(*args, **kwargs) - def warning(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/mat_pro_app/warning").execute(*args, **kwargs) - - class meshing_workflow(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.draw_settings = self.__class__.draw_settings(path + [("draw_settings", None)], service) - def checkpointing_option(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/meshing_workflow/checkpointing_option").execute(*args, **kwargs) - def save_checkpoint_files(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/meshing_workflow/save_checkpoint_files").execute(*args, **kwargs) - def temp_folder(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/meshing_workflow/temp_folder").execute(*args, **kwargs) - def templates_folder(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/meshing_workflow/templates_folder").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/meshing_workflow/verbosity").execute(*args, **kwargs) - - class draw_settings(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def auto_draw(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/meshing_workflow/draw_settings/auto_draw").execute(*args, **kwargs) - def face_zone_limit(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/meshing_workflow/draw_settings/face_zone_limit").execute(*args, **kwargs) - def facet_limit(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/meshing_workflow/draw_settings/facet_limit").execute(*args, **kwargs) - - class navigation(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.mouse_mapping = self.__class__.mouse_mapping(path + [("mouse_mapping", None)], service) - - class mouse_mapping(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.additional = self.__class__.additional(path + [("additional", None)], service) - self.basic = self.__class__.basic(path + [("basic", None)], service) - def mousemaptheme(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/mousemaptheme").execute(*args, **kwargs) - - class additional(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def ctrllmbclick(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/ctrllmbclick").execute(*args, **kwargs) - def ctrllmbdrag(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/ctrllmbdrag").execute(*args, **kwargs) - def ctrlmmbclick(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/ctrlmmbclick").execute(*args, **kwargs) - def ctrlmmbdrag(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/ctrlmmbdrag").execute(*args, **kwargs) - def ctrlrmbclick(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/ctrlrmbclick").execute(*args, **kwargs) - def ctrlrmbdrag(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/ctrlrmbdrag").execute(*args, **kwargs) - def mouseprobe(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/mouseprobe").execute(*args, **kwargs) - def mousewheel(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/mousewheel").execute(*args, **kwargs) - def mousewheelsensitivity(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/mousewheelsensitivity").execute(*args, **kwargs) - def reversewheeldirection(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/reversewheeldirection").execute(*args, **kwargs) - def shiftlmbclick(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/shiftlmbclick").execute(*args, **kwargs) - def shiftlmbdrag(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/shiftlmbdrag").execute(*args, **kwargs) - def shiftmmbclick(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/shiftmmbclick").execute(*args, **kwargs) - def shiftmmbdrag(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/shiftmmbdrag").execute(*args, **kwargs) - def shiftrmbclick(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/shiftrmbclick").execute(*args, **kwargs) - def shiftrmbdrag(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/shiftrmbdrag").execute(*args, **kwargs) - - class basic(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def lmb(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/basic/lmb").execute(*args, **kwargs) - def lmbclick(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/basic/lmbclick").execute(*args, **kwargs) - def mmb(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/basic/mmb").execute(*args, **kwargs) - def mmbclick(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/basic/mmbclick").execute(*args, **kwargs) - def rmb(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/basic/rmb").execute(*args, **kwargs) - def rmbclick(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/navigation/mouse_mapping/basic/rmbclick").execute(*args, **kwargs) - - class prj_app(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def advanced_flag(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/prj_app/advanced_flag").execute(*args, **kwargs) - def beta_flag(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/prj_app/beta_flag").execute(*args, **kwargs) - def cffoutput(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/prj_app/cffoutput").execute(*args, **kwargs) - def default_folder(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/prj_app/default_folder").execute(*args, **kwargs) - def display_mesh_after_case_load(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/prj_app/display_mesh_after_case_load").execute(*args, **kwargs) - def multi_console(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/prj_app/multi_console").execute(*args, **kwargs) - def ncpu(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/prj_app/ncpu").execute(*args, **kwargs) - def session_color(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/prj_app/session_color").execute(*args, **kwargs) - def show_fluent_window(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/prj_app/show_fluent_window").execute(*args, **kwargs) - def use_default_folder(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/prj_app/use_default_folder").execute(*args, **kwargs) - def use_fluent_graphics(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/prj_app/use_fluent_graphics").execute(*args, **kwargs) - def use_launcher(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/prj_app/use_launcher").execute(*args, **kwargs) - - class simulation(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.report_definitions = self.__class__.report_definitions(path + [("report_definitions", None)], service) - def flow_model(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/simulation/flow_model").execute(*args, **kwargs) - def local_residual_scaling(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/simulation/local_residual_scaling").execute(*args, **kwargs) - - class report_definitions(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def automatic_plot_file(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/simulation/report_definitions/automatic_plot_file").execute(*args, **kwargs) - def report_plot_history_data_size(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/simulation/report_definitions/report_plot_history_data_size").execute(*args, **kwargs) - - class turbo_workflow(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.cell_zone_settings = self.__class__.cell_zone_settings(path + [("cell_zone_settings", None)], service) - self.face_zone_settings = self.__class__.face_zone_settings(path + [("face_zone_settings", None)], service) - self.graphics_settings = self.__class__.graphics_settings(path + [("graphics_settings", None)], service) - def checkpointing_option(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/checkpointing_option").execute(*args, **kwargs) - def save_checkpoint_files(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/save_checkpoint_files").execute(*args, **kwargs) - - class cell_zone_settings(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def czsearch_order(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/cell_zone_settings/czsearch_order").execute(*args, **kwargs) - def rotating(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/cell_zone_settings/rotating").execute(*args, **kwargs) - def stationary(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/cell_zone_settings/stationary").execute(*args, **kwargs) - - class face_zone_settings(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def blade_region(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/blade_region").execute(*args, **kwargs) - def fzsearch_order(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/fzsearch_order").execute(*args, **kwargs) - def hub_region(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/hub_region").execute(*args, **kwargs) - def inlet_region(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/inlet_region").execute(*args, **kwargs) - def interior_region(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/interior_region").execute(*args, **kwargs) - def outlet_region(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/outlet_region").execute(*args, **kwargs) - def periodic1_region(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/periodic1_region").execute(*args, **kwargs) - def periodic2_region(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/periodic2_region").execute(*args, **kwargs) - def shroud_region(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/shroud_region").execute(*args, **kwargs) - def symmetry_region(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/symmetry_region").execute(*args, **kwargs) - def tip1_region(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/tip1_region").execute(*args, **kwargs) - def tip2_region(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/tip2_region").execute(*args, **kwargs) - - class graphics_settings(metaclass=PyMenuMeta): - """ - . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def auto_draw(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/preferences/turbo_workflow/graphics_settings/auto_draw").execute(*args, **kwargs) - - class report(metaclass=PyMenuMeta): - """ - Enter the report menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.dpm_histogram = self.__class__.dpm_histogram(path + [("dpm_histogram", None)], service) - self.fluxes = self.__class__.fluxes(path + [("fluxes", None)], service) - self.forces = self.__class__.forces(path + [("forces", None)], service) - self.reference_values = self.__class__.reference_values(path + [("reference_values", None)], service) - self.surface_integrals = self.__class__.surface_integrals(path + [("surface_integrals", None)], service) - self.volume_integrals = self.__class__.volume_integrals(path + [("volume_integrals", None)], service) - self.modified_setting = self.__class__.modified_setting(path + [("modified_setting", None)], service) - self.population_balance = self.__class__.population_balance(path + [("population_balance", None)], service) - self.heat_exchanger = self.__class__.heat_exchanger(path + [("heat_exchanger", None)], service) - self.system = self.__class__.system(path + [("system", None)], service) - self.simulation_reports = self.__class__.simulation_reports(path + [("simulation_reports", None)], service) - def aero_optical_distortions(self, *args, **kwargs): - """ - Optics report menu. - """ - return PyMenu(self.service, "/report/aero_optical_distortions").execute(*args, **kwargs) - def dpm_summary(self, *args, **kwargs): - """ - Prints discrete phase summary report. - """ - return PyMenu(self.service, "/report/dpm_summary").execute(*args, **kwargs) - def dpm_extended_summary(self, *args, **kwargs): - """ - Create an extended discrete phase summary report of the discrete phase injection(s). You can choose whether you want to save the extended report to a file or print it in the console window. For unsteady tracking, you will be asked whether you want to include in-domain particle/tracks in the report. You will be also prompted whether you want to select a single injection for the summary report. By default, all injections are included. The output depends on whether you have enabled the report/dpm-zone-summaries-per-injection? text command, in which case additional information is printed for escaped particles, such as per-injection data. Note that, for unsteady particle tracking, it is necessary to enable the report/dpm-zone-summaries-per-injection? text command before any particle parcels are injected into the domain. - """ - return PyMenu(self.service, "/report/dpm_extended_summary").execute(*args, **kwargs) - def dpm_zone_summaries_per_injection(self, *args, **kwargs): - """ - Enables/disables calculation of the escaped mass per injection. Note that for unsteady particle tracking, if you want to report the mass of escaped particles per injection, this text command must be enabled before any particles are injected into the domain. - """ - return PyMenu(self.service, "/report/dpm_zone_summaries_per_injection").execute(*args, **kwargs) - def dpm_sample(self, *args, **kwargs): - """ - Samples trajectories at boundaries and lines/planes. - """ - return PyMenu(self.service, "/report/dpm_sample").execute(*args, **kwargs) - def dpm_sample_output_udf(self, *args, **kwargs): - """ - Allows you to hook a previously loaded DEFINE_DPM_OUTPUT UDF for file format specification for sampling of trajectories and VOF-to-DPM lump conversion transcripts. - """ - return PyMenu(self.service, "/report/dpm_sample_output_udf").execute(*args, **kwargs) - def dpm_sample_sort_file(self, *args, **kwargs): - """ - Enables/disables writing of sorted DPM sample files. - """ - return PyMenu(self.service, "/report/dpm_sample_sort_file").execute(*args, **kwargs) - def particle_summary(self, *args, **kwargs): - """ - Prints summary report for all current particles. - """ - return PyMenu(self.service, "/report/particle_summary").execute(*args, **kwargs) - def path_line_summary(self, *args, **kwargs): - """ - Prints pathline summary report. - """ - return PyMenu(self.service, "/report/path_line_summary").execute(*args, **kwargs) - def print_histogram(self, *args, **kwargs): - """ - Prints a histogram of a scalar quantity. - """ - return PyMenu(self.service, "/report/print_histogram").execute(*args, **kwargs) - def write_histogram(self, *args, **kwargs): - """ - Write a histogram of a scalar quantity to a file. - """ - return PyMenu(self.service, "/report/write_histogram").execute(*args, **kwargs) - def projected_surface_area(self, *args, **kwargs): - """ - Computes the area of the projection of selected surfaces along the , , or axis. - """ - return PyMenu(self.service, "/report/projected_surface_area").execute(*args, **kwargs) - def species_mass_flow(self, *args, **kwargs): - """ - Prints list of species mass flow rate at inlets and outlets. This reports the mass flow rates of all species (in kg/s) flowing through the simulation boundaries. - """ - return PyMenu(self.service, "/report/species_mass_flow").execute(*args, **kwargs) - def element_mass_flow(self, *args, **kwargs): - """ - Prints list of element flow rate at inlets and outlets. This reports the mass flow rates of all chemical elements (in kg/s) flowing through the simulation boundaries. - """ - return PyMenu(self.service, "/report/element_mass_flow").execute(*args, **kwargs) - def summary(self, *args, **kwargs): - """ - Prints the current settings for physical models, boundary conditions, material properties, and solution parameters. - """ - return PyMenu(self.service, "/report/summary").execute(*args, **kwargs) - def uds_flow(self, *args, **kwargs): - """ - Prints list of user-defined scalar flow rate at boundaries. - """ - return PyMenu(self.service, "/report/uds_flow").execute(*args, **kwargs) - def mphase_summary(self, *args, **kwargs): - """ - Prints summary report for a multiphase case setup. - """ - return PyMenu(self.service, "/report/mphase_summary").execute(*args, **kwargs) - - class dpm_histogram(metaclass=PyMenuMeta): - """ - Enters the DPM histogram menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.set = self.__class__.set(path + [("set", None)], service) - self.setup_reduction = self.__class__.setup_reduction(path + [("setup_reduction", None)], service) - def compute_sample(self, *args, **kwargs): - """ - Computes the minimum/maximum of a sample variable. - """ - return PyMenu(self.service, "/report/dpm_histogram/compute_sample").execute(*args, **kwargs) - def delete_sample(self, *args, **kwargs): - """ - Deletes a sample from the loaded sample list. - """ - return PyMenu(self.service, "/report/dpm_histogram/delete_sample").execute(*args, **kwargs) - def list_samples(self, *args, **kwargs): - """ - Shows all samples in a loaded sample list. - """ - return PyMenu(self.service, "/report/dpm_histogram/list_samples").execute(*args, **kwargs) - def plot_sample(self, *args, **kwargs): - """ - Plots a histogram of a loaded sample. - """ - return PyMenu(self.service, "/report/dpm_histogram/plot_sample").execute(*args, **kwargs) - def read_sample(self, *args, **kwargs): - """ - Reads a sample file and adds it to the sample list. - """ - return PyMenu(self.service, "/report/dpm_histogram/read_sample").execute(*args, **kwargs) - def write_sample(self, *args, **kwargs): - """ - Write a histogram of a loaded sample into a file. - """ - return PyMenu(self.service, "/report/dpm_histogram/write_sample").execute(*args, **kwargs) - def pick_sample_to_reduce(self, *args, **kwargs): - """ - Select a sample to be reduced. - """ - return PyMenu(self.service, "/report/dpm_histogram/pick_sample_to_reduce").execute(*args, **kwargs) - def reduce_picked_sample(self, *args, **kwargs): - """ - Reduce a sample as specified by the data reduction parameters. This command is available only after you selected the sample using the pick-sample-to-reduce text command. - """ - return PyMenu(self.service, "/report/dpm_histogram/reduce_picked_sample").execute(*args, **kwargs) - - class set(metaclass=PyMenuMeta): - """ - Enters the settings menu for the histogram. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def auto_range(self, *args, **kwargs): - """ - Automatically computes the range of the sampling variable for histogram plots. - """ - return PyMenu(self.service, "/report/dpm_histogram/set/auto_range").execute(*args, **kwargs) - def correlation(self, *args, **kwargs): - """ - Computes the correlation of the sampling variable with another variable. - """ - return PyMenu(self.service, "/report/dpm_histogram/set/correlation").execute(*args, **kwargs) - def cumulation_curve(self, *args, **kwargs): - """ - Computes a cumulative curve for the sampling variable or correlation variable when correlation? is specified. - """ - return PyMenu(self.service, "/report/dpm_histogram/set/cumulation_curve").execute(*args, **kwargs) - def diameter_statistics(self, *args, **kwargs): - """ - Computes the Rosin Rammler parameters, Sauter, and other mean diameters. - """ - return PyMenu(self.service, "/report/dpm_histogram/set/diameter_statistics").execute(*args, **kwargs) - def histogram_mode(self, *args, **kwargs): - """ - Uses bars for the histogram plot or xy-style. - """ - return PyMenu(self.service, "/report/dpm_histogram/set/histogram_mode").execute(*args, **kwargs) - def minimum(self, *args, **kwargs): - """ - Specifies the minimum value of the x-axis variable for histogram plots. - """ - return PyMenu(self.service, "/report/dpm_histogram/set/minimum").execute(*args, **kwargs) - def maximum(self, *args, **kwargs): - """ - Specifies the maximum value of the x-axis variable for histogram plots. - """ - return PyMenu(self.service, "/report/dpm_histogram/set/maximum").execute(*args, **kwargs) - def number_of_bins(self, *args, **kwargs): - """ - Specifies the number of bins. - """ - return PyMenu(self.service, "/report/dpm_histogram/set/number_of_bins").execute(*args, **kwargs) - def percentage(self, *args, **kwargs): - """ - Uses percentages of bins to be computed. - """ - return PyMenu(self.service, "/report/dpm_histogram/set/percentage").execute(*args, **kwargs) - def variable_power_3(self, *args, **kwargs): - """ - Use the cubic of the cumulation variable during computation of the cumulative curve. - When the particle mass was not sampled, the diameter can be used instead. - """ - return PyMenu(self.service, "/report/dpm_histogram/set/variable_power_3").execute(*args, **kwargs) - def logarithmic(self, *args, **kwargs): - """ - Enables/disables the use of logarithmic scaling on the abscissa of the histogram. - """ - return PyMenu(self.service, "/report/dpm_histogram/set/logarithmic").execute(*args, **kwargs) - def weighting(self, *args, **kwargs): - """ - Uses weighting with additional variables when sorting data into samples. - """ - return PyMenu(self.service, "/report/dpm_histogram/set/weighting").execute(*args, **kwargs) - - class setup_reduction(metaclass=PyMenuMeta): - """ - Set up the sample data reduction by specifying all relevant options and setting parameters as desired. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def use_weighting(self, *args, **kwargs): - """ - Specify whether to use any weighting in the averaging that is done in each bin in the data reduction. - """ - return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/use_weighting").execute(*args, **kwargs) - def weighting_variable(self, *args, **kwargs): - """ - Choose the weighting variable for the averaging in each bin in the data reduction. - """ - return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/weighting_variable").execute(*args, **kwargs) - def make_steady_from_unsteady_file(self, *args, **kwargs): - """ - Specify whether the unsteady sample is to be reduced into a steady-state injection file. - """ - return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/make_steady_from_unsteady_file").execute(*args, **kwargs) - def reset_min_and_max(self, *args, **kwargs): - """ - Reset the min and max values of the range to be considered for a specific variable in the data reduction. - """ - return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/reset_min_and_max").execute(*args, **kwargs) - def minimum(self, *args, **kwargs): - """ - Set the minimum value of the range to be considered for a specific variable in the data reduction. - """ - return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/minimum").execute(*args, **kwargs) - def maximum(self, *args, **kwargs): - """ - Set the maximum value of the range to be considered for a specific variable in the data reduction. - """ - return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/maximum").execute(*args, **kwargs) - def logarithmic(self, *args, **kwargs): - """ - Switch on or off logarithmic scaling to be used for a specific variable in the data reduction. - """ - return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/logarithmic").execute(*args, **kwargs) - def number_of_bins(self, *args, **kwargs): - """ - Set the number of bins to be used for a specific variable in the data reduction. - """ - return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/number_of_bins").execute(*args, **kwargs) - def all_variables_number_of_bins(self, *args, **kwargs): - """ - Set the number of bins to be used for ALL variables in the data reduction. - """ - return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/all_variables_number_of_bins").execute(*args, **kwargs) - def list_settings(self, *args, **kwargs): - """ - List all user inputs for the sample picked for data reduction. - """ - return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/list_settings").execute(*args, **kwargs) - - class fluxes(metaclass=PyMenuMeta): - """ - Enters the fluxes menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def mass_flow(self, *args, **kwargs): - """ - Prints mass flow rate at inlets and outlets. - """ - return PyMenu(self.service, "/report/fluxes/mass_flow").execute(*args, **kwargs) - def heat_transfer(self, *args, **kwargs): - """ - Prints heat transfer rate at boundaries. - """ - return PyMenu(self.service, "/report/fluxes/heat_transfer").execute(*args, **kwargs) - def heat_transfer_sensible(self, *args, **kwargs): - """ - Prints the sensible heat transfer rate at the boundaries. - """ - return PyMenu(self.service, "/report/fluxes/heat_transfer_sensible").execute(*args, **kwargs) - def rad_heat_trans(self, *args, **kwargs): - """ - Prints radiation heat transfer rate at boundaries. - """ - return PyMenu(self.service, "/report/fluxes/rad_heat_trans").execute(*args, **kwargs) - def film_mass_flow(self, *args, **kwargs): - """ - Prints wall film mass flow rate at boundaries. This text command is only available when you enable the Eulerian wall film model. - """ - return PyMenu(self.service, "/report/fluxes/film_mass_flow").execute(*args, **kwargs) - def film_heat_transfer(self, *args, **kwargs): - """ - Prints wall film heat transfer rate at boundaries. This text command is only available when you enable the Eulerian wall film model. - """ - return PyMenu(self.service, "/report/fluxes/film_heat_transfer").execute(*args, **kwargs) - def pressure_work(self, *args, **kwargs): - """ - Prints the pressure work rate at the boundaries. This text command is only available when the energy equation is enabled, the absolute velocity formulation is selected, and zone motion is enabled for a fluid cell zone. - """ - return PyMenu(self.service, "/report/fluxes/pressure_work").execute(*args, **kwargs) - def viscous_work(self, *args, **kwargs): - """ - Prints the viscous work rate at the boundaries. This text command is only available when the energy equation is enabled and the pressure-based solver is selected. - """ - return PyMenu(self.service, "/report/fluxes/viscous_work").execute(*args, **kwargs) - - class forces(metaclass=PyMenuMeta): - """ - Enters the forces menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def wall_forces(self, *args, **kwargs): - """ - Computes the forces along the specified force vector for all wall zones. - """ - return PyMenu(self.service, "/report/forces/wall_forces").execute(*args, **kwargs) - def wall_moments(self, *args, **kwargs): - """ - Computes the moments about the specified moment center for all wall zones. - """ - return PyMenu(self.service, "/report/forces/wall_moments").execute(*args, **kwargs) - def pressure_center(self, *args, **kwargs): - """ - Prints the center of pressure on wall zones. - """ - return PyMenu(self.service, "/report/forces/pressure_center").execute(*args, **kwargs) - - class reference_values(metaclass=PyMenuMeta): - """ - Enters the reference value menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.compute = self.__class__.compute(path + [("compute", None)], service) - def area(self, *args, **kwargs): - """ - Sets reference area for normalization. - """ - return PyMenu(self.service, "/report/reference_values/area").execute(*args, **kwargs) - def depth(self, *args, **kwargs): - """ - Sets reference depth for volume calculation. - """ - return PyMenu(self.service, "/report/reference_values/depth").execute(*args, **kwargs) - def density(self, *args, **kwargs): - """ - Sets reference density for normalization. - """ - return PyMenu(self.service, "/report/reference_values/density").execute(*args, **kwargs) - def enthalpy(self, *args, **kwargs): - """ - Sets reference enthalpy for enthalpy damping and normalization. - """ - return PyMenu(self.service, "/report/reference_values/enthalpy").execute(*args, **kwargs) - def length(self, *args, **kwargs): - """ - Sets reference length for normalization. - """ - return PyMenu(self.service, "/report/reference_values/length").execute(*args, **kwargs) - def pressure(self, *args, **kwargs): - """ - Sets reference pressure for normalization. - """ - return PyMenu(self.service, "/report/reference_values/pressure").execute(*args, **kwargs) - def temperature(self, *args, **kwargs): - """ - Sets reference temperature for normalization. - """ - return PyMenu(self.service, "/report/reference_values/temperature").execute(*args, **kwargs) - def yplus(self, *args, **kwargs): - """ - Sets reference yplus for calculation of Yplus Based Heat Transfer Coefficient. - """ - return PyMenu(self.service, "/report/reference_values/yplus").execute(*args, **kwargs) - def velocity(self, *args, **kwargs): - """ - Sets reference velocity for normalization. - """ - return PyMenu(self.service, "/report/reference_values/velocity").execute(*args, **kwargs) - def viscosity(self, *args, **kwargs): - """ - Sets reference viscosity for normalization. - """ - return PyMenu(self.service, "/report/reference_values/viscosity").execute(*args, **kwargs) - def zone(self, *args, **kwargs): - """ - Sets reference zone. - """ - return PyMenu(self.service, "/report/reference_values/zone").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Lists current reference values. - """ - return PyMenu(self.service, "/report/reference_values/list").execute(*args, **kwargs) - - class compute(metaclass=PyMenuMeta): - """ - Computes reference values from zone boundary conditions. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def axis(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/axis").execute(*args, **kwargs) - def degassing(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/degassing").execute(*args, **kwargs) - def dummy_entry(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/report/reference_values/compute/dummy_entry").execute(*args, **kwargs) - def exhaust_fan(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/exhaust_fan").execute(*args, **kwargs) - def fan(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/fan").execute(*args, **kwargs) - def fluid(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/fluid").execute(*args, **kwargs) - def geometry(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/geometry").execute(*args, **kwargs) - def inlet_vent(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/inlet_vent").execute(*args, **kwargs) - def intake_fan(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/intake_fan").execute(*args, **kwargs) - def interface(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/interface").execute(*args, **kwargs) - def interior(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/interior").execute(*args, **kwargs) - def mass_flow_inlet(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/mass_flow_inlet").execute(*args, **kwargs) - def mass_flow_outlet(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/mass_flow_outlet").execute(*args, **kwargs) - def network(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/network").execute(*args, **kwargs) - def network_end(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/network_end").execute(*args, **kwargs) - def outflow(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/outflow").execute(*args, **kwargs) - def outlet_vent(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/outlet_vent").execute(*args, **kwargs) - def overset(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/overset").execute(*args, **kwargs) - def periodic(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/periodic").execute(*args, **kwargs) - def porous_jump(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/porous_jump").execute(*args, **kwargs) - def pressure_far_field(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/pressure_far_field").execute(*args, **kwargs) - def pressure_inlet(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/pressure_inlet").execute(*args, **kwargs) - def pressure_outlet(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/pressure_outlet").execute(*args, **kwargs) - def radiator(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/radiator").execute(*args, **kwargs) - def rans_les_interface(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/rans_les_interface").execute(*args, **kwargs) - def recirculation_inlet(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/recirculation_inlet").execute(*args, **kwargs) - def recirculation_outlet(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/recirculation_outlet").execute(*args, **kwargs) - def shadow(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/shadow").execute(*args, **kwargs) - def solid(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/solid").execute(*args, **kwargs) - def symmetry(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/symmetry").execute(*args, **kwargs) - def velocity_inlet(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/velocity_inlet").execute(*args, **kwargs) - def wall(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/report/reference_values/compute/wall").execute(*args, **kwargs) - - class surface_integrals(metaclass=PyMenuMeta): - """ - Enters the surface integral menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def area(self, *args, **kwargs): - """ - Prints the area of the selected surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/area").execute(*args, **kwargs) - def area_weighted_avg(self, *args, **kwargs): - """ - Print area-weighted average of scalar on surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/area_weighted_avg").execute(*args, **kwargs) - def facet_avg(self, *args, **kwargs): - """ - Prints the facet average of the specified quantity over the selected surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/facet_avg").execute(*args, **kwargs) - def facet_max(self, *args, **kwargs): - """ - Prints the maximum of the specified quantity over facet centroids of the selected surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/facet_max").execute(*args, **kwargs) - def facet_min(self, *args, **kwargs): - """ - Prints the minimum of the specified quantity over facet centroids of the selected surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/facet_min").execute(*args, **kwargs) - def flow_rate(self, *args, **kwargs): - """ - Prints the flow rate of the specified quantity over the selected surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/flow_rate").execute(*args, **kwargs) - def integral(self, *args, **kwargs): - """ - Prints the integral of the specified quantity over the selected surfaces. You can include a wildcard (*) within the surface names. - """ - return PyMenu(self.service, "/report/surface_integrals/integral").execute(*args, **kwargs) - def mass_flow_rate(self, *args, **kwargs): - """ - Prints the mass flow rate through the selected surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/mass_flow_rate").execute(*args, **kwargs) - def mass_weighted_avg(self, *args, **kwargs): - """ - Prints the mass-averaged quantity over the selected surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/mass_weighted_avg").execute(*args, **kwargs) - def standard_deviation(self, *args, **kwargs): - """ - Prints the standard deviation of the scalar at the facet centroids of the surface. - """ - return PyMenu(self.service, "/report/surface_integrals/standard_deviation").execute(*args, **kwargs) - def sum(self, *args, **kwargs): - """ - Prints sum of scalar at facet centroids of the surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/sum").execute(*args, **kwargs) - def uniformity_index_area_weighted(self, *args, **kwargs): - """ - Prints the area-weighted uniformity index of the specified quantity over the selected surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/uniformity_index_area_weighted").execute(*args, **kwargs) - def uniformity_index_mass_weighted(self, *args, **kwargs): - """ - Prints the mass-weighted uniformity index of the specified quantity over the selected surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/uniformity_index_mass_weighted").execute(*args, **kwargs) - def vector_based_flux(self, *args, **kwargs): - """ - Prints the vector-based flux of the specified quantity over the selected surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/vector_based_flux").execute(*args, **kwargs) - def vector_flux(self, *args, **kwargs): - """ - Prints the vector flux over the selected surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/vector_flux").execute(*args, **kwargs) - def vector_weighted_average(self, *args, **kwargs): - """ - Prints the vector-averaged quantity over the selected surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/vector_weighted_average").execute(*args, **kwargs) - def vertex_avg(self, *args, **kwargs): - """ - Prints the vertex average of the specified quantity over the selected surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/vertex_avg").execute(*args, **kwargs) - def vertex_max(self, *args, **kwargs): - """ - Prints the maximum of the specified quantity over vertices of the selected surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/vertex_max").execute(*args, **kwargs) - def vertex_min(self, *args, **kwargs): - """ - Prints the minimum of the specified quantity over vertices of the selected surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/vertex_min").execute(*args, **kwargs) - def volume_flow_rate(self, *args, **kwargs): - """ - Prints the volume flow rate through the selected surfaces. - """ - return PyMenu(self.service, "/report/surface_integrals/volume_flow_rate").execute(*args, **kwargs) - - class volume_integrals(metaclass=PyMenuMeta): - """ - Enters the volume integral menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def mass(self, *args, **kwargs): - """ - Print total mass of specified cell zones. - """ - return PyMenu(self.service, "/report/volume_integrals/mass").execute(*args, **kwargs) - def mass_avg(self, *args, **kwargs): - """ - Prints mass-average of scalar over cell zones. - """ - return PyMenu(self.service, "/report/volume_integrals/mass_avg").execute(*args, **kwargs) - def mass_integral(self, *args, **kwargs): - """ - Prints mass-weighted integral of scalar over cell zones. - """ - return PyMenu(self.service, "/report/volume_integrals/mass_integral").execute(*args, **kwargs) - def maximum(self, *args, **kwargs): - """ - Prints maximum of scalar over all cell zones. - """ - return PyMenu(self.service, "/report/volume_integrals/maximum").execute(*args, **kwargs) - def minimum(self, *args, **kwargs): - """ - Prints minimum of scalar over all cell zones. - """ - return PyMenu(self.service, "/report/volume_integrals/minimum").execute(*args, **kwargs) - def sum(self, *args, **kwargs): - """ - Prints sum of scalar over all cell zones. - """ - return PyMenu(self.service, "/report/volume_integrals/sum").execute(*args, **kwargs) - def twopisum(self, *args, **kwargs): - """ - Prints sum of scalar over all cell zones multiplied by 2π. - """ - return PyMenu(self.service, "/report/volume_integrals/twopisum").execute(*args, **kwargs) - def volume(self, *args, **kwargs): - """ - Prints total volume of specified cell zones. - """ - return PyMenu(self.service, "/report/volume_integrals/volume").execute(*args, **kwargs) - def volume_avg(self, *args, **kwargs): - """ - Prints volume-weighted average of scalar over cell zones. - """ - return PyMenu(self.service, "/report/volume_integrals/volume_avg").execute(*args, **kwargs) - def volume_integral(self, *args, **kwargs): - """ - Prints integral of scalar over cell zones. - """ - return PyMenu(self.service, "/report/volume_integrals/volume_integral").execute(*args, **kwargs) - - class modified_setting(metaclass=PyMenuMeta): - """ - Enter the modified settings menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def modified_setting(self, *args, **kwargs): - """ - Specify which areas of setup will be checked for non-default settings for generating the Modified Settings Summary table. The table is displayed tabbed with the graphics window. - """ - return PyMenu(self.service, "/report/modified_setting/modified_setting").execute(*args, **kwargs) - def write_user_setting(self, *args, **kwargs): - """ - Write the contents of the Modified Settings Summary table to a file. - """ - return PyMenu(self.service, "/report/modified_setting/write_user_setting").execute(*args, **kwargs) - - class population_balance(metaclass=PyMenuMeta): - """ - Population Balance menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def moments(self, *args, **kwargs): - """ - Set moments for population balance. - """ - return PyMenu(self.service, "/report/population_balance/moments").execute(*args, **kwargs) - def number_density(self, *args, **kwargs): - """ - Set number density functions. - """ - return PyMenu(self.service, "/report/population_balance/number_density").execute(*args, **kwargs) - - class heat_exchanger(metaclass=PyMenuMeta): - """ - Enters the heat exchanger menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def computed_heat_rejection(self, *args, **kwargs): - """ - Prints total heat rejection. - """ - return PyMenu(self.service, "/report/heat_exchanger/computed_heat_rejection").execute(*args, **kwargs) - def inlet_temperature(self, *args, **kwargs): - """ - Prints inlet temperature. - """ - return PyMenu(self.service, "/report/heat_exchanger/inlet_temperature").execute(*args, **kwargs) - def outlet_temperature(self, *args, **kwargs): - """ - Prints outlet temperature. - """ - return PyMenu(self.service, "/report/heat_exchanger/outlet_temperature").execute(*args, **kwargs) - def mass_flow_rate(self, *args, **kwargs): - """ - Prints mass flow rate. - """ - return PyMenu(self.service, "/report/heat_exchanger/mass_flow_rate").execute(*args, **kwargs) - def specific_heat(self, *args, **kwargs): - """ - Prints fluid’s specific heat. - """ - return PyMenu(self.service, "/report/heat_exchanger/specific_heat").execute(*args, **kwargs) - - class system(metaclass=PyMenuMeta): - """ - Enters the system menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def proc_stats(self, *args, **kwargs): - """ - Prints ANSYS Fluent process information. This is used to report the memory usage of each of the ANSYS Fluent processes. - """ - return PyMenu(self.service, "/report/system/proc_stats").execute(*args, **kwargs) - def sys_stats(self, *args, **kwargs): - """ - System information. This is used to report the CPU configuration of the machines where ANSYS Fluent processes have been spawned. - """ - return PyMenu(self.service, "/report/system/sys_stats").execute(*args, **kwargs) - def gpgpu_stats(self, *args, **kwargs): - """ - Prints information about installed general purpose graphical processing units. - """ - return PyMenu(self.service, "/report/system/gpgpu_stats").execute(*args, **kwargs) - def time_stats(self, *args, **kwargs): - """ - Timer information. This is used to report CPU timings for user and kernel processes and detailed solver timings. - """ - return PyMenu(self.service, "/report/system/time_stats").execute(*args, **kwargs) - - class simulation_reports(metaclass=PyMenuMeta): - """ - Enter the simulation reports menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def list_simulation_reports(self, *args, **kwargs): - """ - List all report names. - """ - return PyMenu(self.service, "/report/simulation_reports/list_simulation_reports").execute(*args, **kwargs) - def generate_simulation_report(self, *args, **kwargs): - """ - Generate a new simulation report or regenerate an existing simulation report with the provided name. - """ - return PyMenu(self.service, "/report/simulation_reports/generate_simulation_report").execute(*args, **kwargs) - def view_simulation_report(self, *args, **kwargs): - """ - View a simulation report that has already been generated. In batch mode this will print the report's URL. - """ - return PyMenu(self.service, "/report/simulation_reports/view_simulation_report").execute(*args, **kwargs) - def export_simulation_report_as_pdf(self, *args, **kwargs): - """ - Export the provided simulation report as a PDF file. - """ - return PyMenu(self.service, "/report/simulation_reports/export_simulation_report_as_pdf").execute(*args, **kwargs) - def export_simulation_report_as_html(self, *args, **kwargs): - """ - Export the provided simulation report as HTML. - """ - return PyMenu(self.service, "/report/simulation_reports/export_simulation_report_as_html").execute(*args, **kwargs) - def write_report_names_to_file(self, *args, **kwargs): - """ - Write the list of currently generated report names to a txt file. - """ - return PyMenu(self.service, "/report/simulation_reports/write_report_names_to_file").execute(*args, **kwargs) - def rename_simulation_report(self, *args, **kwargs): - """ - Rename a report which has already been generated. - """ - return PyMenu(self.service, "/report/simulation_reports/rename_simulation_report").execute(*args, **kwargs) - def duplicate_simulation_report(self, *args, **kwargs): - """ - Duplicate a report and all of its settings to a new report. - """ - return PyMenu(self.service, "/report/simulation_reports/duplicate_simulation_report").execute(*args, **kwargs) - def reset_report_to_defaults(self, *args, **kwargs): - """ - Reset all report settings to default for the provided simulation report. - """ - return PyMenu(self.service, "/report/simulation_reports/reset_report_to_defaults").execute(*args, **kwargs) - def delete_simulation_report(self, *args, **kwargs): - """ - Delete the provided simulation report. - """ - return PyMenu(self.service, "/report/simulation_reports/delete_simulation_report").execute(*args, **kwargs) - def write_simulation_report_template_file(self, *args, **kwargs): - """ - Write a JSON template file with this case's Simulation Report settings. - """ - return PyMenu(self.service, "/report/simulation_reports/write_simulation_report_template_file").execute(*args, **kwargs) - def read_simulation_report_template_file(self, *args, **kwargs): - """ - Read a JSON template file with existing Simulation Report settings. - """ - return PyMenu(self.service, "/report/simulation_reports/read_simulation_report_template_file").execute(*args, **kwargs) - - class results(metaclass=PyMenuMeta): - """ - Enter results menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.animate = self.__class__.animate(path + [("animate", None)], service) - self.graphics = self.__class__.graphics(path + [("graphics", None)], service) - self.plot = self.__class__.plot(path + [("plot", None)], service) - self.report = self.__class__.report(path + [("report", None)], service) - self.surface = self.__class__.surface(path + [("surface", None)], service) - self.graphics_window = self.__class__.graphics_window(path + [("graphics_window", None)], service) - - class animate(metaclass=PyMenuMeta): - """ - Enter the animation menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.playback = self.__class__.playback(path + [("playback", None)], service) + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/restore_sst_v61").execute(*args, **kwargs) + def stg_set_ti_and_tvr_limiters(self, *args, **kwargs): + """ + + Specify minimum Turbulence Intensity (TI) and Turbulent Viscosity Ratio (TVR) + to search STG scales only at inlet areas where TVR > TVR_min and TI > TI_min. + """ + return PyMenu(self.service, "/define/models/viscous/turbulence_expert/stg_set_ti_and_tvr_limiters").execute(*args, **kwargs) - class playback(metaclass=PyMenuMeta): - """ - Enter animation playback menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.video = self.__class__.video(path + [("video", None)], service) - def read(self, *args, **kwargs): - """ - Read new animation from file or already-defined animations. - """ - return PyMenu(self.service, "/results/animate/playback/read").execute(*args, **kwargs) - def play(self, *args, **kwargs): - """ - Play the selected animation. - """ - return PyMenu(self.service, "/results/animate/playback/play").execute(*args, **kwargs) - def write(self, *args, **kwargs): - """ - Write animation sequence to the file. - """ - return PyMenu(self.service, "/results/animate/playback/write").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Delete animation sequence. - """ - return PyMenu(self.service, "/results/animate/playback/delete").execute(*args, **kwargs) - def stored_view(self, *args, **kwargs): - """ - Play the 3D animation sequence using the view stored in the sequence. - """ - return PyMenu(self.service, "/results/animate/playback/stored_view").execute(*args, **kwargs) - def set_custom_frames(self, *args, **kwargs): + class geko_options(TUIMenu): """ - Set custom frames start, end, skip frames for video export. + Enters the GEKO model menu.. """ - return PyMenu(self.service, "/results/animate/playback/set_custom_frames").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def wall_distance_free(self, *args, **kwargs): + """ + Enables/disables the wall distance free version of the GEKO model. + """ + return PyMenu(self.service, "/define/models/viscous/geko_options/wall_distance_free").execute(*args, **kwargs) + def csep(self, *args, **kwargs): + """ + Setscsep, the parameter to optimize flow separation from smooth surfaces. + """ + return PyMenu(self.service, "/define/models/viscous/geko_options/csep").execute(*args, **kwargs) + def cnw(self, *args, **kwargs): + """ + Setscnw, the parameter to optimize flow in non-equilibrium near wall regions. + """ + return PyMenu(self.service, "/define/models/viscous/geko_options/cnw").execute(*args, **kwargs) + def cmix(self, *args, **kwargs): + """ + Setscmix, the parameter to optimize strength of mixing in free shear flows. + """ + return PyMenu(self.service, "/define/models/viscous/geko_options/cmix").execute(*args, **kwargs) + def cjet(self, *args, **kwargs): + """ + Setscjet, the parameter to optimize free shear layer mixing (optimize free jets independent of mixing layer). + """ + return PyMenu(self.service, "/define/models/viscous/geko_options/cjet").execute(*args, **kwargs) + def blending_function(self, *args, **kwargs): + """ + Sets the blending function, which deactivatescmix and cjet inside boundary layers. + """ + return PyMenu(self.service, "/define/models/viscous/geko_options/blending_function").execute(*args, **kwargs) + def creal(self, *args, **kwargs): + """ + Setscreal, a realizability limiter that ensures positive normal stresses in the entire domain. + """ + return PyMenu(self.service, "/define/models/viscous/geko_options/creal").execute(*args, **kwargs) + def cnw_sub(self, *args, **kwargs): + """ + Setscnw_sub, which allows the adjustment of log-layer and cf. + """ + return PyMenu(self.service, "/define/models/viscous/geko_options/cnw_sub").execute(*args, **kwargs) + def cjet_aux(self, *args, **kwargs): + """ + Setscjet_aux, which allows fine-tuning of the parameter to optimize free jets. + """ + return PyMenu(self.service, "/define/models/viscous/geko_options/cjet_aux").execute(*args, **kwargs) + def cbf_lam(self, *args, **kwargs): + """ + Setscbf_lam, a part of the blending function and shields the laminar boundary layer. + """ + return PyMenu(self.service, "/define/models/viscous/geko_options/cbf_lam").execute(*args, **kwargs) + def cbf_tur(self, *args, **kwargs): + """ + Setscbf_tur, a factor for the main blending factor, controlling the thickness of the layer near walls. + """ + return PyMenu(self.service, "/define/models/viscous/geko_options/cbf_tur").execute(*args, **kwargs) + def geko_defaults(self, *args, **kwargs): + """ + Restores the defaults of all GEKO parameters. + """ + return PyMenu(self.service, "/define/models/viscous/geko_options/geko_defaults").execute(*args, **kwargs) - class video(metaclass=PyMenuMeta): + class transition_model_options(TUIMenu): """ - Set options for exporting video file menu. + Enters the transition model options menu. """ def __init__(self, path, service): self.path = path self.service = service - self.advance_quality = self.__class__.advance_quality(path + [("advance_quality", None)], service) - def fps(self, *args, **kwargs): + super().__init__(path, service) + def crossflow_transition(self, *args, **kwargs): """ - Set the Frame Per Sec(FPS) for exporting video file. + Enables/disables the effects of crossflow instability. """ - return PyMenu(self.service, "/results/animate/playback/video/fps").execute(*args, **kwargs) - def format(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/transition_model_options/crossflow_transition").execute(*args, **kwargs) + def critical_reynolds_number_correlation(self, *args, **kwargs): """ - Set format for exporting video file. + Sets the critical Reynolds number correlation. """ - return PyMenu(self.service, "/results/animate/playback/video/format").execute(*args, **kwargs) - def quality(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/transition_model_options/critical_reynolds_number_correlation").execute(*args, **kwargs) + def clambda_scale(self, *args, **kwargs): """ - Set quality for exporting video file. + Sets the algebraic transition model coefficient CLAMBDA_SCALE. """ - return PyMenu(self.service, "/results/animate/playback/video/quality").execute(*args, **kwargs) - def name(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/transition_model_options/clambda_scale").execute(*args, **kwargs) + def capg_hightu(self, *args, **kwargs): """ - Exporting video file name. + Sets the algebraic transition model coefficient CAPG_HIGHTU. """ - return PyMenu(self.service, "/results/animate/playback/video/name").execute(*args, **kwargs) - def use_original_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/transition_model_options/capg_hightu").execute(*args, **kwargs) + def cfpg_hightu(self, *args, **kwargs): """ - Enable original resolution. + Sets the algebraic transition model coefficient CFPG_HIGHTU. """ - return PyMenu(self.service, "/results/animate/playback/video/use_original_resolution").execute(*args, **kwargs) - def scale(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/transition_model_options/cfpg_hightu").execute(*args, **kwargs) + def capg_lowtu(self, *args, **kwargs): """ - Set scale by which video resolution will expand. + Sets the algebraic transition model coefficient CAPG_LOWTU. """ - return PyMenu(self.service, "/results/animate/playback/video/scale").execute(*args, **kwargs) - def set_standard_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/transition_model_options/capg_lowtu").execute(*args, **kwargs) + def cfpg_lowtu(self, *args, **kwargs): """ - Select from pre-defined resolution list. + Sets the algebraic transition model coefficient CFPG_LOWTU. """ - return PyMenu(self.service, "/results/animate/playback/video/set_standard_resolution").execute(*args, **kwargs) - def width(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/transition_model_options/cfpg_lowtu").execute(*args, **kwargs) + def ctu_hightu(self, *args, **kwargs): """ - Set the width for exporting video file. + Sets the algebraic transition model coefficient CTU_HIGHTU. """ - return PyMenu(self.service, "/results/animate/playback/video/width").execute(*args, **kwargs) - def height(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/viscous/transition_model_options/ctu_hightu").execute(*args, **kwargs) + def ctu_lowtu(self, *args, **kwargs): """ - Set the height for exporting video file. + Sets the algebraic transition model coefficient CTU_LOWTU. """ - return PyMenu(self.service, "/results/animate/playback/video/height").execute(*args, **kwargs) - - class advance_quality(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/viscous/transition_model_options/ctu_lowtu").execute(*args, **kwargs) + def rec_max(self, *args, **kwargs): """ - Advance Quality setting. + Sets the algebraic transition model coefficient REC_MAX. """ - def __init__(self, path, service): - self.path = path - self.service = service - def bitrate_scale(self, *args, **kwargs): - """ - Mp4 bitrate scale - Best-64000 High-32000 Medium-16000 Low-8000. - """ - return PyMenu(self.service, "/results/animate/playback/video/advance_quality/bitrate_scale").execute(*args, **kwargs) - def enable_h264(self, *args, **kwargs): - """ - H264 encoding flag. - """ - return PyMenu(self.service, "/results/animate/playback/video/advance_quality/enable_h264").execute(*args, **kwargs) - def bitrate(self, *args, **kwargs): - """ - Set video bitrate(kbits/sec) for exporting video file. - """ - return PyMenu(self.service, "/results/animate/playback/video/advance_quality/bitrate").execute(*args, **kwargs) - def compression_method(self, *args, **kwargs): - """ - Compression methode for Microsoft AVI movie. - """ - return PyMenu(self.service, "/results/animate/playback/video/advance_quality/compression_method").execute(*args, **kwargs) - def keyframe(self, *args, **kwargs): - """ - Set video keyframe rate for exporting video file. - """ - return PyMenu(self.service, "/results/animate/playback/video/advance_quality/keyframe").execute(*args, **kwargs) - - class graphics(metaclass=PyMenuMeta): - """ - Enter graphics menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.expert = self.__class__.expert(path + [("expert", None)], service) - self.lights = self.__class__.lights(path + [("lights", None)], service) - self.objects = self.__class__.objects(path + [("objects", None)], service) - self.rendering_options = self.__class__.rendering_options(path + [("rendering_options", None)], service) - self.update_scene = self.__class__.update_scene(path + [("update_scene", None)], service) - def annotate(self, *args, **kwargs): - """ - Add a text annotation string to the active graphics window. - """ - return PyMenu(self.service, "/results/graphics/annotate").execute(*args, **kwargs) - def clear_annotations(self, *args, **kwargs): - """ - Delete all annotation text. - """ - return PyMenu(self.service, "/results/graphics/clear_annotations").execute(*args, **kwargs) - def color_map(self, *args, **kwargs): - """ - Enter the color-map menu. - """ - return PyMenu(self.service, "/results/graphics/color_map").execute(*args, **kwargs) - def hsf_file(self, *args, **kwargs): - """ - Display hoops stream file data to active graphics window. - """ - return PyMenu(self.service, "/results/graphics/hsf_file").execute(*args, **kwargs) + return PyMenu(self.service, "/define/models/viscous/transition_model_options/rec_max").execute(*args, **kwargs) + def rec_c1(self, *args, **kwargs): + """ + Sets the algebraic transition model coefficient REC_C1. + """ + return PyMenu(self.service, "/define/models/viscous/transition_model_options/rec_c1").execute(*args, **kwargs) + def rec_c2(self, *args, **kwargs): + """ + Sets the algebraic transition model coefficient REC_C2. + """ + return PyMenu(self.service, "/define/models/viscous/transition_model_options/rec_c2").execute(*args, **kwargs) + def cbubble_c1(self, *args, **kwargs): + """ + Sets the algebraic transition model coefficient CBUBBLE_C1. + """ + return PyMenu(self.service, "/define/models/viscous/transition_model_options/cbubble_c1").execute(*args, **kwargs) + def cbubble_c2(self, *args, **kwargs): + """ + Sets the algebraic transition model coefficient CBUBBLE_C2. + """ + return PyMenu(self.service, "/define/models/viscous/transition_model_options/cbubble_c2").execute(*args, **kwargs) + def rv1_switch(self, *args, **kwargs): + """ + Sets the algebraic transition model coefficient RV1_SWITCH. + """ + return PyMenu(self.service, "/define/models/viscous/transition_model_options/rv1_switch").execute(*args, **kwargs) - class expert(metaclass=PyMenuMeta): + class structure(TUIMenu): """ - Enter expert menu. + Enters the structure model menu. """ def __init__(self, path, service): self.path = path self.service = service - self.flamelet_data = self.__class__.flamelet_data(path + [("flamelet_data", None)], service) - self.particle_tracks = self.__class__.particle_tracks(path + [("particle_tracks", None)], service) - self.path_lines = self.__class__.path_lines(path + [("path_lines", None)], service) - self.pdf_data = self.__class__.pdf_data(path + [("pdf_data", None)], service) - self.set = self.__class__.set(path + [("set", None)], service) - def add_custom_vector(self, *args, **kwargs): - """ - Add new custom vector definition. - """ - return PyMenu(self.service, "/results/graphics/expert/add_custom_vector").execute(*args, **kwargs) - def contour(self, *args, **kwargs): - """ - Display contours of a flow variable. - """ - return PyMenu(self.service, "/results/graphics/expert/contour").execute(*args, **kwargs) - def display_custom_vector(self, *args, **kwargs): - """ - Display custom vector. - """ - return PyMenu(self.service, "/results/graphics/expert/display_custom_vector").execute(*args, **kwargs) - def graphics_window_layout(self, *args, **kwargs): - """ - Arrange the graphics window layout. - """ - return PyMenu(self.service, "/results/graphics/expert/graphics_window_layout").execute(*args, **kwargs) - def mesh(self, *args, **kwargs): - """ - Display the mesh. - """ - return PyMenu(self.service, "/results/graphics/expert/mesh").execute(*args, **kwargs) - def mesh_outline(self, *args, **kwargs): - """ - Display the mesh boundaries. - """ - return PyMenu(self.service, "/results/graphics/expert/mesh_outline").execute(*args, **kwargs) - def mesh_partition_boundary(self, *args, **kwargs): - """ - Display mesh partition boundaries. - """ - return PyMenu(self.service, "/results/graphics/expert/mesh_partition_boundary").execute(*args, **kwargs) - def multigrid_coarsening(self, *args, **kwargs): - """ - Display a coarse mesh level from the last multigrid coarsening. - """ - return PyMenu(self.service, "/results/graphics/expert/multigrid_coarsening").execute(*args, **kwargs) - def profile(self, *args, **kwargs): - """ - Display profiles of a flow variable. - """ - return PyMenu(self.service, "/results/graphics/expert/profile").execute(*args, **kwargs) - def reacting_channel_curves(self, *args, **kwargs): - """ - Plot/Report the reacting channel variables. - """ - return PyMenu(self.service, "/results/graphics/expert/reacting_channel_curves").execute(*args, **kwargs) - def re_render(self, *args, **kwargs): - """ - Re-render the last contour, profile, or velocity vector plot - with updated surfaces, meshes, lights, colormap, rendering options, etc., - without recalculating the contour data. - """ - return PyMenu(self.service, "/results/graphics/expert/re_render").execute(*args, **kwargs) - def re_scale(self, *args, **kwargs): - """ - Re-render the last contour, profile, or velocity vector plot - with updated scale, surfaces, meshes, lights, colormap, rendering options, etc., - without recalculating the field data. - """ - return PyMenu(self.service, "/results/graphics/expert/re_scale").execute(*args, **kwargs) - def set_list_tree_separator(self, *args, **kwargs): - """ - Set the separator character for list tree. - """ - return PyMenu(self.service, "/results/graphics/expert/set_list_tree_separator").execute(*args, **kwargs) - def surface_cells(self, *args, **kwargs): - """ - Draw the cells on the specified surfaces. - """ - return PyMenu(self.service, "/results/graphics/expert/surface_cells").execute(*args, **kwargs) - def surface_mesh(self, *args, **kwargs): + self.controls = self.__class__.controls(path + [("controls", None)], service) + self.expert = self.__class__.expert(path + [("expert", None)], service) + super().__init__(path, service) + def structure_off(self, *args, **kwargs): """ - Draw the mesh defined by the specified surfaces. + Disables the structural model. """ - return PyMenu(self.service, "/results/graphics/expert/surface_mesh").execute(*args, **kwargs) - def vector(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/structure/structure_off").execute(*args, **kwargs) + def linear_elasticity(self, *args, **kwargs): """ - Display space vectors. + Enables the linear elasticity model. """ - return PyMenu(self.service, "/results/graphics/expert/vector").execute(*args, **kwargs) - def velocity_vector(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/structure/linear_elasticity").execute(*args, **kwargs) + def nonlinear_elasticity(self, *args, **kwargs): """ - Display velocity vectors. + Enable the nonlinear elasticity model. """ - return PyMenu(self.service, "/results/graphics/expert/velocity_vector").execute(*args, **kwargs) - def zone_mesh(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/structure/nonlinear_elasticity").execute(*args, **kwargs) + def thermal_effects(self, *args, **kwargs): """ - Draw the mesh defined by specified face zones. + Enable structure thermal effects. """ - return PyMenu(self.service, "/results/graphics/expert/zone_mesh").execute(*args, **kwargs) + return PyMenu(self.service, "/define/models/structure/thermal_effects").execute(*args, **kwargs) - class flamelet_data(metaclass=PyMenuMeta): + class controls(TUIMenu): """ - Display flamelet data. + Enters the structure controls menu. """ def __init__(self, path, service): self.path = path self.service = service - def draw_number_box(self, *args, **kwargs): + super().__init__(path, service) + def numerical_damping_factor(self, *args, **kwargs): """ - Enable/disable display of the numbers box. + Sets the damping factor for the structural model (that is, the amplitude decay factor in in the Theory Guide). """ - return PyMenu(self.service, "/results/graphics/expert/flamelet_data/draw_number_box").execute(*args, **kwargs) - def plot_1d_slice(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/structure/controls/numerical_damping_factor").execute(*args, **kwargs) + def enhanced_strain(self, *args, **kwargs): """ - Enable/disable plot of the 1D-slice. + Enable enhanced strain element. """ - return PyMenu(self.service, "/results/graphics/expert/flamelet_data/plot_1d_slice").execute(*args, **kwargs) - def write_to_file(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/structure/controls/enhanced_strain").execute(*args, **kwargs) + def unsteady_damping_rayleigh(self, *args, **kwargs): """ - Enable/disable writing the 1D-slice to file instead of plot. + Enable/disable Newmark unsteady solution model. """ - return PyMenu(self.service, "/results/graphics/expert/flamelet_data/write_to_file").execute(*args, **kwargs) - def carpet_plot(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/structure/controls/unsteady_damping_rayleigh").execute(*args, **kwargs) + def amg_stabilization(self, *args, **kwargs): """ - Enable/disable display of carpet plot of a property. + Sets the algebraic multigrid (AMG) stabilization method for the structural model calculations. """ - return PyMenu(self.service, "/results/graphics/expert/flamelet_data/carpet_plot").execute(*args, **kwargs) + return PyMenu(self.service, "/define/models/structure/controls/amg_stabilization").execute(*args, **kwargs) + def max_iter(self, *args, **kwargs): + """ + Sets the maximum number of iterations for the structural model calculations. + """ + return PyMenu(self.service, "/define/models/structure/controls/max_iter").execute(*args, **kwargs) - class particle_tracks(metaclass=PyMenuMeta): + class expert(TUIMenu): """ - Enter the particle tracks menu. + Enters the structure expert menu. """ def __init__(self, path, service): self.path = path self.service = service - def particle_tracks(self, *args, **kwargs): + super().__init__(path, service) + def include_pop_in_fsi_force(self, *args, **kwargs): """ - Calculate and display particle tracks from defined injections. + Enables/disables the inclusion of operating pressure into the fluid-structure interaction force. """ - return PyMenu(self.service, "/results/graphics/expert/particle_tracks/particle_tracks").execute(*args, **kwargs) - def plot_write_xy_plot(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/structure/expert/include_pop_in_fsi_force").execute(*args, **kwargs) + def steady_2way_fsi(self, *args, **kwargs): """ - Plot or write XY plot of particle tracks. + Enable steady 2-way fsi workflow. """ - return PyMenu(self.service, "/results/graphics/expert/particle_tracks/plot_write_xy_plot").execute(*args, **kwargs) + return PyMenu(self.service, "/define/models/structure/expert/steady_2way_fsi").execute(*args, **kwargs) + def include_viscous_fsi_force(self, *args, **kwargs): + """ + Enables/disables the inclusion of a viscous fluid-structure interaction force. + """ + return PyMenu(self.service, "/define/models/structure/expert/include_viscous_fsi_force").execute(*args, **kwargs) + def explicit_fsi_force(self, *args, **kwargs): + """ + Enables/disables an explicit fluid-structure interaction force. + """ + return PyMenu(self.service, "/define/models/structure/expert/explicit_fsi_force").execute(*args, **kwargs) - class path_lines(metaclass=PyMenuMeta): + class heat_exchanger(TUIMenu): + """ + Enters the heat exchanger menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.macro_model = self.__class__.macro_model(path + [("macro_model", None)], service) + self.dual_cell_model = self.__class__.dual_cell_model(path + [("dual_cell_model", None)], service) + super().__init__(path, service) + + class macro_model(TUIMenu): """ - Enter the pathlines menu. + Enters the heat macro-model menu. """ def __init__(self, path, service): self.path = path self.service = service - def path_lines(self, *args, **kwargs): + super().__init__(path, service) + def heat_exchanger(self, *args, **kwargs): """ - Display pathlines from a surface. + Enables/disables heat-exchanger model. """ - return PyMenu(self.service, "/results/graphics/expert/path_lines/path_lines").execute(*args, **kwargs) - def plot_write_xy_plot(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/heat_exchanger").execute(*args, **kwargs) + def heat_exchanger_model(self, *args, **kwargs): """ - Plot or write XY plot of pathline. + Defines heat-exchanger core model. """ - return PyMenu(self.service, "/results/graphics/expert/path_lines/plot_write_xy_plot").execute(*args, **kwargs) - def write_to_files(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/heat_exchanger_model").execute(*args, **kwargs) + def heat_exchanger_zone(self, *args, **kwargs): """ - Write Pathlines to a File. + Specifies the zone that represents the heat exchanger, the dimensions of the heat exchanger, the macro grid, and the coolant direction and properties. """ - return PyMenu(self.service, "/results/graphics/expert/path_lines/write_to_files").execute(*args, **kwargs) - - class pdf_data(metaclass=PyMenuMeta): - """ - Enter the PDF data menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def draw_number_box(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/heat_exchanger_zone").execute(*args, **kwargs) + def heat_exchanger_group(self, *args, **kwargs): """ - Enable/disable the display of the numbers box. + Defines heat-exchanger group. """ - return PyMenu(self.service, "/results/graphics/expert/pdf_data/draw_number_box").execute(*args, **kwargs) - def plot_1d_slice(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/heat_exchanger_group").execute(*args, **kwargs) + def delete_heat_exchanger_group(self, *args, **kwargs): """ - Enable/disable a plot of the 1D-slice. + Deletes heat-exchanger group. """ - return PyMenu(self.service, "/results/graphics/expert/pdf_data/plot_1d_slice").execute(*args, **kwargs) - def write_to_file(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/delete_heat_exchanger_group").execute(*args, **kwargs) + def heat_exchanger_report(self, *args, **kwargs): """ - Enable/disable writing the 1D-slice to file instead of plot. + Reports the computed values of total heat rejection, outlet temperature, and inlet temperature for a specified heat-exchanger core. """ - return PyMenu(self.service, "/results/graphics/expert/pdf_data/write_to_file").execute(*args, **kwargs) - def carpet_plot(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/heat_exchanger_report").execute(*args, **kwargs) + def heat_exchanger_macro_report(self, *args, **kwargs): """ - Enable/disable the display of a carpet plot of a property. + Reports the computed values of heat rejection, outlet temperature, and inlet temperature for the macroscopic cells (macros) in a heat exchanger. """ - return PyMenu(self.service, "/results/graphics/expert/pdf_data/carpet_plot").execute(*args, **kwargs) + return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/heat_exchanger_macro_report").execute(*args, **kwargs) + def plot_NTU(self, *args, **kwargs): + """ + Plots NTU vs. primary mass flow rate for each auxiliary mass flow rate. + """ + return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/plot_NTU").execute(*args, **kwargs) + def write_NTU(self, *args, **kwargs): + """ + Writes NTU vs. primary mass flow rate for each auxiliary mass flow rate. + """ + return PyMenu(self.service, "/define/models/heat_exchanger/macro_model/write_NTU").execute(*args, **kwargs) - class set(metaclass=PyMenuMeta): + class dual_cell_model(TUIMenu): """ - Enter the set menu to set display parameters. + Enters the dual cell model menu. """ def __init__(self, path, service): self.path = path self.service = service - self.colors = self.__class__.colors(path + [("colors", None)], service) - self.contours = self.__class__.contours(path + [("contours", None)], service) - self.picture = self.__class__.picture(path + [("picture", None)], service) - self.lights = self.__class__.lights(path + [("lights", None)], service) - self.particle_tracks = self.__class__.particle_tracks(path + [("particle_tracks", None)], service) - self.path_lines = self.__class__.path_lines(path + [("path_lines", None)], service) - self.rendering_options = self.__class__.rendering_options(path + [("rendering_options", None)], service) - self.titles = self.__class__.titles(path + [("titles", None)], service) - self.velocity_vectors = self.__class__.velocity_vectors(path + [("velocity_vectors", None)], service) - self.windows = self.__class__.windows(path + [("windows", None)], service) - def color_map(self, *args, **kwargs): + super().__init__(path, service) + def heat_exchanger(self, *args, **kwargs): """ - Enter the color-map menu. + Enables/disables the dual cell heat-exchanger model. """ - return PyMenu(self.service, "/results/graphics/expert/set/color_map").execute(*args, **kwargs) - def element_shrink(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/heat_exchanger/dual_cell_model/heat_exchanger").execute(*args, **kwargs) + def add_heat_exchanger(self, *args, **kwargs): """ - Set percentage to shrink elements. + Adds heat-exchanger. """ - return PyMenu(self.service, "/results/graphics/expert/set/element_shrink").execute(*args, **kwargs) - def filled_mesh(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/heat_exchanger/dual_cell_model/add_heat_exchanger").execute(*args, **kwargs) + def modify_heat_exchanger(self, *args, **kwargs): """ - Enable/disable the filled mesh option. + Modifies heat-exchanger. """ - return PyMenu(self.service, "/results/graphics/expert/set/filled_mesh").execute(*args, **kwargs) - def mesh_level(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/heat_exchanger/dual_cell_model/modify_heat_exchanger").execute(*args, **kwargs) + def delete_heat_exchanger(self, *args, **kwargs): """ - Set coarse mesh level to be drawn. + Deletes heat-exchanger. """ - return PyMenu(self.service, "/results/graphics/expert/set/mesh_level").execute(*args, **kwargs) - def mesh_partitions(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/heat_exchanger/dual_cell_model/delete_heat_exchanger").execute(*args, **kwargs) + def plot_NTU(self, *args, **kwargs): """ - Enable/disable drawing of the mesh partition boundaries. + Plots NTU vs. primary mass flow rate for each auxiliary mass flow rate. """ - return PyMenu(self.service, "/results/graphics/expert/set/mesh_partitions").execute(*args, **kwargs) - def mesh_surfaces(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/heat_exchanger/dual_cell_model/plot_NTU").execute(*args, **kwargs) + def write_NTU(self, *args, **kwargs): """ - Set surface IDs to be drawn as mesh. + Writes NTU vs. primary mass flow rate for each auxiliary mass flow rate. """ - return PyMenu(self.service, "/results/graphics/expert/set/mesh_surfaces").execute(*args, **kwargs) - def mesh_zones(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/heat_exchanger/dual_cell_model/write_NTU").execute(*args, **kwargs) + def alternative_formulation(self, *args, **kwargs): """ - Set zone IDs to be drawn as mesh. + Enables/disables alternative formulation for heat transfer calculations. """ - return PyMenu(self.service, "/results/graphics/expert/set/mesh_zones").execute(*args, **kwargs) - def line_weight(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/heat_exchanger/dual_cell_model/alternative_formulation").execute(*args, **kwargs) + + class electrolysis_setup(TUIMenu): + """ + Enter the electrolysis model setup menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.anode_setup = self.__class__.anode_setup(path + [("anode_setup", None)], service) + self.cathode_setup = self.__class__.cathode_setup(path + [("cathode_setup", None)], service) + self.membrane_setup = self.__class__.membrane_setup(path + [("membrane_setup", None)], service) + super().__init__(path, service) + def model_options(self, *args, **kwargs): + """ + Model Options. + """ + return PyMenu(self.service, "/define/models/electrolysis_setup/model_options").execute(*args, **kwargs) + def parameters(self, *args, **kwargs): + """ + Model Parameters. + """ + return PyMenu(self.service, "/define/models/electrolysis_setup/parameters").execute(*args, **kwargs) + def electrical_tabs_setup(self, *args, **kwargs): + """ + Electrical Tabs Setup. + """ + return PyMenu(self.service, "/define/models/electrolysis_setup/electrical_tabs_setup").execute(*args, **kwargs) + + class anode_setup(TUIMenu): + """ + Anode Setup. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def current_collector(self, *args, **kwargs): """ - Set the line-weight factor for the window. + Set Current Collector. """ - return PyMenu(self.service, "/results/graphics/expert/set/line_weight").execute(*args, **kwargs) - def marker_size(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/electrolysis_setup/anode_setup/current_collector").execute(*args, **kwargs) + def flow_channel(self, *args, **kwargs): """ - Set the size of markers used to represent points. + Set Flow Channel. """ - return PyMenu(self.service, "/results/graphics/expert/set/marker_size").execute(*args, **kwargs) - def marker_symbol(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/electrolysis_setup/anode_setup/flow_channel").execute(*args, **kwargs) + def porous_layer(self, *args, **kwargs): """ - Set the type of markers used to represent points. + Set Porous Layer. """ - return PyMenu(self.service, "/results/graphics/expert/set/marker_symbol").execute(*args, **kwargs) - def mesh_display_configuration(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/electrolysis_setup/anode_setup/porous_layer").execute(*args, **kwargs) + def catalyst_layer(self, *args, **kwargs): """ - Set mesh display configuration. + Set Catalyst Layer. """ - return PyMenu(self.service, "/results/graphics/expert/set/mesh_display_configuration").execute(*args, **kwargs) - def mirror_zones(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/electrolysis_setup/anode_setup/catalyst_layer").execute(*args, **kwargs) + def electrolyte(self, *args, **kwargs): """ - Set zones to mirror the domain about. + Set Electrolyte. """ - return PyMenu(self.service, "/results/graphics/expert/set/mirror_zones").execute(*args, **kwargs) - def n_stream_func(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/electrolysis_setup/anode_setup/electrolyte").execute(*args, **kwargs) + + class cathode_setup(TUIMenu): + """ + Cathode Setup. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def current_collector(self, *args, **kwargs): """ - Set the number of iterations used in computing stream function. + Set Current Collector. """ - return PyMenu(self.service, "/results/graphics/expert/set/n_stream_func").execute(*args, **kwargs) - def nodewt_based_interp(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/electrolysis_setup/cathode_setup/current_collector").execute(*args, **kwargs) + def flow_channel(self, *args, **kwargs): """ - Use more accurate node-weight based interpolation for postprocessing. + Set Flow Channel. """ - return PyMenu(self.service, "/results/graphics/expert/set/nodewt_based_interp").execute(*args, **kwargs) - def overlays(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/electrolysis_setup/cathode_setup/flow_channel").execute(*args, **kwargs) + def porous_layer(self, *args, **kwargs): """ - Enable/disable overlays. + Set Porous Layer. """ - return PyMenu(self.service, "/results/graphics/expert/set/overlays").execute(*args, **kwargs) - def periodic_instancing(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/electrolysis_setup/cathode_setup/porous_layer").execute(*args, **kwargs) + def catalyst_layer(self, *args, **kwargs): """ - Set periodic instancing. + Set Catalyst Layer. """ - return PyMenu(self.service, "/results/graphics/expert/set/periodic_instancing").execute(*args, **kwargs) - def proximity_zones(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/electrolysis_setup/cathode_setup/catalyst_layer").execute(*args, **kwargs) + def electrolyte(self, *args, **kwargs): """ - Set zones to be used for boundary cell distance and boundary proximity. + Set Electrolyte. """ - return PyMenu(self.service, "/results/graphics/expert/set/proximity_zones").execute(*args, **kwargs) - def render_mesh(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/electrolysis_setup/cathode_setup/electrolyte").execute(*args, **kwargs) + + class membrane_setup(TUIMenu): + """ + Membrane Setup. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def current_collector(self, *args, **kwargs): """ - Enable/disable rendering the mesh on top of contours, vectors, etc. + Set Current Collector. """ - return PyMenu(self.service, "/results/graphics/expert/set/render_mesh").execute(*args, **kwargs) - def reset_graphics(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/electrolysis_setup/membrane_setup/current_collector").execute(*args, **kwargs) + def flow_channel(self, *args, **kwargs): """ - Reset the graphics system. + Set Flow Channel. """ - return PyMenu(self.service, "/results/graphics/expert/set/reset_graphics").execute(*args, **kwargs) - def zero_angle_dir(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/electrolysis_setup/membrane_setup/flow_channel").execute(*args, **kwargs) + def porous_layer(self, *args, **kwargs): """ - Set the vector having zero angular coordinates. + Set Porous Layer. """ - return PyMenu(self.service, "/results/graphics/expert/set/zero_angle_dir").execute(*args, **kwargs) - def duplicate_node_display(self, *args, **kwargs): + return PyMenu(self.service, "/define/models/electrolysis_setup/membrane_setup/porous_layer").execute(*args, **kwargs) + def catalyst_layer(self, *args, **kwargs): """ - Set flag to remove duplicate nodes in mesh display. + Set Catalyst Layer. """ - return PyMenu(self.service, "/results/graphics/expert/set/duplicate_node_display").execute(*args, **kwargs) - - class colors(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/models/electrolysis_setup/membrane_setup/catalyst_layer").execute(*args, **kwargs) + def electrolyte(self, *args, **kwargs): """ - Enter the color options menu. + Set Electrolyte. """ - def __init__(self, path, service): - self.path = path - self.service = service - self.by_type = self.__class__.by_type(path + [("by_type", None)], service) - self.by_surface = self.__class__.by_surface(path + [("by_surface", None)], service) - def background(self, *args, **kwargs): - """ - Set the background (window) color. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/background").execute(*args, **kwargs) - def color_by_type(self, *args, **kwargs): - """ - Determine whether to color meshes by type or by surface (ID). - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/color_by_type").execute(*args, **kwargs) - def foreground(self, *args, **kwargs): - """ - Set the foreground (text and window frame) color. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/foreground").execute(*args, **kwargs) - def far_field_faces(self, *args, **kwargs): - """ - Set the color of far field faces. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/far_field_faces").execute(*args, **kwargs) - def inlet_faces(self, *args, **kwargs): - """ - Set the color of inlet faces. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/inlet_faces").execute(*args, **kwargs) - def interior_faces(self, *args, **kwargs): - """ - Set the color of interior faces. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/interior_faces").execute(*args, **kwargs) - def internal_faces(self, *args, **kwargs): - """ - Set the color of internal interface faces. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/internal_faces").execute(*args, **kwargs) - def outlet_faces(self, *args, **kwargs): - """ - Set the color of outlet faces. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/outlet_faces").execute(*args, **kwargs) - def overset_faces(self, *args, **kwargs): - """ - Set the color of overset faces. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/overset_faces").execute(*args, **kwargs) - def periodic_faces(self, *args, **kwargs): - """ - Set the color of periodic faces. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/periodic_faces").execute(*args, **kwargs) - def rans_les_interface_faces(self, *args, **kwargs): - """ - Set the color of RANS/LES interface faces. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/rans_les_interface_faces").execute(*args, **kwargs) - def reset_user_colors(self, *args, **kwargs): - """ - Reset all user colors. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/reset_user_colors").execute(*args, **kwargs) - def show_user_colors(self, *args, **kwargs): - """ - List currently defined user colors. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/show_user_colors").execute(*args, **kwargs) - def symmetry_faces(self, *args, **kwargs): - """ - Set the color of symmetric faces. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/symmetry_faces").execute(*args, **kwargs) - def axis_faces(self, *args, **kwargs): - """ - Set the color of axisymmetric faces. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/axis_faces").execute(*args, **kwargs) - def free_surface_faces(self, *args, **kwargs): - """ - Set the color of free-surface faces. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/free_surface_faces").execute(*args, **kwargs) - def traction_faces(self, *args, **kwargs): - """ - Set the color of traction faces. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/traction_faces").execute(*args, **kwargs) - def user_color(self, *args, **kwargs): - """ - Explicitly set color of display zone. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/user_color").execute(*args, **kwargs) - def wall_faces(self, *args, **kwargs): - """ - Set the color of wall faces. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/wall_faces").execute(*args, **kwargs) - def interface_faces(self, *args, **kwargs): - """ - Set the color of mesh Interfaces. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/interface_faces").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - List available colors. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/list").execute(*args, **kwargs) - def reset_colors(self, *args, **kwargs): - """ - Reset individual mesh surface colors to the defaults. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/reset_colors").execute(*args, **kwargs) - def surface(self, *args, **kwargs): - """ - Set the color of surfaces. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/surface").execute(*args, **kwargs) - def skip_label(self, *args, **kwargs): - """ - Set the number of labels to be skipped in the colopmap scale. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/skip_label").execute(*args, **kwargs) - def automatic_skip(self, *args, **kwargs): - """ - Determine whether to skip labels in the colopmap scale automatically. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/automatic_skip").execute(*args, **kwargs) - def graphics_color_theme(self, *args, **kwargs): - """ - Enter the graphics color theme menu. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/graphics_color_theme").execute(*args, **kwargs) - - class by_type(metaclass=PyMenuMeta): - """ - Enter the zone type color and material assignment menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.type_name = self.__class__.type_name(path + [("type_name", None)], service) - def only_list_case_boundaries(self, *args, **kwargs): - """ - Only list the boundary types that are assigned in this case. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/only_list_case_boundaries").execute(*args, **kwargs) - def use_inherent_material_color(self, *args, **kwargs): - """ - Use inherent material color for boundary zones. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/use_inherent_material_color").execute(*args, **kwargs) - def reset(self, *args, **kwargs): - """ - To reset colors and/or materials to the defaults. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/reset").execute(*args, **kwargs) - - class type_name(metaclass=PyMenuMeta): - """ - Select the boundary type to specify colors and/or materials. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.axis = self.__class__.axis(path + [("axis", None)], service) - self.far_field = self.__class__.far_field(path + [("far_field", None)], service) - self.free_surface = self.__class__.free_surface(path + [("free_surface", None)], service) - self.inlet = self.__class__.inlet(path + [("inlet", None)], service) - self.interface = self.__class__.interface(path + [("interface", None)], service) - self.interior = self.__class__.interior(path + [("interior", None)], service) - self.internal = self.__class__.internal(path + [("internal", None)], service) - self.outlet = self.__class__.outlet(path + [("outlet", None)], service) - self.overset = self.__class__.overset(path + [("overset", None)], service) - self.periodic = self.__class__.periodic(path + [("periodic", None)], service) - self.rans_les_interface = self.__class__.rans_les_interface(path + [("rans_les_interface", None)], service) - self.surface = self.__class__.surface(path + [("surface", None)], service) - self.symmetry = self.__class__.symmetry(path + [("symmetry", None)], service) - self.traction = self.__class__.traction(path + [("traction", None)], service) - self.wall = self.__class__.wall(path + [("wall", None)], service) + return PyMenu(self.service, "/define/models/electrolysis_setup/membrane_setup/electrolyte").execute(*args, **kwargs) - class axis(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/axis/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/axis/material").execute(*args, **kwargs) + class overset_interfaces(TUIMenu): + """ + Enters the overset interfaces menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.options = self.__class__.options(path + [("options", None)], service) + self.cut_control = self.__class__.cut_control(path + [("cut_control", None)], service) + self.adapt = self.__class__.adapt(path + [("adapt", None)], service) + super().__init__(path, service) + def create(self, *args, **kwargs): + """ + Creates an overset interface. + """ + return PyMenu(self.service, "/define/overset_interfaces/create").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes an overset interface. + """ + return PyMenu(self.service, "/define/overset_interfaces/delete").execute(*args, **kwargs) + def delete_all(self, *args, **kwargs): + """ + Deletes all overset interfaces in the domain. + """ + return PyMenu(self.service, "/define/overset_interfaces/delete_all").execute(*args, **kwargs) + def intersect(self, *args, **kwargs): + """ + Executes the hole cutting of an overset interface and establishes the domain connectivity. This text command is only available when define/overset-interfaces/options/expert? is set to yes. + """ + return PyMenu(self.service, "/define/overset_interfaces/intersect").execute(*args, **kwargs) + def intersect_all(self, *args, **kwargs): + """ + Executes hole cutting for all overset interfaces in the domain. This text command is only available when define/overset-interfaces/options/expert? is set to yes. + """ + return PyMenu(self.service, "/define/overset_interfaces/intersect_all").execute(*args, **kwargs) + def clear(self, *args, **kwargs): + """ + Clears the domain connectivity of an overset interface. This text command is only available when define/overset-interfaces/options/expert? is set to yes. + """ + return PyMenu(self.service, "/define/overset_interfaces/clear").execute(*args, **kwargs) + def clear_all(self, *args, **kwargs): + """ + Clears the domain connectivity of all overset interfaces. This text command is only available when define/overset-interfaces/options/expert? is set to yes. + """ + return PyMenu(self.service, "/define/overset_interfaces/clear_all").execute(*args, **kwargs) + def grid_priorities(self, *args, **kwargs): + """ + Allows you to specify grid priorities on background and component meshes, used in the overlap minimization of an overset interface. + """ + return PyMenu(self.service, "/define/overset_interfaces/grid_priorities").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Lists information about the overset interfaces. The output depends on the overset verbosity setting. + """ + return PyMenu(self.service, "/define/overset_interfaces/list").execute(*args, **kwargs) + def mark_cells(self, *args, **kwargs): + """ + Marks the specified overset cells (solve, receptor, donor, orphan, or dead) and fills registers based on the markings. Display the marked cells via the text command define/overset-interfaces/display-cells. + """ + return PyMenu(self.service, "/define/overset_interfaces/mark_cells").execute(*args, **kwargs) + def display_cells(self, *args, **kwargs): + """ + Displays the overset cells marked using the text command define/overset-interfaces/mark-cells. + """ + return PyMenu(self.service, "/define/overset_interfaces/display_cells").execute(*args, **kwargs) + def mark_cell_change(self, *args, **kwargs): + """ + Marks cells that have undergone a specified overset cell type change (from solve,receptor, or dead to any other type) in the last time step. Adaption registers are automatically filled based on these markings. This text command is only available for unsteady simulations and if define/overset-interfaces/options/expert? is set to yes. + """ + return PyMenu(self.service, "/define/overset_interfaces/mark_cell_change").execute(*args, **kwargs) + def set_mark_bounds(self, *args, **kwargs): + """ + Allows you to set bounds so that any marking of cells is performed within a spherical region based on a specified origin and radius. This can be useful when diagnosing a local problem on a large mesh. This text command is only available if define/overset-interfaces/options/expert? is set to yes. After defining the bounds, you can then mark the cells using the define/overset-interfaces/mark-cell-change or define/overset-interfaces/mark-cells text command. To disable the bounds, enter a radius of 0. + """ + return PyMenu(self.service, "/define/overset_interfaces/set_mark_bounds").execute(*args, **kwargs) + def check(self, *args, **kwargs): + """ + Checks the integrity of the overset interfaces. Reports orphan cells and errors in the domain connectivity. + """ + return PyMenu(self.service, "/define/overset_interfaces/check").execute(*args, **kwargs) + def debug_hole_cut(self, *args, **kwargs): + """ + Debugging tool to troubleshoot hole cutting of overset interfaces. This text command is only available when define/overset-interfaces/options/expert? is set to yes. + """ + return PyMenu(self.service, "/define/overset_interfaces/debug_hole_cut").execute(*args, **kwargs) + def fill_dci(self, *args, **kwargs): + """ + Fill overset domain connectivity information (DCI). + """ + return PyMenu(self.service, "/define/overset_interfaces/fill_dci").execute(*args, **kwargs) + def free_dci(self, *args, **kwargs): + """ + Free overset domain connectivity information (DCI). + """ + return PyMenu(self.service, "/define/overset_interfaces/free_dci").execute(*args, **kwargs) + def update_from_dci(self, *args, **kwargs): + """ + Update all overset intrfaces from stored domain connectivity information (DCI). + """ + return PyMenu(self.service, "/define/overset_interfaces/update_from_dci").execute(*args, **kwargs) + def write_dci_to_case(self, *args, **kwargs): + """ + Save domain connectivity information (DCI) to case file. + """ + return PyMenu(self.service, "/define/overset_interfaces/write_dci_to_case").execute(*args, **kwargs) + def read_dci_from_case(self, *args, **kwargs): + """ + Read domain connectivity information (DCI) from case file. + """ + return PyMenu(self.service, "/define/overset_interfaces/read_dci_from_case").execute(*args, **kwargs) + def write_dci(self, *args, **kwargs): + """ + Save domain connectivity information (DCI) to a text file. + """ + return PyMenu(self.service, "/define/overset_interfaces/write_dci").execute(*args, **kwargs) + def write_cell_types(self, *args, **kwargs): + """ + Write overset cell types into file. + """ + return PyMenu(self.service, "/define/overset_interfaces/write_cell_types").execute(*args, **kwargs) + def find_bounding_cell(self, *args, **kwargs): + """ + Find bounding cell for given cell or search point. + """ + return PyMenu(self.service, "/define/overset_interfaces/find_bounding_cell").execute(*args, **kwargs) + def find_all_bounding_cells(self, *args, **kwargs): + """ + Find bounding cells for all cell centroids. + """ + return PyMenu(self.service, "/define/overset_interfaces/find_all_bounding_cells").execute(*args, **kwargs) - class far_field(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/far_field/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/far_field/material").execute(*args, **kwargs) + class options(TUIMenu): + """ + Enters the overset interface options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def expert(self, *args, **kwargs): + """ + Enables / disables overset-related expert tools. + """ + return PyMenu(self.service, "/define/overset_interfaces/options/expert").execute(*args, **kwargs) + def render_receptor_cells(self, *args, **kwargs): + """ + Allows you to enable visualization of receptor cells in contour and mesh displays. + """ + return PyMenu(self.service, "/define/overset_interfaces/options/render_receptor_cells").execute(*args, **kwargs) + def partial_cut_faces(self, *args, **kwargs): + """ + Enables/disables enhanced hole cutting, where partially overlapping cut faces are decomposed into overlapping and non-overlapping fractions, and only the non-overlapping fractions participate in the hole cutting. This can help avoid the situation where a region or cell zone is erroneously identified as dead because of leakage during flood filling, even though it has overlapping boundaries that match well. When this text command is disabled, the partially overlapping faces are entirely protected from cutting. + """ + return PyMenu(self.service, "/define/overset_interfaces/options/partial_cut_faces").execute(*args, **kwargs) + def auto_create(self, *args, **kwargs): + """ + Enables the automatic creation of a default overset interface during initialization or mesh motion update. + """ + return PyMenu(self.service, "/define/overset_interfaces/options/auto_create").execute(*args, **kwargs) + def minimize_overlap(self, *args, **kwargs): + """ + Allows you to disable overlap minimization during hole cutting. + """ + return PyMenu(self.service, "/define/overset_interfaces/options/minimize_overlap").execute(*args, **kwargs) + def overlap_boundaries(self, *args, **kwargs): + """ + Allows you to disable the detection of overlapping boundaries during hole cutting, in order to reduce the computational expense for cases that do not include such boundaries. When enabled, this text command also allows you to specify which boundary zones should be considered when detecting overlapping boundaries; this can be helpful when the default hole cutting process fails. + """ + return PyMenu(self.service, "/define/overset_interfaces/options/overlap_boundaries").execute(*args, **kwargs) + def mesh_interfaces(self, *args, **kwargs): + """ + Allows the inclusion of non-conformal mesh interfaces inside overset cell zones, as long as the mesh interfaces do not spatially overlap with the cells where the overset interfaces lie. + """ + return PyMenu(self.service, "/define/overset_interfaces/options/mesh_interfaces").execute(*args, **kwargs) + def node_connected_donors(self, *args, **kwargs): + """ + Allows you to switch between face or node connected donor cells. This text command is only available when define/overset-interfaces/options/expert? is set to yes. + """ + return PyMenu(self.service, "/define/overset_interfaces/options/node_connected_donors").execute(*args, **kwargs) + def donor_priority_method(self, *args, **kwargs): + """ + Allows you to specify whether the cell donor priority used in the overlap minimization of an overset interface is inversely proportional to either the cell size or the distance to the nearest boundary. + """ + return PyMenu(self.service, "/define/overset_interfaces/options/donor_priority_method").execute(*args, **kwargs) + def solve_island_removal(self, *args, **kwargs): + """ + Sets the method used to control the removal of isolated patches of solve cells. This text command is only available when define/overset-interfaces/options/expert? is set to yes. + """ + return PyMenu(self.service, "/define/overset_interfaces/options/solve_island_removal").execute(*args, **kwargs) + def transient_caching(self, *args, **kwargs): + """ + Sets the options to control caching of entities in transient overset simulations. This text command is only available when define/overset-interfaces/options/expert? is set to yes. + """ + return PyMenu(self.service, "/define/overset_interfaces/options/transient_caching").execute(*args, **kwargs) + def modified_donor_search(self, *args, **kwargs): + """ + Enables / disables modified donor search parameters. When enabled, these parameters result in a more extended donor search, which can be helpful for meshes with orphans. This text command is only available when define/overset-interfaces/options/expert? is set to yes. + """ + return PyMenu(self.service, "/define/overset_interfaces/options/modified_donor_search").execute(*args, **kwargs) + def modified_hole_cutting(self, *args, **kwargs): + """ + Enables / disables modified hole cutting parameters. When enabled, the parameters used can help avoid dead cell zones that result from a hole cutting failure. This text command is only available when define/overset-interfaces/options/expert? is set to yes. + """ + return PyMenu(self.service, "/define/overset_interfaces/options/modified_hole_cutting").execute(*args, **kwargs) + def dead_cell_update(self, *args, **kwargs): + """ + Enables/disables the updating of dead cells during the solution process, which may be helpful for some moving and dynamic mesh simulations (though at the cost of solver performance). You can enter the number of layers of dead cells adjacent to the receptor cells that you want updated, or enter -1 to request that all dead cells are updated. This text command is only available for transient simulations when define/overset-interfaces/options/expert? is set to yes. + """ + return PyMenu(self.service, "/define/overset_interfaces/options/dead_cell_update").execute(*args, **kwargs) + def update_before_case_write(self, *args, **kwargs): + """ + Enables/disables the updating of the overset interfaces before writing a case file in the Common Fluids Format (CFF). This text command is only available when define/overset-interfaces/options/expert? is set to yes. + """ + return PyMenu(self.service, "/define/overset_interfaces/options/update_before_case_write").execute(*args, **kwargs) + def parallel(self, *args, **kwargs): + """ + Allows you to select the algorithm used for overset parallel processing. You can select from the default cell exchange model or the local cell zone replication model; the cell exchange model should require less memory and may result in faster calculations. + """ + return PyMenu(self.service, "/define/overset_interfaces/options/parallel").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Specifies the level of detail printed in the console about overset interfaces. + """ + return PyMenu(self.service, "/define/overset_interfaces/options/verbosity").execute(*args, **kwargs) - class free_surface(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/free_surface/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/free_surface/material").execute(*args, **kwargs) + class cut_control(TUIMenu): + """ + Enters the overset hole cut control menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.cut_seeds = self.__class__.cut_seeds(path + [("cut_seeds", None)], service) + super().__init__(path, service) + def add(self, *args, **kwargs): + """ + Adds a hole cut control, so that a boundary zone does not cut specified cell zones. + """ + return PyMenu(self.service, "/define/overset_interfaces/cut_control/add").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes the hole cut control for a boundary zone. + """ + return PyMenu(self.service, "/define/overset_interfaces/cut_control/delete").execute(*args, **kwargs) + def delete_all(self, *args, **kwargs): + """ + Deletes the hole cut controls for all boundary zones. + """ + return PyMenu(self.service, "/define/overset_interfaces/cut_control/delete_all").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Lists the defined hole cut controls. + """ + return PyMenu(self.service, "/define/overset_interfaces/cut_control/list").execute(*args, **kwargs) - class inlet(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/inlet/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/inlet/material").execute(*args, **kwargs) + class cut_seeds(TUIMenu): + """ + Enters the overset hole cut seeds menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add(self, *args, **kwargs): + """ + Add a hole cut seed. + """ + return PyMenu(self.service, "/define/overset_interfaces/cut_control/cut_seeds/add").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Delete a hole cut seed. + """ + return PyMenu(self.service, "/define/overset_interfaces/cut_control/cut_seeds/delete").execute(*args, **kwargs) + def delete_all(self, *args, **kwargs): + """ + Delete all hole cut seeds. + """ + return PyMenu(self.service, "/define/overset_interfaces/cut_control/cut_seeds/delete_all").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + List the defined hole cut seeds. + """ + return PyMenu(self.service, "/define/overset_interfaces/cut_control/cut_seeds/list").execute(*args, **kwargs) + def cut_seeds_for_all_component_zones(self, *args, **kwargs): + """ + Specifies whether all component zones get cut seeds, which cut pilot holes into the overlapping meshes that will then be enlarged during overlap minimization. + """ + return PyMenu(self.service, "/define/overset_interfaces/cut_control/cut_seeds/cut_seeds_for_all_component_zones").execute(*args, **kwargs) - class interface(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/interface/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/interface/material").execute(*args, **kwargs) + class adapt(TUIMenu): + """ + Enters the overset adaption menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) + def mark_adaption(self, *args, **kwargs): + """ + Marks cells to identify those that can be adapted in order to improve your overset mesh. + """ + return PyMenu(self.service, "/define/overset_interfaces/adapt/mark_adaption").execute(*args, **kwargs) + def adapt_mesh(self, *args, **kwargs): + """ + Marks and adapts the mesh to improve your overset mesh. + """ + return PyMenu(self.service, "/define/overset_interfaces/adapt/adapt_mesh").execute(*args, **kwargs) - class interior(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/interior/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/interior/material").execute(*args, **kwargs) + class set(TUIMenu): + """ + Enters the overset adaption set menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def mark_orphans(self, *args, **kwargs): + """ + Enables/disables the option to adapt for orphan reduction. + """ + return PyMenu(self.service, "/define/overset_interfaces/adapt/set/mark_orphans").execute(*args, **kwargs) + def mark_fixed_orphans(self, *args, **kwargs): + """ + Enables/disables the option to also adapt based on cells that are not actual orphans because they were fixed by accepting neighbor donors. This option is only applied if define/overset-interfaces/adapt/set/mark-orphans? is enabled. + """ + return PyMenu(self.service, "/define/overset_interfaces/adapt/set/mark_fixed_orphans").execute(*args, **kwargs) + def mark_size(self, *args, **kwargs): + """ + Enables/disables the option to adapt based on donor-receptor cell size differences. + """ + return PyMenu(self.service, "/define/overset_interfaces/adapt/set/mark_size").execute(*args, **kwargs) + def mark_gaps(self, *args, **kwargs): + """ + Enable the option to adapt underresolved gaps. + """ + return PyMenu(self.service, "/define/overset_interfaces/adapt/set/mark_gaps").execute(*args, **kwargs) + def mark_coarsening(self, *args, **kwargs): + """ + Enables/disables the option to coarsen the mesh if mesh refinement is no longer needed. This option is enabled by default. + """ + return PyMenu(self.service, "/define/overset_interfaces/adapt/set/mark_coarsening").execute(*args, **kwargs) + def anisotropic(self, *args, **kwargs): + """ + Enable the option to use anisotropic adaption in prismatic cells. + """ + return PyMenu(self.service, "/define/overset_interfaces/adapt/set/anisotropic").execute(*args, **kwargs) + def automatic(self, *args, **kwargs): + """ + Enable the option to automatically adapt overset meshes during solution update. + """ + return PyMenu(self.service, "/define/overset_interfaces/adapt/set/automatic").execute(*args, **kwargs) + def length_ratio_max(self, *args, **kwargs): + """ + Sets the length scale ratio threshold used to determine which cells are marked for adaption based on donor-receptor cell size differences. + """ + return PyMenu(self.service, "/define/overset_interfaces/adapt/set/length_ratio_max").execute(*args, **kwargs) + def buffer_layers(self, *args, **kwargs): + """ + Sets the number of cell layers marked in addition to the cells marked for orphan adaption. + """ + return PyMenu(self.service, "/define/overset_interfaces/adapt/set/buffer_layers").execute(*args, **kwargs) + def adaption_sweeps(self, *args, **kwargs): + """ + Sets the number of rounds of adaption applied during each adaption cycle. + """ + return PyMenu(self.service, "/define/overset_interfaces/adapt/set/adaption_sweeps").execute(*args, **kwargs) + def maximum_refinement_level(self, *args, **kwargs): + """ + Sets the maximum level of refinement during overset adaption, in conjunction with the value set using the mesh/adapt/set/maximum-refinement-level text command (the larger of the two values is used). + """ + return PyMenu(self.service, "/define/overset_interfaces/adapt/set/maximum_refinement_level").execute(*args, **kwargs) - class internal(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/internal/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/internal/material").execute(*args, **kwargs) + class operating_conditions(TUIMenu): + """ + Enters the define operating conditions menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def gravity(self, *args, **kwargs): + """ + Sets gravitational acceleration. + """ + return PyMenu(self.service, "/define/operating_conditions/gravity").execute(*args, **kwargs) + def gravity_mrf_rotation(self, *args, **kwargs): + """ + Enables/disables rotation of gravity vector in moving reference frame simulations. If enabled, the gravity vector will rotate with respect to the moving reference frame such that the direction of gravity in global coordinates remains fixed. + """ + return PyMenu(self.service, "/define/operating_conditions/gravity_mrf_rotation").execute(*args, **kwargs) + def set_state(self, *args, **kwargs): + """ + Selects state for real gas EOS subcritical condition. + """ + return PyMenu(self.service, "/define/operating_conditions/set_state").execute(*args, **kwargs) + def operating_pressure(self, *args, **kwargs): + """ + Sets the operating pressure. + """ + return PyMenu(self.service, "/define/operating_conditions/operating_pressure").execute(*args, **kwargs) + def reference_pressure_location(self, *args, **kwargs): + """ + Sets a location that determines the reference pressure cell or cells (depending on the selected reference pressure method). The pressure value in such cells can be used to adjust the gauge pressure field after each iteration to keep it from floating. + """ + return PyMenu(self.service, "/define/operating_conditions/reference_pressure_location").execute(*args, **kwargs) + def reference_pressure_method(self, *args, **kwargs): + """ + Specifies the method used for adjusting the gauge pressure field after each iteration to keep it from floating: the method can assume that all of the cell zones are connected by internal boundary zones (such as interior zones), or can account for connected and disconnected cell zones. Such adjustment is only allowed for incompressible flows, and will be limited partially or entirely by the presence of a pressure boundary. + """ + return PyMenu(self.service, "/define/operating_conditions/reference_pressure_method").execute(*args, **kwargs) + def used_ref_pressure_location(self, *args, **kwargs): + """ + Prints the coordinates of the reference pressure cell or cells (depending on the selected reference pressure method). The pressure value in such cells can be used to adjust the gauge pressure field after each iteration to keep it from floating. + """ + return PyMenu(self.service, "/define/operating_conditions/used_ref_pressure_location").execute(*args, **kwargs) + def operating_density(self, *args, **kwargs): + """ + Enable/disable use of a specified operating density. + """ + return PyMenu(self.service, "/define/operating_conditions/operating_density").execute(*args, **kwargs) + def use_inlet_temperature_for_operating_density(self, *args, **kwargs): + """ + Uses inlet temperature to calculate operating density. + """ + return PyMenu(self.service, "/define/operating_conditions/use_inlet_temperature_for_operating_density").execute(*args, **kwargs) + def operating_temperature(self, *args, **kwargs): + """ + Sets the operating temperature for Boussinesq. + """ + return PyMenu(self.service, "/define/operating_conditions/operating_temperature").execute(*args, **kwargs) - class outlet(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/outlet/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/outlet/material").execute(*args, **kwargs) + class parameters(TUIMenu): + """ + Enters the parameters menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.input_parameters = self.__class__.input_parameters(path + [("input_parameters", None)], service) + self.output_parameters = self.__class__.output_parameters(path + [("output_parameters", None)], service) + self.list_parameters = self.__class__.list_parameters(path + [("list_parameters", None)], service) + super().__init__(path, service) + def enable_in_TUI(self, *args, **kwargs): + """ + Enables/disables parameters in the text user interface. + """ + return PyMenu(self.service, "/define/parameters/enable_in_TUI").execute(*args, **kwargs) - class overset(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/overset/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/overset/material").execute(*args, **kwargs) + class input_parameters(TUIMenu): + """ + Enters the input-parameters menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.advance = self.__class__.advance(path + [("advance", None)], service) + super().__init__(path, service) + def edit(self, *args, **kwargs): + """ + Edits an input parameter. + """ + return PyMenu(self.service, "/define/parameters/input_parameters/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes an input parameter. + """ + return PyMenu(self.service, "/define/parameters/input_parameters/delete").execute(*args, **kwargs) - class periodic(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/periodic/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/periodic/material").execute(*args, **kwargs) + class advance(TUIMenu): + """ + Define custom variable to use input parameter. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def use_in(self, *args, **kwargs): + """ + Use input parameter in solver-udf or in scheme-procedure. + """ + return PyMenu(self.service, "/define/parameters/input_parameters/advance/use_in").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + List of custom-input-parameters. + """ + return PyMenu(self.service, "/define/parameters/input_parameters/advance/list").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Delete selected custom-input-parameters. + """ + return PyMenu(self.service, "/define/parameters/input_parameters/advance/delete").execute(*args, **kwargs) - class rans_les_interface(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/rans_les_interface/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/rans_les_interface/material").execute(*args, **kwargs) + class output_parameters(TUIMenu): + """ + Enters the output-parameters menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def create(self, *args, **kwargs): + """ + Creates an output parameter. + """ + return PyMenu(self.service, "/define/parameters/output_parameters/create").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edits an output parameter. + """ + return PyMenu(self.service, "/define/parameters/output_parameters/edit").execute(*args, **kwargs) + def rename(self, *args, **kwargs): + """ + Renames an output parameter. + """ + return PyMenu(self.service, "/define/parameters/output_parameters/rename").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes an output parameter. + """ + return PyMenu(self.service, "/define/parameters/output_parameters/delete").execute(*args, **kwargs) + def print_to_console(self, *args, **kwargs): + """ + Displays parameter value in the console. + """ + return PyMenu(self.service, "/define/parameters/output_parameters/print_to_console").execute(*args, **kwargs) + def print_all_to_console(self, *args, **kwargs): + """ + Displays all parameter values in the console. + """ + return PyMenu(self.service, "/define/parameters/output_parameters/print_all_to_console").execute(*args, **kwargs) + def write_to_file(self, *args, **kwargs): + """ + Writes parameter value to file. + """ + return PyMenu(self.service, "/define/parameters/output_parameters/write_to_file").execute(*args, **kwargs) + def write_all_to_file(self, *args, **kwargs): + """ + Writes all parameter values to file. + """ + return PyMenu(self.service, "/define/parameters/output_parameters/write_all_to_file").execute(*args, **kwargs) - class surface(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/surface/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/surface/material").execute(*args, **kwargs) + class list_parameters(TUIMenu): + """ + Enter list-param menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def input_parameters(self, *args, **kwargs): + """ + List all input parameters. + """ + return PyMenu(self.service, "/define/parameters/list_parameters/input_parameters").execute(*args, **kwargs) + def output_parameters(self, *args, **kwargs): + """ + List all output parameters. + """ + return PyMenu(self.service, "/define/parameters/list_parameters/output_parameters").execute(*args, **kwargs) - class symmetry(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/symmetry/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/symmetry/material").execute(*args, **kwargs) + class periodic_conditions(TUIMenu): + """ + Enters the periodic conditions menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def massflow_rate_specification(self, *args, **kwargs): + """ + Enables/disables specification of mass flow rate at the periodic boundary. + """ + return PyMenu(self.service, "/define/periodic_conditions/massflow_rate_specification").execute(*args, **kwargs) + def pressure_gradient_specification(self, *args, **kwargs): + """ + Enables/disables specification of pressure gradient at the periodic boundary. + """ + return PyMenu(self.service, "/define/periodic_conditions/pressure_gradient_specification").execute(*args, **kwargs) - class traction(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/traction/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/traction/material").execute(*args, **kwargs) + class turbo_model(TUIMenu): + """ + Enters the turbo menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.turbo_topology = self.__class__.turbo_topology(path + [("turbo_topology", None)], service) + self.general_turbo_interface_settings = self.__class__.general_turbo_interface_settings(path + [("general_turbo_interface_settings", None)], service) + self.blade_flutter_harmonics = self.__class__.blade_flutter_harmonics(path + [("blade_flutter_harmonics", None)], service) + super().__init__(path, service) + def enable_turbo_model(self, *args, **kwargs): + """ + Enables/disables turbo model menu. + """ + return PyMenu(self.service, "/define/turbo_model/enable_turbo_model").execute(*args, **kwargs) + def separate_nonoverlapping_interface_boundary(self, *args, **kwargs): + """ + Split a general turbo interface non-overlapping zone. + """ + return PyMenu(self.service, "/define/turbo_model/separate_nonoverlapping_interface_boundary").execute(*args, **kwargs) + def turbo_create(self, *args, **kwargs): + """ + Creates a general turbo interface. + """ + return PyMenu(self.service, "/define/turbo_model/turbo_create").execute(*args, **kwargs) + def number_of_blades_in_row(self, *args, **kwargs): + """ + Defines the number of blades in the turbo machine, used for calculating interblade phase angle. + """ + return PyMenu(self.service, "/define/turbo_model/number_of_blades_in_row").execute(*args, **kwargs) + def create_turbomachine_description(self, *args, **kwargs): + """ + Define turbomachine description. + """ + return PyMenu(self.service, "/define/turbo_model/create_turbomachine_description").execute(*args, **kwargs) + def create_phaselag_spectral_content(self, *args, **kwargs): + """ + Define phaselag related spectral content. + """ + return PyMenu(self.service, "/define/turbo_model/create_phaselag_spectral_content").execute(*args, **kwargs) + def phaselag_extra_settings(self, *args, **kwargs): + """ + Define phaselag related extra settings. + """ + return PyMenu(self.service, "/define/turbo_model/phaselag_extra_settings").execute(*args, **kwargs) + def create_graphics_spectral_content(self, *args, **kwargs): + """ + Define post-processing related spectral content. + """ + return PyMenu(self.service, "/define/turbo_model/create_graphics_spectral_content").execute(*args, **kwargs) + def graphics_extra_settings(self, *args, **kwargs): + """ + Define phaselag related extra settings. + """ + return PyMenu(self.service, "/define/turbo_model/graphics_extra_settings").execute(*args, **kwargs) + def delete_turbomachine_description(self, *args, **kwargs): + """ + Delete turbomachine description. + """ + return PyMenu(self.service, "/define/turbo_model/delete_turbomachine_description").execute(*args, **kwargs) + def delete_phaselag_spectral_content(self, *args, **kwargs): + """ + Delete phaselag related spectral content. + """ + return PyMenu(self.service, "/define/turbo_model/delete_phaselag_spectral_content").execute(*args, **kwargs) + def delete_graphics_spectral_content(self, *args, **kwargs): + """ + Delete post-processing related spectral content. + """ + return PyMenu(self.service, "/define/turbo_model/delete_graphics_spectral_content").execute(*args, **kwargs) + def list_turbomachine_description(self, *args, **kwargs): + """ + List turbomachine description. + """ + return PyMenu(self.service, "/define/turbo_model/list_turbomachine_description").execute(*args, **kwargs) + def list_graphics_spectral_content(self, *args, **kwargs): + """ + List post-processing related spectral content. + """ + return PyMenu(self.service, "/define/turbo_model/list_graphics_spectral_content").execute(*args, **kwargs) + def list_phaselag_state(self, *args, **kwargs): + """ + List all phaselag related case settings. + """ + return PyMenu(self.service, "/define/turbo_model/list_phaselag_state").execute(*args, **kwargs) + def make_phaselag_from_boundaries(self, *args, **kwargs): + """ + Make interface zones phase lagged. + """ + return PyMenu(self.service, "/define/turbo_model/make_phaselag_from_boundaries").execute(*args, **kwargs) + def make_phaselag_from_periodic(self, *args, **kwargs): + """ + Convert periodic interface to phase lagged. + """ + return PyMenu(self.service, "/define/turbo_model/make_phaselag_from_periodic").execute(*args, **kwargs) - class wall(metaclass=PyMenuMeta): - """ - Set the material and/or color for the selected boundary type. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Set a color for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/wall/color").execute(*args, **kwargs) - def material(self, *args, **kwargs): - """ - Set a material for the selected boundary type. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/wall/material").execute(*args, **kwargs) + class turbo_topology(TUIMenu): + """ + Enters the turbo topology menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def define_topology(self, *args, **kwargs): + """ + Defines a turbo topology. + """ + return PyMenu(self.service, "/define/turbo_model/turbo_topology/define_topology").execute(*args, **kwargs) + def mesh_method(self, *args, **kwargs): + """ + Sets turbo structured mesh generation method. + """ + return PyMenu(self.service, "/define/turbo_model/turbo_topology/mesh_method").execute(*args, **kwargs) + def search_method(self, *args, **kwargs): + """ + Sets search method for a topology. + """ + return PyMenu(self.service, "/define/turbo_model/turbo_topology/search_method").execute(*args, **kwargs) + def projection_method(self, *args, **kwargs): + """ + Sets 2D projection method. + """ + return PyMenu(self.service, "/define/turbo_model/turbo_topology/projection_method").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes a previously created turbo topology. + """ + return PyMenu(self.service, "/define/turbo_model/turbo_topology/delete").execute(*args, **kwargs) - class by_surface(metaclass=PyMenuMeta): - """ - Enter the surface(s) color and material assignment menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def surfaces(self, *args, **kwargs): - """ - Select the surface(s) to specify colors and/or materials. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_surface/surfaces").execute(*args, **kwargs) - def use_inherent_material_color(self, *args, **kwargs): - """ - Use inherent material color for surfaces. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_surface/use_inherent_material_color").execute(*args, **kwargs) - def reset(self, *args, **kwargs): - """ - To reset colors and/or materials to the defaults. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_surface/reset").execute(*args, **kwargs) - def list_surfaces_by_color(self, *args, **kwargs): - """ - To list the surfaces by its color. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_surface/list_surfaces_by_color").execute(*args, **kwargs) - def list_surfaces_by_material(self, *args, **kwargs): - """ - To list the surfaces by its material. - """ - return PyMenu(self.service, "/results/graphics/expert/set/colors/by_surface/list_surfaces_by_material").execute(*args, **kwargs) + class general_turbo_interface_settings(TUIMenu): + """ + Enters the General Turbo Interface options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.mixing_plane_model_settings = self.__class__.mixing_plane_model_settings(path + [("mixing_plane_model_settings", None)], service) + self.pitch_scale_model_settings = self.__class__.pitch_scale_model_settings(path + [("pitch_scale_model_settings", None)], service) + self.no_pitch_scale_model_settings = self.__class__.no_pitch_scale_model_settings(path + [("no_pitch_scale_model_settings", None)], service) + self.expert = self.__class__.expert(path + [("expert", None)], service) + super().__init__(path, service) - class contours(metaclass=PyMenuMeta): + class mixing_plane_model_settings(TUIMenu): + """ + Defines settings for the mixing plane model. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.number_of_bands = self.__class__.number_of_bands(path + [("number_of_bands", None)], service) + super().__init__(path, service) + def averaging_method(self, *args, **kwargs): """ - Enter the contour options menu. + Set the averaging method for the mixing. + """ + return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/mixing_plane_model_settings/averaging_method").execute(*args, **kwargs) + def mixing_set_constraint(self, *args, **kwargs): + """ + To set the mixing of primitive or total variable approach. + """ + return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/mixing_plane_model_settings/mixing_set_constraint").execute(*args, **kwargs) + def bands_type(self, *args, **kwargs): + """ + Specifies the averaging bands for mixing as fixed or variable width. + """ + return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/mixing_plane_model_settings/bands_type").execute(*args, **kwargs) + def number_of_inner_iterations(self, *args, **kwargs): + """ + Sets the number of iterations used in averaging. + """ + return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/mixing_plane_model_settings/number_of_inner_iterations").execute(*args, **kwargs) + def list_mixing_planes(self, *args, **kwargs): + """ + List the settings of mixing planes in the case. + """ + return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/mixing_plane_model_settings/list_mixing_planes").execute(*args, **kwargs) + + class number_of_bands(TUIMenu): + """ + Sets the number of bands to be used for mixing. """ def __init__(self, path, service): self.path = path self.service = service - def auto_range(self, *args, **kwargs): - """ - Enable/disable auto-computation of range for contours. - """ - return PyMenu(self.service, "/results/graphics/expert/set/contours/auto_range").execute(*args, **kwargs) - def clip_to_range(self, *args, **kwargs): - """ - Enable/disable the clip to range option for filled contours. - """ - return PyMenu(self.service, "/results/graphics/expert/set/contours/clip_to_range").execute(*args, **kwargs) - def surfaces(self, *args, **kwargs): - """ - Set surfaces to be contoured. - """ - return PyMenu(self.service, "/results/graphics/expert/set/contours/surfaces").execute(*args, **kwargs) - def filled_contours(self, *args, **kwargs): - """ - Enable/disable the filled contour option. - """ - return PyMenu(self.service, "/results/graphics/expert/set/contours/filled_contours").execute(*args, **kwargs) - def global_range(self, *args, **kwargs): - """ - Enable/disable the global range for contours option. - """ - return PyMenu(self.service, "/results/graphics/expert/set/contours/global_range").execute(*args, **kwargs) - def line_contours(self, *args, **kwargs): - """ - Enable/disable the filled contour option. - """ - return PyMenu(self.service, "/results/graphics/expert/set/contours/line_contours").execute(*args, **kwargs) - def log_scale(self, *args, **kwargs): - """ - Enable/disable the use of a log scale. - """ - return PyMenu(self.service, "/results/graphics/expert/set/contours/log_scale").execute(*args, **kwargs) - def n_contour(self, *args, **kwargs): - """ - Set the number of contour levels. - """ - return PyMenu(self.service, "/results/graphics/expert/set/contours/n_contour").execute(*args, **kwargs) - def node_values(self, *args, **kwargs): - """ - Enable/disable the plot of node values. - """ - return PyMenu(self.service, "/results/graphics/expert/set/contours/node_values").execute(*args, **kwargs) - def render_mesh(self, *args, **kwargs): + super().__init__(path, service) + def set_specific_interface(self, *args, **kwargs): """ - Determine whether or not to render the mesh on top of contours, vectors, etc. + Set number of band to be used for mixing. """ - return PyMenu(self.service, "/results/graphics/expert/set/contours/render_mesh").execute(*args, **kwargs) - def coloring(self, *args, **kwargs): + return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/mixing_plane_model_settings/number_of_bands/set_specific_interface").execute(*args, **kwargs) + def set_all_interfaces(self, *args, **kwargs): """ - Select coloring option. + Set number of band to be used for mixing. """ - return PyMenu(self.service, "/results/graphics/expert/set/contours/coloring").execute(*args, **kwargs) + return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/mixing_plane_model_settings/number_of_bands/set_all_interfaces").execute(*args, **kwargs) - class picture(metaclass=PyMenuMeta): + class pitch_scale_model_settings(TUIMenu): + """ + Defines settings for the pitch-scale model. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def scale_mflux(self, *args, **kwargs): """ - Enter the hardcopy/save-picture options menu. + Scales mass flux to improve conservation. + """ + return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/pitch_scale_model_settings/scale_mflux").execute(*args, **kwargs) + + class no_pitch_scale_model_settings(TUIMenu): + """ + Defines settings for the no pitch-scale model. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def scale_mflux(self, *args, **kwargs): + """ + Scales mass flux to improve conservation. + """ + return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/no_pitch_scale_model_settings/scale_mflux").execute(*args, **kwargs) + + class expert(TUIMenu): + """ + Set the expert parameters for turbo interfaces. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enforce_flux_scaling(self, *args, **kwargs): + """ + Enforce flux scaling ON/OFF at the turbo interfaces. + """ + return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/expert/enforce_flux_scaling").execute(*args, **kwargs) + def list_settings(self, *args, **kwargs): + """ + List the flux scale settings at the turbo interfaces. + """ + return PyMenu(self.service, "/define/turbo_model/general_turbo_interface_settings/expert/list_settings").execute(*args, **kwargs) + + class blade_flutter_harmonics(TUIMenu): + """ + Enters the blade flutter harmonics options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable_harmonic_postprocessing(self, *args, **kwargs): + """ + Calculates/Deletes Postprocessing Fourier coefficients data. + """ + return PyMenu(self.service, "/define/turbo_model/blade_flutter_harmonics/enable_harmonic_postprocessing").execute(*args, **kwargs) + def enable_harmonic_exports(self, *args, **kwargs): + """ + Calculates/Deletes flutter harmonic export data. + """ + return PyMenu(self.service, "/define/turbo_model/blade_flutter_harmonics/enable_harmonic_exports").execute(*args, **kwargs) + def write_harmonic_exports(self, *args, **kwargs): + """ + Writes harmonic export data. + """ + return PyMenu(self.service, "/define/turbo_model/blade_flutter_harmonics/write_harmonic_exports").execute(*args, **kwargs) + def write_aerodamping_vs_nodal_diameter(self, *args, **kwargs): + """ + Reads report definition file and Writes influence coefficient aerodynamic damping values vs nodal diameter. + """ + return PyMenu(self.service, "/define/turbo_model/blade_flutter_harmonics/write_aerodamping_vs_nodal_diameter").execute(*args, **kwargs) + + class phases(TUIMenu): + """ + Enters the phases menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.set_domain_properties = self.__class__.set_domain_properties(path + [("set_domain_properties", None)], service) + self.iac_expert = self.__class__.iac_expert(path + [("iac_expert", None)], service) + super().__init__(path, service) + + class set_domain_properties(TUIMenu): + """ + Enters the menu to set phase domain properties. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.interaction_domain = self.__class__.interaction_domain(path + [("interaction_domain", None)], service) + super().__init__(path, service) + def change_phases_names(self, *args, **kwargs): + """ + Allows you to change the names of all the phases in your simulation. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/change_phases_names").execute(*args, **kwargs) + def phase_domains(self, *args, **kwargs): + """ + Enters the menu to select a specific phase. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/phase_domains").execute(*args, **kwargs) + + class interaction_domain(TUIMenu): + """ + Enters the menu to set the interaction domain properties. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.forces = self.__class__.forces(path + [("forces", None)], service) + self.heat_mass_reactions = self.__class__.heat_mass_reactions(path + [("heat_mass_reactions", None)], service) + self.interfacial_area = self.__class__.interfacial_area(path + [("interfacial_area", None)], service) + self.model_transition = self.__class__.model_transition(path + [("model_transition", None)], service) + self.numerics = self.__class__.numerics(path + [("numerics", None)], service) + super().__init__(path, service) + + class forces(TUIMenu): + """ + Enters the menu to set interfacial forces models. """ def __init__(self, path, service): self.path = path self.service = service - self.color_mode = self.__class__.color_mode(path + [("color_mode", None)], service) - self.driver = self.__class__.driver(path + [("driver", None)], service) - def invert_background(self, *args, **kwargs): + self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) + self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) + self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) + self.lift = self.__class__.lift(path + [("lift", None)], service) + self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) + self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) + super().__init__(path, service) + def drag(self, *args, **kwargs): """ - Use a white background when the picture is saved. + Specifies the drag function, drag modification, and drag factor for each pair of phases. This command is available only with the Eulerian and Mixture multiphase models. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/invert_background").execute(*args, **kwargs) - def landscape(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/drag").execute(*args, **kwargs) + def heat_coeff(self, *args, **kwargs): """ - Plot hardcopies in landscape or portrait orientation. + Specify the heat transfer coefficient function between each pair of phases. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/landscape").execute(*args, **kwargs) - def preview(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/heat_coeff").execute(*args, **kwargs) + def interfacial_area(self, *args, **kwargs): """ - Display a preview image of a hardcopy. + Set the interfacial area parameters for each pair of phases. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/preview").execute(*args, **kwargs) - def x_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interfacial_area").execute(*args, **kwargs) + def mass_transfer(self, *args, **kwargs): """ - Set the width of raster-formatted images in pixels (0 implies current window size). + Specify the mass transfer mechanisms. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/x_resolution").execute(*args, **kwargs) - def y_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/mass_transfer").execute(*args, **kwargs) + def model_transition(self, *args, **kwargs): + """ + Set the model transition mechanism. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/model_transition").execute(*args, **kwargs) + def reactions(self, *args, **kwargs): + """ + Define multiple heterogeneous reactions and stoichiometry. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/reactions").execute(*args, **kwargs) + def restitution(self, *args, **kwargs): """ - Set the height of raster-formatted images in pixels (0 implies current window size). + Specifies the restitution coefficient for collisions between each pair of granular phases, and for collisions between particles of the same granular phase. This command is available only for multiphase flows with two or more granular phases. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/y_resolution").execute(*args, **kwargs) - def dpi(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/restitution").execute(*args, **kwargs) + def slip_velocity(self, *args, **kwargs): """ - Set the DPI for EPS and Postscript files, specifies the resolution in dots per inch (DPI) instead of setting the width and height. + Specifies the slip velocity function for each secondary phase with respect to the primary phase. This command is available only for the Mixture multiphase model. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/dpi").execute(*args, **kwargs) - def use_window_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/slip_velocity").execute(*args, **kwargs) + def turbulence_interaction(self, *args, **kwargs): """ - Use the currently active window's resolution for hardcopy (ignores the x-resolution and y-resolution in this case). + Specifies the turbulence interaction model for each primary-secondary phase pair. This command is available only with the Eulerian multiphase model. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/use_window_resolution").execute(*args, **kwargs) - def set_standard_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/turbulence_interaction").execute(*args, **kwargs) + def turbulent_dispersion(self, *args, **kwargs): """ - Select from pre-defined resolution list. + Specifies the turbulent dispersion model for each primary-secondary phase pair. This command is available only with the Eulerian multiphase model. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/set_standard_resolution").execute(*args, **kwargs) - def jpeg_hardcopy_quality(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/turbulent_dispersion").execute(*args, **kwargs) + def wall_lubrication(self, *args, **kwargs): """ - To set jpeg hardcopy quality. + Specifies the wall lubrication model for each primary-secondary phase pair. This command is available only with the Eulerian multiphase model. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/jpeg_hardcopy_quality").execute(*args, **kwargs) + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/wall_lubrication").execute(*args, **kwargs) - class color_mode(metaclass=PyMenuMeta): + class cavitation(TUIMenu): """ - Enter the hardcopy color mode menu. + Enter the menu to set cavitation models. """ def __init__(self, path, service): self.path = path self.service = service - def color(self, *args, **kwargs): + super().__init__(path, service) + def cavitation(self, *args, **kwargs): """ - Plot hardcopies in color. + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/color_mode/color").execute(*args, **kwargs) - def gray_scale(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): """ - Convert color to grayscale for hardcopy. + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/color_mode/gray_scale").execute(*args, **kwargs) - def mono_chrome(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): """ - Convert color to monochrome (black and white) for hardcopy. + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/color_mode/mono_chrome").execute(*args, **kwargs) - def list(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): """ - Display the current hardcopy color mode. + Enable the treatment of the contact angle specification at the porous jump boundary?. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/color_mode/list").execute(*args, **kwargs) + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/cavitation/wall_adhesion").execute(*args, **kwargs) - class driver(metaclass=PyMenuMeta): + class interphase_discretization(TUIMenu): """ - Enter the set hardcopy driver menu. + Enter the menu to set interphase discretization models. """ def __init__(self, path, service): self.path = path self.service = service - self.post_format = self.__class__.post_format(path + [("post_format", None)], service) - def dump_window(self, *args, **kwargs): + super().__init__(path, service) + def cavitation(self, *args, **kwargs): """ - Set the command used to dump the graphics window to a file. + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/dump_window").execute(*args, **kwargs) - def eps(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): """ - Produce encapsulated PostScript (EPS) output for hardcopies. + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/eps").execute(*args, **kwargs) - def jpeg(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): """ - Produce JPEG output for hardcopies. + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/jpeg").execute(*args, **kwargs) - def post_script(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): """ - Produce PostScript output for hardcopies. + Enable the treatment of the contact angle specification at the porous jump boundary?. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/post_script").execute(*args, **kwargs) - def ppm(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): """ - Produce PPM output for hardcopies. + . """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/ppm").execute(*args, **kwargs) - def tiff(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): """ - Use TIFF output for hardcopies. + Include the Montoya correction for Lift. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/tiff").execute(*args, **kwargs) - def png(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): """ - Use PNG output for hardcopies. + Include the Shaver-Podowski correction for Lift. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/png").execute(*args, **kwargs) - def hsf(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): """ - Use HSF output for hardcopies. + Select the surface tension model. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/hsf").execute(*args, **kwargs) - def avz(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): """ - Use AVZ output for hardcopies. + Include the effects of surface tension along the fluid-fluid interface?. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/avz").execute(*args, **kwargs) - def glb(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): """ - Use GLB output for hardcopies. + Specify the surface tension coefficient for each pair of phases. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/glb").execute(*args, **kwargs) - def vrml(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *args, **kwargs): """ - Use VRML output for hardcopies. + 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. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/vrml").execute(*args, **kwargs) - def list(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): """ - List the current hardcopy driver. + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/list").execute(*args, **kwargs) - def options(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): """ - Set the hardcopy options. Available options are: - \\n "no gamma correction", disables gamma correction of colors, - \\n "physical size = (width,height)", where width and height - are the actual measurements of the printable area of the page - in centimeters. - \\n "subscreen = (left,right,bottom,top)", where left,right, - bottom, and top are numbers in [-1,1] describing a subwindow on - the page in which to place the hardcopy. - - \\n The options may be combined by separating them with commas. + Set the dissipation intensity. """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/options").execute(*args, **kwargs) - - class post_format(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): """ - Enter the PostScript driver format menu. + Specify the virtual mass coefficient for each pair of phases. """ - def __init__(self, path, service): - self.path = path - self.service = service - def fast_raster(self, *args, **kwargs): - """ - Use the new raster format. - """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/post_format/fast_raster").execute(*args, **kwargs) - def raster(self, *args, **kwargs): - """ - Use the original raster format. - """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/post_format/raster").execute(*args, **kwargs) - def rle_raster(self, *args, **kwargs): - """ - Use the run-length encoded raster format. - """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/post_format/rle_raster").execute(*args, **kwargs) - def vector(self, *args, **kwargs): - """ - Use vector format. - """ - return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/post_format/vector").execute(*args, **kwargs) - - class lights(metaclass=PyMenuMeta): - """ - Enter the lights menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.lighting_interpolation = self.__class__.lighting_interpolation(path + [("lighting_interpolation", None)], service) - def lights_on(self, *args, **kwargs): - """ - Turn all active lighting on/off. - """ - return PyMenu(self.service, "/results/graphics/expert/set/lights/lights_on").execute(*args, **kwargs) - def set_ambient_color(self, *args, **kwargs): - """ - Set the ambient light color for the scene. - """ - return PyMenu(self.service, "/results/graphics/expert/set/lights/set_ambient_color").execute(*args, **kwargs) - def set_light(self, *args, **kwargs): - """ - Add or modify a directional, colored light. - """ - return PyMenu(self.service, "/results/graphics/expert/set/lights/set_light").execute(*args, **kwargs) - def headlight_on(self, *args, **kwargs): - """ - Turn the light that moves with the camera on or off. - """ - return PyMenu(self.service, "/results/graphics/expert/set/lights/headlight_on").execute(*args, **kwargs) + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - class lighting_interpolation(metaclass=PyMenuMeta): + class interphase_viscous_dissipation(TUIMenu): """ - Set lighting interpolation method. + Enter the menu to set interphase viscous dissipation related models. """ def __init__(self, path, service): self.path = path self.service = service - def automatic(self, *args, **kwargs): + super().__init__(path, service) + def cavitation(self, *args, **kwargs): """ - Choose Automatic to automatically select the best lighting method for a given graphics object. + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. """ - return PyMenu(self.service, "/results/graphics/expert/set/lights/lighting_interpolation/automatic").execute(*args, **kwargs) - def flat(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): """ - Use flat shading for meshes and polygons. + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. """ - return PyMenu(self.service, "/results/graphics/expert/set/lights/lighting_interpolation/flat").execute(*args, **kwargs) - def gouraud(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): """ - Use Gouraud shading to calculate the color at each vertex of a polygon and interpolate it in the interior. + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. """ - return PyMenu(self.service, "/results/graphics/expert/set/lights/lighting_interpolation/gouraud").execute(*args, **kwargs) - def phong(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): """ - Use Phong shading to interpolate the normals for each pixel of a polygon and compute a color at every pixel. + Enable the treatment of the contact angle specification at the porous jump boundary?. """ - return PyMenu(self.service, "/results/graphics/expert/set/lights/lighting_interpolation/phong").execute(*args, **kwargs) - - class particle_tracks(metaclass=PyMenuMeta): - """ - Enter the particle-tracks menu to set parameters for display of particle tracks. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.sphere_settings = self.__class__.sphere_settings(path + [("sphere_settings", None)], service) - self.vector_settings = self.__class__.vector_settings(path + [("vector_settings", None)], service) - self.filter_settings = self.__class__.filter_settings(path + [("filter_settings", None)], service) - def display(self, *args, **kwargs): - """ - Determine whether particle tracks will be displayed or only tracked. - """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/display").execute(*args, **kwargs) - def history_filename(self, *args, **kwargs): - """ - Specify the name of the particle history file. - """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/history_filename").execute(*args, **kwargs) - def report_to(self, *args, **kwargs): - """ - Specify the destination for the report (console, file, none). - """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/report_to").execute(*args, **kwargs) - def report_type(self, *args, **kwargs): - """ - Set the report type for particle tracks. - """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/report_type").execute(*args, **kwargs) - def report_variables(self, *args, **kwargs): - """ - Set the report variables. - """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/report_variables").execute(*args, **kwargs) - def report_default_variables(self, *args, **kwargs): - """ - Set the report variables to default. - """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/report_default_variables").execute(*args, **kwargs) - def track_single_particle_stream(self, *args, **kwargs): - """ - Specify the stream ID to be tracked. - """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/track_single_particle_stream").execute(*args, **kwargs) - def arrow_scale(self, *args, **kwargs): - """ - Set the scale factor for arrows drawn on particle tracks. - """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/arrow_scale").execute(*args, **kwargs) - def arrow_space(self, *args, **kwargs): - """ - Set the spacing factor for arrows drawn on particle tracks. - """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/arrow_space").execute(*args, **kwargs) - def coarsen_factor(self, *args, **kwargs): - """ - Set the particle tracks coarsening factor. - """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/coarsen_factor").execute(*args, **kwargs) - def line_width(self, *args, **kwargs): - """ - Set the width for particle track. - """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/line_width").execute(*args, **kwargs) - def marker_size(self, *args, **kwargs): - """ - Set the marker size for particle drawing. - """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/marker_size").execute(*args, **kwargs) - def radius(self, *args, **kwargs): - """ - Set the radius for particle track (ribbons/cylinder only) cross-section. - """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/radius").execute(*args, **kwargs) - def style(self, *args, **kwargs): - """ - Set the display style for particle track (line/ribbon/cylinder/sphere). - """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/style").execute(*args, **kwargs) - def twist_factor(self, *args, **kwargs): - """ - Set the scale factor for twisting (ribbons only). - """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/twist_factor").execute(*args, **kwargs) - def sphere_attrib(self, *args, **kwargs): - """ - Specify size and number of slices to be used in drawing spheres. - """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_attrib").execute(*args, **kwargs) - def particle_skip(self, *args, **kwargs): - """ - Specify how many particle tracks should be displayed. - """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/particle_skip").execute(*args, **kwargs) + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - class sphere_settings(metaclass=PyMenuMeta): + class lift(TUIMenu): """ - Provide sphere specific input. + Enters the menu to set the lift force. This item is available only with the Eulerian multiphase model. """ def __init__(self, path, service): self.path = path self.service = service - def vary_diameter(self, *args, **kwargs): + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + Specifies the lift function for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Enables/disables the Shaver-Podowski lift correction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. """ - Specify whether the spheres can vary with another variable. + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_settings/vary_diameter").execute(*args, **kwargs) - def diameter(self, *args, **kwargs): + Specify the surface tension coefficient for each pair of phases. """ - Diameter of the spheres when vary-diameter? is disabled. + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *args, **kwargs): """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_settings/diameter").execute(*args, **kwargs) - def auto_range(self, *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. """ - Specify whether displayed spheres should include auto range of variable to size spheres. + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_settings/auto_range").execute(*args, **kwargs) - def minimum(self, *args, **kwargs): + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. """ - Set the minimum value of the sphere to be displayed. + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_settings/minimum").execute(*args, **kwargs) - def maximum(self, *args, **kwargs): + Set the dissipation intensity. """ - Set the maximum value of the sphere to be displayed. + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_settings/maximum").execute(*args, **kwargs) - def smooth_parameter(self, *args, **kwargs): + Specify the virtual mass coefficient for each pair of phases. """ - Specify number of slices to be used in drawing spheres. + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_settings/smooth_parameter").execute(*args, **kwargs) - def scale_factor(self, *args, **kwargs): + Select the virtual mass implicit option. """ - Specify a scale factor to enlarge/reduce the size of spheres. + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_settings/scale_factor").execute(*args, **kwargs) - def size_variable(self, *args, **kwargs): + Enable the implicit method for the virtual mass force?. """ - Select a particle variable to size the spheres. + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_settings/size_variable").execute(*args, **kwargs) + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/lift/wall_adhesion").execute(*args, **kwargs) - class vector_settings(metaclass=PyMenuMeta): + class surface_tension(TUIMenu): """ - Set vector specific input. + Enters the menu to set surface tension models. """ def __init__(self, path, service): self.path = path self.service = service - def style(self, *args, **kwargs): + super().__init__(path, service) + def cavitation(self, *args, **kwargs): """ - Enable and set the display style for particle vectors (none/vector/centered-vector/centered-cylinder). + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/style").execute(*args, **kwargs) - def vector_length(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): """ - Specify the length of constant vectors. + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/vector_length").execute(*args, **kwargs) - def vector_length_variable(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): """ - Select a particle variable to specify the length of vectors. + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/vector_length_variable").execute(*args, **kwargs) - def scale_factor(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): """ - Specify a scale factor to enlarge/reduce the length of vectors. + Enables/disables the treatment of the contact angle specification at the porous jump boundary. This command is available only for the VOF multiphase model with the continuum surface stress model option and when sfc-modeling? is enabled. """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/scale_factor").execute(*args, **kwargs) - def length_variable(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): """ - Specify whether the displayed vectors have length varying with another variable. + . """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/length_variable").execute(*args, **kwargs) - def length_to_head_ratio(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): """ - Specify ratio of length to head for vectors and length to diameter for cylinders. + Include the Montoya correction for Lift. """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/length_to_head_ratio").execute(*args, **kwargs) - def constant_color(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): """ - Specify a constant color for the vectors. + Include the Shaver-Podowski correction for Lift. """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/constant_color").execute(*args, **kwargs) - def color_variable(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): """ - Specify whether the vectors should be colored by variable specified in /display/particle-track/particle-track (if false use a constant color). + Selects the surface tension model. You can choose between the continuum surface force and continuum surface stress methods. This item is available only when sfc-modeling? is enabled. """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/color_variable").execute(*args, **kwargs) - def vector_variable(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): """ - Select a particle vector function to specify vector direction. + Allows you to include the effects of surface tension along the fluid-fluid interface. This option is only available for the VOF and Eulerian multiphase models. """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/vector_variable").execute(*args, **kwargs) + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specifies the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enables/disables the specification for a wall adhesion angle. This item is available only whensfc-modeling? is enabled. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/surface_tension/wall_adhesion").execute(*args, **kwargs) - class filter_settings(metaclass=PyMenuMeta): + class virtual_mass(TUIMenu): """ - Set filter for particle display. + Enters the menu to set virtual mass models. """ def __init__(self, path, service): self.path = path self.service = service - def enable_filtering(self, *args, **kwargs): + super().__init__(path, service) + def cavitation(self, *args, **kwargs): """ - Specify whether particle display is filtered. + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/filter_settings/enable_filtering").execute(*args, **kwargs) - def inside(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): """ - Specify whether filter variable needs to be inside min/max to be displayed (else outside min/max). + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/filter_settings/inside").execute(*args, **kwargs) - def filter_variable(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): """ - Select a variable used for filtering of particles. + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/filter_settings/filter_variable").execute(*args, **kwargs) - def minimum(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): """ - Specify the lower bound for the filter variable. + Enable the treatment of the contact angle specification at the porous jump boundary?. """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/filter_settings/minimum").execute(*args, **kwargs) - def maximum(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): """ - Specify the upper bound for the filter variable. + . """ - return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/filter_settings/maximum").execute(*args, **kwargs) - - class path_lines(metaclass=PyMenuMeta): - """ - Enter the path-lines menu to set parameters for the display of pathlines. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def arrow_scale(self, *args, **kwargs): - """ - Set the scale factor for arrows drawn on pathlines. - """ - return PyMenu(self.service, "/results/graphics/expert/set/path_lines/arrow_scale").execute(*args, **kwargs) - def arrow_space(self, *args, **kwargs): - """ - Set the spacing factor for arrows drawn on pathlines. - """ - return PyMenu(self.service, "/results/graphics/expert/set/path_lines/arrow_space").execute(*args, **kwargs) - def display_steps(self, *args, **kwargs): - """ - Set the display stepping for pathlines. - """ - return PyMenu(self.service, "/results/graphics/expert/set/path_lines/display_steps").execute(*args, **kwargs) - def error_control(self, *args, **kwargs): - """ - Set error control during pathline computation. - """ - return PyMenu(self.service, "/results/graphics/expert/set/path_lines/error_control").execute(*args, **kwargs) - def line_width(self, *args, **kwargs): - """ - Set the width for pathlines. - """ - return PyMenu(self.service, "/results/graphics/expert/set/path_lines/line_width").execute(*args, **kwargs) - def marker_size(self, *args, **kwargs): - """ - Set the marker size for particle drawing. - """ - return PyMenu(self.service, "/results/graphics/expert/set/path_lines/marker_size").execute(*args, **kwargs) - def maximum_steps(self, *args, **kwargs): - """ - Set the maximum number of steps to take for pathlines. - """ - return PyMenu(self.service, "/results/graphics/expert/set/path_lines/maximum_steps").execute(*args, **kwargs) - def maximum_error(self, *args, **kwargs): - """ - Set the maximum error allowed while computing the pathlines. - """ - return PyMenu(self.service, "/results/graphics/expert/set/path_lines/maximum_error").execute(*args, **kwargs) - def radius(self, *args, **kwargs): - """ - Set the radius for pathline (ribbons/cylinder only) cross-section. - """ - return PyMenu(self.service, "/results/graphics/expert/set/path_lines/radius").execute(*args, **kwargs) - def relative_pathlines(self, *args, **kwargs): - """ - Enable/disable the tracking of pathlines in a relative coordinate system. - """ - return PyMenu(self.service, "/results/graphics/expert/set/path_lines/relative_pathlines").execute(*args, **kwargs) - def style(self, *args, **kwargs): - """ - Set display style for pathlines (line/ribbon/cylinder). - """ - return PyMenu(self.service, "/results/graphics/expert/set/path_lines/style").execute(*args, **kwargs) - def twist_factor(self, *args, **kwargs): - """ - Set the scale factor for twisting (ribbons only). - """ - return PyMenu(self.service, "/results/graphics/expert/set/path_lines/twist_factor").execute(*args, **kwargs) - def step_size(self, *args, **kwargs): - """ - Set the step length between particle positions for path-lines. - """ - return PyMenu(self.service, "/results/graphics/expert/set/path_lines/step_size").execute(*args, **kwargs) - def reverse(self, *args, **kwargs): - """ - Enable/disable the direction of path tracking. - """ - return PyMenu(self.service, "/results/graphics/expert/set/path_lines/reverse").execute(*args, **kwargs) - def sphere_attrib(self, *args, **kwargs): - """ - Specify size and no. of slices to be used in drawing sphere for sphere-style. - """ - return PyMenu(self.service, "/results/graphics/expert/set/path_lines/sphere_attrib").execute(*args, **kwargs) - def track_in_phase(self, *args, **kwargs): - """ - Assign phase to display pathlines in. - """ - return PyMenu(self.service, "/results/graphics/expert/set/path_lines/track_in_phase").execute(*args, **kwargs) - - class rendering_options(metaclass=PyMenuMeta): - """ - Enter the rendering options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def auto_spin(self, *args, **kwargs): - """ - Enable/disable mouse view rotations to continue to spin the display after the button is released. - """ - return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/auto_spin").execute(*args, **kwargs) - def device_info(self, *args, **kwargs): - """ - List information for the graphics device. - """ - return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/device_info").execute(*args, **kwargs) - def double_buffering(self, *args, **kwargs): - """ - Enable/disable double-buffering. - """ - return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/double_buffering").execute(*args, **kwargs) - def driver(self, *args, **kwargs): - """ - Change the current graphics driver. - """ - return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/driver").execute(*args, **kwargs) - def hidden_surfaces(self, *args, **kwargs): - """ - Enable/disable hidden surface removal. - """ - return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/hidden_surfaces").execute(*args, **kwargs) - def hidden_surface_method(self, *args, **kwargs): - """ - Specify the method to perform hidden line and hidden surface rendering. - """ - return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/hidden_surface_method").execute(*args, **kwargs) - def outer_face_cull(self, *args, **kwargs): - """ - Enable/disable discarding outer faces during display. - """ - return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/outer_face_cull").execute(*args, **kwargs) - def surface_edge_visibility(self, *args, **kwargs): - """ - Set edge visibility flags for surfaces. - """ - return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/surface_edge_visibility").execute(*args, **kwargs) - def animation_option(self, *args, **kwargs): - """ - Using Wireframe / All option during animation. - """ - return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/animation_option").execute(*args, **kwargs) - def color_map_alignment(self, *args, **kwargs): - """ - Set the color bar alignment. - """ - return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/color_map_alignment").execute(*args, **kwargs) - def help_text_color(self, *args, **kwargs): - """ - Set the color of screen help text. - """ - return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/help_text_color").execute(*args, **kwargs) - def face_displacement(self, *args, **kwargs): - """ - Set face displacement value in Z-buffer units along the Camera Z-axis. - """ - return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/face_displacement").execute(*args, **kwargs) - def set_rendering_options(self, *args, **kwargs): - """ - Set the rendering options. - """ - return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/set_rendering_options").execute(*args, **kwargs) - def show_colormap(self, *args, **kwargs): - """ - Enable/Disable colormap. - """ - return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/show_colormap").execute(*args, **kwargs) - - class titles(metaclass=PyMenuMeta): - """ - Set problem title. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def left_top(self, *args, **kwargs): - """ - Set the title text for left top in title segment. - """ - return PyMenu(self.service, "/results/graphics/expert/set/titles/left_top").execute(*args, **kwargs) - def left_bottom(self, *args, **kwargs): - """ - Set the title text for left bottom in title segment. - """ - return PyMenu(self.service, "/results/graphics/expert/set/titles/left_bottom").execute(*args, **kwargs) - def right_top(self, *args, **kwargs): - """ - Set the title text for right top in title segment. - """ - return PyMenu(self.service, "/results/graphics/expert/set/titles/right_top").execute(*args, **kwargs) - def right_middle(self, *args, **kwargs): - """ - Set the title text for right middle in title segment. - """ - return PyMenu(self.service, "/results/graphics/expert/set/titles/right_middle").execute(*args, **kwargs) - def right_bottom(self, *args, **kwargs): - """ - Set the title text for right bottom in title segment. - """ - return PyMenu(self.service, "/results/graphics/expert/set/titles/right_bottom").execute(*args, **kwargs) + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Allows you to include the virtual mass force effect that occurs when a secondary phase accelerates relative to the primary phase. This command is available only with the Eulerian multiphase model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specifies the virtual mass coefficient for each pair of phases. This option is available only ifvirtual-mass? is enabled. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Specifies what form of the implicit method to use (default, option-2, or option-3). default models the entire virtual mass force while option-2 and option-3 model truncated expressions which may further improve convergence. This option is available only if vmass-implicit? is enabled. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enables/disables the implicit method for the virtual mass force. This option can improve convergence in some cases. This option is available only if virtual-mass? is enabled. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/forces/virtual_mass/wall_adhesion").execute(*args, **kwargs) - class velocity_vectors(metaclass=PyMenuMeta): + class heat_mass_reactions(TUIMenu): """ - Enter the menu to set parameters for display of velocity vectors. + Enters the menu to set heat, mass-transfer, and reaction models. """ def __init__(self, path, service): self.path = path self.service = service - def auto_scale(self, *args, **kwargs): - """ - Enable/disable auto-scale of all vectors so that vector overlap is minimal. - """ - return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/auto_scale").execute(*args, **kwargs) - def color(self, *args, **kwargs): - """ - Set the color used for all vectors. Set color to the null string to use the color map. - """ - return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/color").execute(*args, **kwargs) - def component_x(self, *args, **kwargs): - """ - Enable/disable use of x-component of vectors. - """ - return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/component_x").execute(*args, **kwargs) - def component_y(self, *args, **kwargs): - """ - Enable/disable use of y-component of vectors. - """ - return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/component_y").execute(*args, **kwargs) - def component_z(self, *args, **kwargs): - """ - Enable/disable use of z-component of vectors. - """ - return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/component_z").execute(*args, **kwargs) - def constant_length(self, *args, **kwargs): - """ - Enable/disable setting all vectors to have the same length. - """ - return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/constant_length").execute(*args, **kwargs) - def color_levels(self, *args, **kwargs): - """ - Set the number of colors used from the color map. - """ - return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/color_levels").execute(*args, **kwargs) - def global_range(self, *args, **kwargs): - """ - Enable/disable the global range for vectors option. - """ - return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/global_range").execute(*args, **kwargs) - def in_plane(self, *args, **kwargs): - """ - Toggle the display of in-plane velocity vectors. - """ - return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/in_plane").execute(*args, **kwargs) - def log_scale(self, *args, **kwargs): - """ - Enable/disable the use of a log scale. - """ - return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/log_scale").execute(*args, **kwargs) - def node_values(self, *args, **kwargs): - """ - Enable/disable plotting node values. Cell values will be plotted if "no". - """ - return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/node_values").execute(*args, **kwargs) - def relative(self, *args, **kwargs): + self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) + self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) + self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) + self.lift = self.__class__.lift(path + [("lift", None)], service) + self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) + self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) + super().__init__(path, service) + def drag(self, *args, **kwargs): """ - Enable/disable the display of relative velocity vectors. + Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. """ - return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/relative").execute(*args, **kwargs) - def render_mesh(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/drag").execute(*args, **kwargs) + def heat_coeff(self, *args, **kwargs): """ - Enable/disable rendering the mseh on top of contours, vectors, etc. + Species the heat transfer coefficient function between each pair of phases (constant-htc, nusselt-number, ranz-marshall, hughmark, tomiyama, fixed-to-sat-temp, two-resistance, or user-defined). This command is enable only with the Eulerian multiphase model. """ - return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/render_mesh").execute(*args, **kwargs) - def scale(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/heat_coeff").execute(*args, **kwargs) + def interfacial_area(self, *args, **kwargs): """ - Set the value by which the vector length will be scaled. + Set the interfacial area parameters for each pair of phases. """ - return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/scale").execute(*args, **kwargs) - def scale_head(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interfacial_area").execute(*args, **kwargs) + def mass_transfer(self, *args, **kwargs): """ - Set the value by which the vector head will be scaled. + Sets the mass transfer mechanisms. """ - return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/scale_head").execute(*args, **kwargs) - def style(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/mass_transfer").execute(*args, **kwargs) + def model_transition(self, *args, **kwargs): """ - Set the style with which the vectors will be drawn. + Set the model transition mechanism. """ - return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/style").execute(*args, **kwargs) - def surfaces(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/model_transition").execute(*args, **kwargs) + def reactions(self, *args, **kwargs): """ - Set surfaces on which vectors are drawn. + Allows you to define multiple heterogeneous reactions and stoichiometry. This option is available only with the species model. """ - return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/surfaces").execute(*args, **kwargs) - - class windows(metaclass=PyMenuMeta): - """ - Enter the window options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.axes = self.__class__.axes(path + [("axes", None)], service) - self.main = self.__class__.main(path + [("main", None)], service) - self.scale = self.__class__.scale(path + [("scale", None)], service) - self.text = self.__class__.text(path + [("text", None)], service) - self.video = self.__class__.video(path + [("video", None)], service) - self.xy = self.__class__.xy(path + [("xy", None)], service) - def aspect_ratio(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/reactions").execute(*args, **kwargs) + def restitution(self, *args, **kwargs): """ - Set the aspect ratio of the active window. + Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/aspect_ratio").execute(*args, **kwargs) - def logo(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/restitution").execute(*args, **kwargs) + def slip_velocity(self, *args, **kwargs): """ - Enable/disable visibility of the logo in graphics window. + Specify the slip velocity function for each secondary phase with respect to the primary phase. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/logo").execute(*args, **kwargs) - def ruler(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/slip_velocity").execute(*args, **kwargs) + def turbulence_interaction(self, *args, **kwargs): """ - Enable/disable ruler visibility. + Specify the turbulence interaction model for each primary-secondary phase pair. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/ruler").execute(*args, **kwargs) - def logo_color(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/turbulence_interaction").execute(*args, **kwargs) + def turbulent_dispersion(self, *args, **kwargs): """ - Set logo color to white/black. + Specify the turbulent dispersion model for each primary-secondary phase pair. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/logo_color").execute(*args, **kwargs) - - class axes(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/turbulent_dispersion").execute(*args, **kwargs) + def wall_lubrication(self, *args, **kwargs): """ - Enter the axes window options menu. + Specify the wall lubrication model for each primary-secondary phase pair. """ - def __init__(self, path, service): - self.path = path - self.service = service - def border(self, *args, **kwargs): - """ - Enable/disable drawing of a border around the axes window. - """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/axes/border").execute(*args, **kwargs) - def bottom(self, *args, **kwargs): - """ - Set the bottom boundary of the axes window. - """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/axes/bottom").execute(*args, **kwargs) - def clear(self, *args, **kwargs): - """ - Set the transparency of the axes window. - """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/axes/clear").execute(*args, **kwargs) - def right(self, *args, **kwargs): - """ - Set the right boundary of the axes window. - """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/axes/right").execute(*args, **kwargs) - def visible(self, *args, **kwargs): - """ - Enable/disable axes visibility. - """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/axes/visible").execute(*args, **kwargs) + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/wall_lubrication").execute(*args, **kwargs) - class main(metaclass=PyMenuMeta): + class cavitation(TUIMenu): """ - Enter the main view window options menu. + Enters the menu to set cavitation models. This option is available only for the Mixture multiphase model with the Singhal-et-al cavitation model enabled via solve/set/advanced/singhal-et-al-cavitation-model. """ def __init__(self, path, service): self.path = path self.service = service - def border(self, *args, **kwargs): + super().__init__(path, service) + def cavitation(self, *args, **kwargs): """ - Enable/disable drawing of borders around the main viewing window. + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/main/border").execute(*args, **kwargs) - def bottom(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): """ - Set the bottom boundary of the main viewing window. + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/main/bottom").execute(*args, **kwargs) - def left(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): """ - Set the left boundary of the main viewing window. + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/main/left").execute(*args, **kwargs) - def right(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): """ - Set the right boundary of the main viewing window. + Enable the treatment of the contact angle specification at the porous jump boundary?. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/main/right").execute(*args, **kwargs) - def top(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): """ - Set the top boundary of the main viewing window. + . """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/main/top").execute(*args, **kwargs) - def visible(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): """ - Enable/disable visibility of the main viewing window. + Include the Montoya correction for Lift. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/main/visible").execute(*args, **kwargs) - - class scale(metaclass=PyMenuMeta): - """ - Enter the color scale window options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def border(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): """ - Enable/disable drawing of borders around the color scale window. + Include the Shaver-Podowski correction for Lift. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/border").execute(*args, **kwargs) - def bottom(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): """ - Set the bottom boundary of the color scale window. + Select the surface tension model. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/bottom").execute(*args, **kwargs) - def clear(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): """ - Set the transparency of the scale window. + Include the effects of surface tension along the fluid-fluid interface?. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/clear").execute(*args, **kwargs) - def format(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): """ - Set the number format of the color scale window (e.g. %0.2e). + Specify the surface tension coefficient for each pair of phases. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/format").execute(*args, **kwargs) - def font_size(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *args, **kwargs): """ - Set the font size of the color scale window. + 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. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/font_size").execute(*args, **kwargs) - def left(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): """ - Set the left boundary of the color scale window. + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/left").execute(*args, **kwargs) - def margin(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): """ - Set the margin of the color scale window. + Set the dissipation intensity. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/margin").execute(*args, **kwargs) - def right(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): """ - Set the right boundary of the color scale window. + Specify the virtual mass coefficient for each pair of phases. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/right").execute(*args, **kwargs) - def top(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): """ - Set the top boundary of the color scale window. + Select the virtual mass implicit option. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/top").execute(*args, **kwargs) - def visible(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): """ - Enable/disable visibility of the color scale window. + Enable the implicit method for the virtual mass force?. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/visible").execute(*args, **kwargs) - def alignment(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): """ - Set colormap to bottom/left/top/right. + Enable the specification for a wall adhesion angle?. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/alignment").execute(*args, **kwargs) + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/wall_adhesion").execute(*args, **kwargs) - class text(metaclass=PyMenuMeta): + class interphase_discretization(TUIMenu): """ - Enter the text window options menu. + Enter the menu to set interphase discretization models. """ def __init__(self, path, service): self.path = path self.service = service - def application(self, *args, **kwargs): + super().__init__(path, service) + def cavitation(self, *args, **kwargs): """ - Enable/disable the application name in the picture. + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/text/application").execute(*args, **kwargs) - def border(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): """ - Enable/disable drawing of borders around the text window. + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/text/border").execute(*args, **kwargs) - def bottom(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): """ - Set the bottom boundary of the text window. + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/text/bottom").execute(*args, **kwargs) - def clear(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): """ - Enable/disable text window transparency. + Enable the treatment of the contact angle specification at the porous jump boundary?. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/text/clear").execute(*args, **kwargs) - def company(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): """ - Enable/disable the company name in the picture. + . """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/text/company").execute(*args, **kwargs) - def date(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): """ - Enable/disable the date in the picture. + Include the Montoya correction for Lift. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/text/date").execute(*args, **kwargs) - def left(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): """ - Set the left boundary of the text window. + Include the Shaver-Podowski correction for Lift. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/text/left").execute(*args, **kwargs) - def right(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): """ - Set the right boundary of the text window. + Select the surface tension model. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/text/right").execute(*args, **kwargs) - def top(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): """ - Set the top boundary of the text window. + Include the effects of surface tension along the fluid-fluid interface?. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/text/top").execute(*args, **kwargs) - def visible(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): """ - Enable/disable text window transparency. + Specify the surface tension coefficient for each pair of phases. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/text/visible").execute(*args, **kwargs) - - class video(metaclass=PyMenuMeta): - """ - Enter the video window options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def background(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *args, **kwargs): """ - Set the background color in the video picture. + 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. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/video/background").execute(*args, **kwargs) - def color_filter(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): """ - Set the color filter options for the picture. + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/video/color_filter").execute(*args, **kwargs) - def foreground(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): """ - Set the foreground color in the video picture. + Set the dissipation intensity. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/video/foreground").execute(*args, **kwargs) - def on(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): """ - Enable/disable video picture settings. + Specify the virtual mass coefficient for each pair of phases. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/video/on").execute(*args, **kwargs) - def pixel_size(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): """ - Set the window size in pixels. + Select the virtual mass implicit option. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/video/pixel_size").execute(*args, **kwargs) + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - class xy(metaclass=PyMenuMeta): + class interphase_viscous_dissipation(TUIMenu): """ - Enter the X-Y plot window options menu. + Enter the menu to set interphase viscous dissipation related models. """ def __init__(self, path, service): self.path = path self.service = service - def border(self, *args, **kwargs): + super().__init__(path, service) + def cavitation(self, *args, **kwargs): """ - Enable/disable drawing of a border around the X-Y plotter window. + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/xy/border").execute(*args, **kwargs) - def bottom(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): """ - Set the bottom boundary of the X-Y plotter window. + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/xy/bottom").execute(*args, **kwargs) - def left(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): """ - Set the left boundary of the X-Y plotter window. + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/xy/left").execute(*args, **kwargs) - def right(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): """ - Set the right boundary of the X-Y plotter window. + Enable the treatment of the contact angle specification at the porous jump boundary?. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/xy/right").execute(*args, **kwargs) - def top(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): """ - Set the top boundary of the X-Y plotter window. + . """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/xy/top").execute(*args, **kwargs) - def visible(self, *args, **kwargs): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): """ - Enable/disable X-Y plotter window visibility. + Include the Montoya correction for Lift. """ - return PyMenu(self.service, "/results/graphics/expert/set/windows/xy/visible").execute(*args, **kwargs) - - class lights(metaclass=PyMenuMeta): - """ - Enter the lights menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.lighting_interpolation = self.__class__.lighting_interpolation(path + [("lighting_interpolation", None)], service) - def lights_on(self, *args, **kwargs): - """ - Turn all active lighting on/off. - """ - return PyMenu(self.service, "/results/graphics/lights/lights_on").execute(*args, **kwargs) - def set_ambient_color(self, *args, **kwargs): - """ - Set the ambient light color for the scene. - """ - return PyMenu(self.service, "/results/graphics/lights/set_ambient_color").execute(*args, **kwargs) - def set_light(self, *args, **kwargs): - """ - Add or modify a directional, colored light. - """ - return PyMenu(self.service, "/results/graphics/lights/set_light").execute(*args, **kwargs) - def headlight_on(self, *args, **kwargs): - """ - Turn the light that moves with the camera on or off. - """ - return PyMenu(self.service, "/results/graphics/lights/headlight_on").execute(*args, **kwargs) - - class lighting_interpolation(metaclass=PyMenuMeta): - """ - Set lighting interpolation method. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def automatic(self, *args, **kwargs): - """ - Choose Automatic to automatically select the best lighting method for a given graphics object. - """ - return PyMenu(self.service, "/results/graphics/lights/lighting_interpolation/automatic").execute(*args, **kwargs) - def flat(self, *args, **kwargs): - """ - Use flat shading for meshes and polygons. - """ - return PyMenu(self.service, "/results/graphics/lights/lighting_interpolation/flat").execute(*args, **kwargs) - def gouraud(self, *args, **kwargs): - """ - Use Gouraud shading to calculate the color at each vertex of a polygon and interpolate it in the interior. - """ - return PyMenu(self.service, "/results/graphics/lights/lighting_interpolation/gouraud").execute(*args, **kwargs) - def phong(self, *args, **kwargs): - """ - Use Phong shading to interpolate the normals for each pixel of a polygon and compute a color at every pixel. - """ - return PyMenu(self.service, "/results/graphics/lights/lighting_interpolation/phong").execute(*args, **kwargs) - - class objects(metaclass=PyMenuMeta): - """ - Enter to add, edit, delete or display graphics objects. - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.xy_plot = self.__class__.xy_plot(path + [("xy_plot", None)], None, service) - self.mesh = self.__class__.mesh(path + [("mesh", None)], None, service) - self.contour = self.__class__.contour(path + [("contour", None)], None, service) - self.vector = self.__class__.vector(path + [("vector", None)], None, service) - self.pathlines = self.__class__.pathlines(path + [("pathlines", None)], None, service) - self.particle_tracks = self.__class__.particle_tracks(path + [("particle_tracks", None)], None, service) - self.scene = self.__class__.scene(path + [("scene", None)], None, service) - def create(self, *args, **kwargs): - """ - Create new graphics object. - """ - return PyMenu(self.service, "/results/graphics/objects/create").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edit graphics object. - """ - return PyMenu(self.service, "/results/graphics/objects/edit").execute(*args, **kwargs) - def copy(self, *args, **kwargs): - """ - Copy graphics object. - """ - return PyMenu(self.service, "/results/graphics/objects/copy").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Delete graphics object. - """ - return PyMenu(self.service, "/results/graphics/objects/delete").execute(*args, **kwargs) - def display(self, *args, **kwargs): - """ - Display graphics object. - """ - return PyMenu(self.service, "/results/graphics/objects/display").execute(*args, **kwargs) - def add_to_graphics(self, *args, **kwargs): - """ - Add graphics object to existing graphics. - """ - return PyMenu(self.service, "/results/graphics/objects/add_to_graphics").execute(*args, **kwargs) - - class xy_plot(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.uid = self.__class__.uid(path + [("uid", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - self.plot_direction = self.__class__.plot_direction(path + [("plot_direction", None)], service) - self.x_axis_function = self.__class__.x_axis_function(path + [("x_axis_function", None)], service) - self.y_axis_function = self.__class__.y_axis_function(path + [("y_axis_function", None)], service) - self.surfaces_list = self.__class__.surfaces_list(path + [("surfaces_list", None)], service) - self.physics = self.__class__.physics(path + [("physics", None)], service) - self.geometry = self.__class__.geometry(path + [("geometry", None)], service) - self.surfaces = self.__class__.surfaces(path + [("surfaces", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uid(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.node_values = self.__class__.node_values(path + [("node_values", None)], service) - self.position_on_x_axis = self.__class__.position_on_x_axis(path + [("position_on_x_axis", None)], service) - self.position_on_y_axis = self.__class__.position_on_y_axis(path + [("position_on_y_axis", None)], service) - - class node_values(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class position_on_x_axis(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class position_on_y_axis(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class plot_direction(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.direction_vector = self.__class__.direction_vector(path + [("direction_vector", None)], service) - self.curve_length = self.__class__.curve_length(path + [("curve_length", None)], service) - - class direction_vector(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.x_component = self.__class__.x_component(path + [("x_component", None)], service) - self.y_component = self.__class__.y_component(path + [("y_component", None)], service) - self.z_component = self.__class__.z_component(path + [("z_component", None)], service) - - class x_component(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *args, **kwargs): """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class y_component(metaclass=PyMenuMeta): + 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. """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class z_component(metaclass=PyMenuMeta): + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class curve_length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.default = self.__class__.default(path + [("default", None)], service) - self.reverse = self.__class__.reverse(path + [("reverse", None)], service) - - class default(metaclass=PyMenuMeta): + Set the dissipation intensity. """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class reverse(metaclass=PyMenuMeta): + Specify the virtual mass coefficient for each pair of phases. """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class x_axis_function(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class y_axis_function(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces_list(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class physics(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geometry(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mesh(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - self.edge_type = self.__class__.edge_type(path + [("edge_type", None)], service) - self.shrink_factor = self.__class__.shrink_factor(path + [("shrink_factor", None)], service) - self.surfaces_list = self.__class__.surfaces_list(path + [("surfaces_list", None)], service) - self.coloring = self.__class__.coloring(path + [("coloring", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - self.physics = self.__class__.physics(path + [("physics", None)], service) - self.geometry = self.__class__.geometry(path + [("geometry", None)], service) - self.surfaces = self.__class__.surfaces(path + [("surfaces", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.nodes = self.__class__.nodes(path + [("nodes", None)], service) - self.edges = self.__class__.edges(path + [("edges", None)], service) - self.faces = self.__class__.faces(path + [("faces", None)], service) - self.partitions = self.__class__.partitions(path + [("partitions", None)], service) - self.overset = self.__class__.overset(path + [("overset", None)], service) - self.gap = self.__class__.gap(path + [("gap", None)], service) - - class nodes(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class edges(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class faces(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class partitions(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class overset(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class gap(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class edge_type(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.all = self.__class__.all(path + [("all", None)], service) - self.feature = self.__class__.feature(path + [("feature", None)], service) - self.outline = self.__class__.outline(path + [("outline", None)], service) - - class all(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class feature(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.feature_angle = self.__class__.feature_angle(path + [("feature_angle", None)], service) - - class feature_angle(metaclass=PyMenuMeta): + Select the virtual mass implicit option. """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class outline(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class shrink_factor(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces_list(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coloring(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.automatic = self.__class__.automatic(path + [("automatic", None)], service) - self.manual = self.__class__.manual(path + [("manual", None)], service) + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - class automatic(metaclass=PyMenuMeta): + class lift(TUIMenu): """ + Enter the menu to set lift models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.type = self.__class__.type(path + [("type", None)], service) - self.id = self.__class__.id(path + [("id", None)], service) - self.normal = self.__class__.normal(path + [("normal", None)], service) - self.partition = self.__class__.partition(path + [("partition", None)], service) - - class type(metaclass=PyMenuMeta): + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class id(metaclass=PyMenuMeta): + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class normal(metaclass=PyMenuMeta): + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): """ + Enable the treatment of the contact angle specification at the porous jump boundary?. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class partition(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): """ + . """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/wall_adhesion").execute(*args, **kwargs) - class manual(metaclass=PyMenuMeta): + class surface_tension(TUIMenu): """ + Enter the menu to set surface tension models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.faces = self.__class__.faces(path + [("faces", None)], service) - self.edges = self.__class__.edges(path + [("edges", None)], service) - self.nodes = self.__class__.nodes(path + [("nodes", None)], service) - self.material_color = self.__class__.material_color(path + [("material_color", None)], service) - - class faces(metaclass=PyMenuMeta): + super().__init__(path, service) + def cavitation(self, *args, **kwargs): """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class edges(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nodes(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class material_color(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): """ + Enable the treatment of the contact angle specification at the porous jump boundary?. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class display_state_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class physics(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geometry(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class contour(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.field = self.__class__.field(path + [("field", None)], service) - self.filled = self.__class__.filled(path + [("filled", None)], service) - self.boundary_values = self.__class__.boundary_values(path + [("boundary_values", None)], service) - self.contour_lines = self.__class__.contour_lines(path + [("contour_lines", None)], service) - self.node_values = self.__class__.node_values(path + [("node_values", None)], service) - self.surfaces_list = self.__class__.surfaces_list(path + [("surfaces_list", None)], service) - self.range_option = self.__class__.range_option(path + [("range_option", None)], service) - self.coloring = self.__class__.coloring(path + [("coloring", None)], service) - self.color_map = self.__class__.color_map(path + [("color_map", None)], service) - self.draw_mesh = self.__class__.draw_mesh(path + [("draw_mesh", None)], service) - self.mesh_object = self.__class__.mesh_object(path + [("mesh_object", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - self.physics = self.__class__.physics(path + [("physics", None)], service) - self.geometry = self.__class__.geometry(path + [("geometry", None)], service) - self.surfaces = self.__class__.surfaces(path + [("surfaces", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class filled(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class boundary_values(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class contour_lines(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class node_values(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces_list(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class range_option(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_range_on = self.__class__.auto_range_on(path + [("auto_range_on", None)], service) - self.auto_range_off = self.__class__.auto_range_off(path + [("auto_range_off", None)], service) + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/wall_adhesion").execute(*args, **kwargs) - class auto_range_on(metaclass=PyMenuMeta): + class virtual_mass(TUIMenu): """ + Enter the menu to set virtual mass models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.global_range = self.__class__.global_range(path + [("global_range", None)], service) - - class global_range(metaclass=PyMenuMeta): + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): """ + Set the dissipation intensity. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class auto_range_off(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.clip_to_range = self.__class__.clip_to_range(path + [("clip_to_range", None)], service) - self.minimum = self.__class__.minimum(path + [("minimum", None)], service) - self.maximum = self.__class__.maximum(path + [("maximum", None)], service) - - class clip_to_range(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): """ + Specify the virtual mass coefficient for each pair of phases. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class minimum(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): """ + Select the virtual mass implicit option. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class maximum(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): """ + Enable the implicit method for the virtual mass force?. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coloring(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.smooth = self.__class__.smooth(path + [("smooth", None)], service) - self.banded = self.__class__.banded(path + [("banded", None)], service) - - class smooth(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class banded(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/wall_adhesion").execute(*args, **kwargs) - class color_map(metaclass=PyMenuMeta): + class interfacial_area(TUIMenu): """ + Enters the menu to set interfacial area models. This menu is available only for the Mixture and Eulerian multiphase models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.visible = self.__class__.visible(path + [("visible", None)], service) - self.size = self.__class__.size(path + [("size", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) - self.log_scale = self.__class__.log_scale(path + [("log_scale", None)], service) - self.format = self.__class__.format(path + [("format", None)], service) - self.user_skip = self.__class__.user_skip(path + [("user_skip", None)], service) - self.show_all = self.__class__.show_all(path + [("show_all", None)], service) - self.position = self.__class__.position(path + [("position", None)], service) - self.font_name = self.__class__.font_name(path + [("font_name", None)], service) - self.font_automatic = self.__class__.font_automatic(path + [("font_automatic", None)], service) - self.font_size = self.__class__.font_size(path + [("font_size", None)], service) - self.length = self.__class__.length(path + [("length", None)], service) - self.width = self.__class__.width(path + [("width", None)], service) - - class visible(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class log_scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class format(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class user_skip(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class show_all(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class position(metaclass=PyMenuMeta): + self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) + self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) + self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) + self.lift = self.__class__.lift(path + [("lift", None)], service) + self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) + self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) + super().__init__(path, service) + def drag(self, *args, **kwargs): """ + Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_name(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/drag").execute(*args, **kwargs) + def heat_coeff(self, *args, **kwargs): """ + Specify the heat transfer coefficient function between each pair of phases. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_automatic(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/heat_coeff").execute(*args, **kwargs) + def interfacial_area(self, *args, **kwargs): """ + Specifies the interfacial area model for each pair of phases. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_size(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interfacial_area").execute(*args, **kwargs) + def mass_transfer(self, *args, **kwargs): """ + Specify the mass transfer mechanisms. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class length(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/mass_transfer").execute(*args, **kwargs) + def model_transition(self, *args, **kwargs): """ + Set the model transition mechanism. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class width(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/model_transition").execute(*args, **kwargs) + def reactions(self, *args, **kwargs): """ + Define multiple heterogeneous reactions and stoichiometry. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class draw_mesh(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mesh_object(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class display_state_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class physics(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geometry(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vector(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.field = self.__class__.field(path + [("field", None)], service) - self.vector_field = self.__class__.vector_field(path + [("vector_field", None)], service) - self.surfaces_list = self.__class__.surfaces_list(path + [("surfaces_list", None)], service) - self.scale = self.__class__.scale(path + [("scale", None)], service) - self.style = self.__class__.style(path + [("style", None)], service) - self.skip = self.__class__.skip(path + [("skip", None)], service) - self.vector_opt = self.__class__.vector_opt(path + [("vector_opt", None)], service) - self.range_option = self.__class__.range_option(path + [("range_option", None)], service) - self.color_map = self.__class__.color_map(path + [("color_map", None)], service) - self.draw_mesh = self.__class__.draw_mesh(path + [("draw_mesh", None)], service) - self.mesh_object = self.__class__.mesh_object(path + [("mesh_object", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - self.physics = self.__class__.physics(path + [("physics", None)], service) - self.geometry = self.__class__.geometry(path + [("geometry", None)], service) - self.surfaces = self.__class__.surfaces(path + [("surfaces", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vector_field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces_list(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_scale = self.__class__.auto_scale(path + [("auto_scale", None)], service) - self.scale_f = self.__class__.scale_f(path + [("scale_f", None)], service) - - class auto_scale(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/reactions").execute(*args, **kwargs) + def restitution(self, *args, **kwargs): """ + Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class scale_f(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/restitution").execute(*args, **kwargs) + def slip_velocity(self, *args, **kwargs): """ + Specify the slip velocity function for each secondary phase with respect to the primary phase. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class style(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class skip(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vector_opt(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.in_plane = self.__class__.in_plane(path + [("in_plane", None)], service) - self.fixed_length = self.__class__.fixed_length(path + [("fixed_length", None)], service) - self.x_comp = self.__class__.x_comp(path + [("x_comp", None)], service) - self.y_comp = self.__class__.y_comp(path + [("y_comp", None)], service) - self.z_comp = self.__class__.z_comp(path + [("z_comp", None)], service) - self.scale_head = self.__class__.scale_head(path + [("scale_head", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) - - class in_plane(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/slip_velocity").execute(*args, **kwargs) + def turbulence_interaction(self, *args, **kwargs): """ + Specify the turbulence interaction model for each primary-secondary phase pair. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class fixed_length(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/turbulence_interaction").execute(*args, **kwargs) + def turbulent_dispersion(self, *args, **kwargs): """ + Specify the turbulent dispersion model for each primary-secondary phase pair. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class x_comp(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/turbulent_dispersion").execute(*args, **kwargs) + def wall_lubrication(self, *args, **kwargs): """ + Specify the wall lubrication model for each primary-secondary phase pair. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/wall_lubrication").execute(*args, **kwargs) - class y_comp(metaclass=PyMenuMeta): + class cavitation(TUIMenu): """ + Enter the menu to set cavitation models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/wall_adhesion").execute(*args, **kwargs) - class z_comp(metaclass=PyMenuMeta): + class interphase_discretization(TUIMenu): """ + Enter the menu to set interphase discretization models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - class scale_head(metaclass=PyMenuMeta): + class interphase_viscous_dissipation(TUIMenu): """ + Enter the menu to set interphase viscous dissipation related models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - class color(metaclass=PyMenuMeta): + class lift(TUIMenu): """ + Enter the menu to set lift models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/lift/wall_adhesion").execute(*args, **kwargs) - class range_option(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_range_on = self.__class__.auto_range_on(path + [("auto_range_on", None)], service) - self.auto_range_off = self.__class__.auto_range_off(path + [("auto_range_off", None)], service) - - class auto_range_on(metaclass=PyMenuMeta): + class surface_tension(TUIMenu): """ + Enter the menu to set surface tension models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.global_range = self.__class__.global_range(path + [("global_range", None)], service) - - class global_range(metaclass=PyMenuMeta): + super().__init__(path, service) + def cavitation(self, *args, **kwargs): """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/wall_adhesion").execute(*args, **kwargs) - class auto_range_off(metaclass=PyMenuMeta): + class virtual_mass(TUIMenu): """ + Enter the menu to set virtual mass models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.clip_to_range = self.__class__.clip_to_range(path + [("clip_to_range", None)], service) - self.minimum = self.__class__.minimum(path + [("minimum", None)], service) - self.maximum = self.__class__.maximum(path + [("maximum", None)], service) - - class clip_to_range(metaclass=PyMenuMeta): + super().__init__(path, service) + def cavitation(self, *args, **kwargs): """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class minimum(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class maximum(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/wall_adhesion").execute(*args, **kwargs) - class color_map(metaclass=PyMenuMeta): + class model_transition(TUIMenu): """ + Enters the menu to set model transition mechanisms. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.visible = self.__class__.visible(path + [("visible", None)], service) - self.size = self.__class__.size(path + [("size", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) - self.log_scale = self.__class__.log_scale(path + [("log_scale", None)], service) - self.format = self.__class__.format(path + [("format", None)], service) - self.user_skip = self.__class__.user_skip(path + [("user_skip", None)], service) - self.show_all = self.__class__.show_all(path + [("show_all", None)], service) - self.position = self.__class__.position(path + [("position", None)], service) - self.font_name = self.__class__.font_name(path + [("font_name", None)], service) - self.font_automatic = self.__class__.font_automatic(path + [("font_automatic", None)], service) - self.font_size = self.__class__.font_size(path + [("font_size", None)], service) - self.length = self.__class__.length(path + [("length", None)], service) - self.width = self.__class__.width(path + [("width", None)], service) - - class visible(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class log_scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class format(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class user_skip(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class show_all(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class position(metaclass=PyMenuMeta): + self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) + self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) + self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) + self.lift = self.__class__.lift(path + [("lift", None)], service) + self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) + self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) + super().__init__(path, service) + def drag(self, *args, **kwargs): """ + Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_name(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/drag").execute(*args, **kwargs) + def heat_coeff(self, *args, **kwargs): """ + Specify the heat transfer coefficient function between each pair of phases. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_automatic(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/heat_coeff").execute(*args, **kwargs) + def interfacial_area(self, *args, **kwargs): """ + Set the interfacial area parameters for each pair of phases. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class font_size(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interfacial_area").execute(*args, **kwargs) + def mass_transfer(self, *args, **kwargs): """ + Specify the mass transfer mechanisms. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class length(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/mass_transfer").execute(*args, **kwargs) + def model_transition(self, *args, **kwargs): """ + Sets the VOF-to-DPM model transition mechanism. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class width(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/model_transition").execute(*args, **kwargs) + def reactions(self, *args, **kwargs): """ + Define multiple heterogeneous reactions and stoichiometry. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class draw_mesh(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mesh_object(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class display_state_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class physics(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geometry(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class pathlines(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.uid = self.__class__.uid(path + [("uid", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - self.range = self.__class__.range(path + [("range", None)], service) - self.style_attribute = self.__class__.style_attribute(path + [("style_attribute", None)], service) - self.accuracy_control = self.__class__.accuracy_control(path + [("accuracy_control", None)], service) - self.plot = self.__class__.plot(path + [("plot", None)], service) - self.step = self.__class__.step(path + [("step", None)], service) - self.skip = self.__class__.skip(path + [("skip", None)], service) - self.coarsen = self.__class__.coarsen(path + [("coarsen", None)], service) - self.onzone = self.__class__.onzone(path + [("onzone", None)], service) - self.field = self.__class__.field(path + [("field", None)], service) - self.surfaces_list = self.__class__.surfaces_list(path + [("surfaces_list", None)], service) - self.velocity_domain = self.__class__.velocity_domain(path + [("velocity_domain", None)], service) - self.color_map = self.__class__.color_map(path + [("color_map", None)], service) - self.draw_mesh = self.__class__.draw_mesh(path + [("draw_mesh", None)], service) - self.mesh_object = self.__class__.mesh_object(path + [("mesh_object", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - self.physics = self.__class__.physics(path + [("physics", None)], service) - self.geometry = self.__class__.geometry(path + [("geometry", None)], service) - self.surfaces = self.__class__.surfaces(path + [("surfaces", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uid(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.oil_flow = self.__class__.oil_flow(path + [("oil_flow", None)], service) - self.reverse = self.__class__.reverse(path + [("reverse", None)], service) - self.node_values = self.__class__.node_values(path + [("node_values", None)], service) - self.relative = self.__class__.relative(path + [("relative", None)], service) - - class oil_flow(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/reactions").execute(*args, **kwargs) + def restitution(self, *args, **kwargs): """ + Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class reverse(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/restitution").execute(*args, **kwargs) + def slip_velocity(self, *args, **kwargs): """ + Specify the slip velocity function for each secondary phase with respect to the primary phase. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class node_values(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/slip_velocity").execute(*args, **kwargs) + def turbulence_interaction(self, *args, **kwargs): """ + Specify the turbulence interaction model for each primary-secondary phase pair. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class relative(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/turbulence_interaction").execute(*args, **kwargs) + def turbulent_dispersion(self, *args, **kwargs): """ + Specify the turbulent dispersion model for each primary-secondary phase pair. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_range = self.__class__.auto_range(path + [("auto_range", None)], service) - self.clip_to_range = self.__class__.clip_to_range(path + [("clip_to_range", None)], service) - - class auto_range(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/turbulent_dispersion").execute(*args, **kwargs) + def wall_lubrication(self, *args, **kwargs): """ + Specify the wall lubrication model for each primary-secondary phase pair. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/wall_lubrication").execute(*args, **kwargs) - class clip_to_range(metaclass=PyMenuMeta): + class cavitation(TUIMenu): """ + Enter the menu to set cavitation models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.min_value = self.__class__.min_value(path + [("min_value", None)], service) - self.max_value = self.__class__.max_value(path + [("max_value", None)], service) - - class min_value(metaclass=PyMenuMeta): + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): """ + Include the effects of surface tension along the fluid-fluid interface?. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class max_value(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): """ + Specify the surface tension coefficient for each pair of phases. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class style_attribute(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.style = self.__class__.style(path + [("style", None)], service) - self.line_width = self.__class__.line_width(path + [("line_width", None)], service) - self.arrow_space = self.__class__.arrow_space(path + [("arrow_space", None)], service) - self.arrow_scale = self.__class__.arrow_scale(path + [("arrow_scale", None)], service) - self.marker_size = self.__class__.marker_size(path + [("marker_size", None)], service) - self.sphere_size = self.__class__.sphere_size(path + [("sphere_size", None)], service) - self.sphere_lod = self.__class__.sphere_lod(path + [("sphere_lod", None)], service) - self.radius = self.__class__.radius(path + [("radius", None)], service) - self.ribbon = self.__class__.ribbon(path + [("ribbon", None)], service) - - class style(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class line_width(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class arrow_space(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class arrow_scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/cavitation/wall_adhesion").execute(*args, **kwargs) - class marker_size(metaclass=PyMenuMeta): + class interphase_discretization(TUIMenu): """ + Enter the menu to set interphase discretization models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - class sphere_size(metaclass=PyMenuMeta): + class interphase_viscous_dissipation(TUIMenu): """ + Enter the menu to set interphase viscous dissipation related models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - class sphere_lod(metaclass=PyMenuMeta): + class lift(TUIMenu): """ + Enter the menu to set lift models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/lift/wall_adhesion").execute(*args, **kwargs) - class radius(metaclass=PyMenuMeta): + class surface_tension(TUIMenu): """ + Enter the menu to set surface tension models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/wall_adhesion").execute(*args, **kwargs) - class ribbon(metaclass=PyMenuMeta): + class virtual_mass(TUIMenu): """ + Enter the menu to set virtual mass models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.field = self.__class__.field(path + [("field", None)], service) - self.scalefactor = self.__class__.scalefactor(path + [("scalefactor", None)], service) - - class field(metaclass=PyMenuMeta): + super().__init__(path, service) + def cavitation(self, *args, **kwargs): """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class scalefactor(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/wall_adhesion").execute(*args, **kwargs) - class accuracy_control(metaclass=PyMenuMeta): + class numerics(TUIMenu): """ + Enters the menu to set numerics models. This menu is available for multiphase models with the sharp-dispersed and phase localized discretization interface modeling options (set in define/models/multiphase/interface-modeling-options). """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.step_size = self.__class__.step_size(path + [("step_size", None)], service) - self.tolerance = self.__class__.tolerance(path + [("tolerance", None)], service) - - class step_size(metaclass=PyMenuMeta): + self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) + self.interphase_discretization = self.__class__.interphase_discretization(path + [("interphase_discretization", None)], service) + self.interphase_viscous_dissipation = self.__class__.interphase_viscous_dissipation(path + [("interphase_viscous_dissipation", None)], service) + self.lift = self.__class__.lift(path + [("lift", None)], service) + self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) + self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) + super().__init__(path, service) + def drag(self, *args, **kwargs): """ + Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class tolerance(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/drag").execute(*args, **kwargs) + def heat_coeff(self, *args, **kwargs): """ + Specify the heat transfer coefficient function between each pair of phases. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class plot(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.x_axis_function = self.__class__.x_axis_function(path + [("x_axis_function", None)], service) - self.enabled = self.__class__.enabled(path + [("enabled", None)], service) - - class x_axis_function(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/heat_coeff").execute(*args, **kwargs) + def interfacial_area(self, *args, **kwargs): """ + Set the interfacial area parameters for each pair of phases. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class enabled(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interfacial_area").execute(*args, **kwargs) + def mass_transfer(self, *args, **kwargs): """ + Specify the mass transfer mechanisms. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class step(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class skip(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coarsen(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class onzone(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class surfaces_list(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class velocity_domain(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color_map(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.visible = self.__class__.visible(path + [("visible", None)], service) - self.size = self.__class__.size(path + [("size", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) - self.log_scale = self.__class__.log_scale(path + [("log_scale", None)], service) - self.format = self.__class__.format(path + [("format", None)], service) - self.user_skip = self.__class__.user_skip(path + [("user_skip", None)], service) - self.show_all = self.__class__.show_all(path + [("show_all", None)], service) - self.position = self.__class__.position(path + [("position", None)], service) - self.font_name = self.__class__.font_name(path + [("font_name", None)], service) - self.font_automatic = self.__class__.font_automatic(path + [("font_automatic", None)], service) - self.font_size = self.__class__.font_size(path + [("font_size", None)], service) - self.length = self.__class__.length(path + [("length", None)], service) - self.width = self.__class__.width(path + [("width", None)], service) - - class visible(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class size(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/mass_transfer").execute(*args, **kwargs) + def model_transition(self, *args, **kwargs): """ + Set the model transition mechanism. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/model_transition").execute(*args, **kwargs) + def reactions(self, *args, **kwargs): """ + Define multiple heterogeneous reactions and stoichiometry. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class log_scale(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/reactions").execute(*args, **kwargs) + def restitution(self, *args, **kwargs): """ + Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class format(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/restitution").execute(*args, **kwargs) + def slip_velocity(self, *args, **kwargs): """ + Specify the slip velocity function for each secondary phase with respect to the primary phase. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class user_skip(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/slip_velocity").execute(*args, **kwargs) + def turbulence_interaction(self, *args, **kwargs): """ + Specify the turbulence interaction model for each primary-secondary phase pair. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class show_all(metaclass=PyMenuMeta): + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/turbulence_interaction").execute(*args, **kwargs) + def turbulent_dispersion(self, *args, **kwargs): """ + Specify the turbulent dispersion model for each primary-secondary phase pair. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/turbulent_dispersion").execute(*args, **kwargs) + def wall_lubrication(self, *args, **kwargs): + """ + Specify the wall lubrication model for each primary-secondary phase pair. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/wall_lubrication").execute(*args, **kwargs) - class position(metaclass=PyMenuMeta): + class cavitation(TUIMenu): """ + Enter the menu to set cavitation models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/cavitation/wall_adhesion").execute(*args, **kwargs) - class font_name(metaclass=PyMenuMeta): + class interphase_discretization(TUIMenu): """ + Enters the menu to set interphase discretization models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enables/disables phase localized compressive scheme. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *args, **kwargs): + """ + Specifies the slope limiter to set a specific discretization scheme for each phase pair. A value of 0 corresponds to first order upwind, a value of 1 corresponds to second order upwind, a value of 2 applies the compressive scheme, and a value between 0 and 2 corresponds to a blended scheme. This option is available only wheninterphase-discr? is enabled. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - class font_automatic(metaclass=PyMenuMeta): + class interphase_viscous_dissipation(TUIMenu): """ + Enter the menu to set interphase viscous dissipation related models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - class font_size(metaclass=PyMenuMeta): + class lift(TUIMenu): """ + Enter the menu to set lift models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/lift/wall_adhesion").execute(*args, **kwargs) - class length(metaclass=PyMenuMeta): + class surface_tension(TUIMenu): """ + Enter the menu to set surface tension models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/surface_tension/wall_adhesion").execute(*args, **kwargs) - class width(metaclass=PyMenuMeta): + class virtual_mass(TUIMenu): """ + Enter the menu to set virtual mass models. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def cavitation(self, *args, **kwargs): + """ + Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/cavitation").execute(*args, **kwargs) + def interphase_discr(self, *args, **kwargs): + """ + Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/interphase_discr").execute(*args, **kwargs) + def interphase_visc_disp(self, *args, **kwargs): + """ + Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/interphase_visc_disp").execute(*args, **kwargs) + def jump_adhesion(self, *args, **kwargs): + """ + Enable the treatment of the contact angle specification at the porous jump boundary?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/jump_adhesion").execute(*args, **kwargs) + def lift(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/lift").execute(*args, **kwargs) + def lift_montoya(self, *args, **kwargs): + """ + Include the Montoya correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/lift_montoya").execute(*args, **kwargs) + def lift_shaver_podowski(self, *args, **kwargs): + """ + Include the Shaver-Podowski correction for Lift. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/lift_shaver_podowski").execute(*args, **kwargs) + def sfc_model_type(self, *args, **kwargs): + """ + Select the surface tension model. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/sfc_model_type").execute(*args, **kwargs) + def sfc_modeling(self, *args, **kwargs): + """ + Include the effects of surface tension along the fluid-fluid interface?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/sfc_modeling").execute(*args, **kwargs) + def sfc_tension_coeff(self, *args, **kwargs): + """ + Specify the surface tension coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/sfc_tension_coeff").execute(*args, **kwargs) + def slope_limiter(self, *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. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/slope_limiter").execute(*args, **kwargs) + def virtual_mass(self, *args, **kwargs): + """ + Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/virtual_mass").execute(*args, **kwargs) + def visc_disp_factor(self, *args, **kwargs): + """ + Set the dissipation intensity. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/visc_disp_factor").execute(*args, **kwargs) + def vmass_coeff(self, *args, **kwargs): + """ + Specify the virtual mass coefficient for each pair of phases. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/vmass_coeff").execute(*args, **kwargs) + def vmass_implicit_options(self, *args, **kwargs): + """ + Select the virtual mass implicit option. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/vmass_implicit_options").execute(*args, **kwargs) + def vmass_implicit(self, *args, **kwargs): + """ + Enable the implicit method for the virtual mass force?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/vmass_implicit").execute(*args, **kwargs) + def wall_adhesion(self, *args, **kwargs): + """ + Enable the specification for a wall adhesion angle?. + """ + return PyMenu(self.service, "/define/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/wall_adhesion").execute(*args, **kwargs) - class draw_mesh(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class iac_expert(TUIMenu): + """ + Enters the IAC expert setting menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def ishii_kim_model(self, *args, **kwargs): + """ + Sets Ishii-Kim model coefficients. + """ + return PyMenu(self.service, "/define/phases/iac_expert/ishii_kim_model").execute(*args, **kwargs) + def hibiki_ishii_model(self, *args, **kwargs): + """ + Sets Hibiki-Ishii model coefficients. + """ + return PyMenu(self.service, "/define/phases/iac_expert/hibiki_ishii_model").execute(*args, **kwargs) + def yao_morel_model(self, *args, **kwargs): + """ + Sets Yao-Morel model coefficients. + """ + return PyMenu(self.service, "/define/phases/iac_expert/yao_morel_model").execute(*args, **kwargs) + def iac_pseudo_time_step(self, *args, **kwargs): + """ + Set iac pseudo-time. + """ + return PyMenu(self.service, "/define/phases/iac_expert/iac_pseudo_time_step").execute(*args, **kwargs) - class mesh_object(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class profiles(TUIMenu): + """ + Enters the boundary profiles menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def display_profile_surface(self, *args, **kwargs): + """ + Display the profile as a surface (this option is only available if the specified profile contains node-connectivity data). + """ + return PyMenu(self.service, "/define/profiles/display_profile_surface").execute(*args, **kwargs) + def display_profile_point_cloud_data(self, *args, **kwargs): + """ + Display Profile Point Cloud Data. + """ + return PyMenu(self.service, "/define/profiles/display_profile_point_cloud_data").execute(*args, **kwargs) + def overlay_profile_surface(self, *args, **kwargs): + """ + Overlay Profile Surface. + """ + return PyMenu(self.service, "/define/profiles/overlay_profile_surface").execute(*args, **kwargs) + def overlay_profile_point_cloud_data(self, *args, **kwargs): + """ + Overlay Profile Point Cloud Data. + """ + return PyMenu(self.service, "/define/profiles/overlay_profile_point_cloud_data").execute(*args, **kwargs) + def set_preference_profile_point_cloud_data(self, *args, **kwargs): + """ + Set Preference Profile Point Cloud Data e.g., Point marker symbol,size,color. + """ + return PyMenu(self.service, "/define/profiles/set_preference_profile_point_cloud_data").execute(*args, **kwargs) + def list_profile_parameters(self, *args, **kwargs): + """ + List the parameters of a particular profile. + """ + return PyMenu(self.service, "/define/profiles/list_profile_parameters").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes a profile. + """ + return PyMenu(self.service, "/define/profiles/delete").execute(*args, **kwargs) + def delete_all(self, *args, **kwargs): + """ + Deletes all boundary-profiles. + """ + return PyMenu(self.service, "/define/profiles/delete_all").execute(*args, **kwargs) + def list_profiles(self, *args, **kwargs): + """ + Lists all profiles. + """ + return PyMenu(self.service, "/define/profiles/list_profiles").execute(*args, **kwargs) + def list_profile_fields(self, *args, **kwargs): + """ + Lists the fields of a particular profile. + """ + return PyMenu(self.service, "/define/profiles/list_profile_fields").execute(*args, **kwargs) + def interpolation_method(self, *args, **kwargs): + """ + Chooses the method for interpolation of profiles. + """ + return PyMenu(self.service, "/define/profiles/interpolation_method").execute(*args, **kwargs) + def morphing(self, *args, **kwargs): + """ + Enables/disables profile morphing options in Orient Profile panel. + """ + return PyMenu(self.service, "/define/profiles/morphing").execute(*args, **kwargs) + def update_interval(self, *args, **kwargs): + """ + Sets interval between updates of dynamic profiles. + """ + return PyMenu(self.service, "/define/profiles/update_interval").execute(*args, **kwargs) + def link_profile_to_reference_frame(self, *args, **kwargs): + """ + Attaches a profile to a reference frame so that the profile will rotate according to the reference frame. + """ + return PyMenu(self.service, "/define/profiles/link_profile_to_reference_frame").execute(*args, **kwargs) + def replicate_profile(self, *args, **kwargs): + """ + Replicate Profile. + """ + return PyMenu(self.service, "/define/profiles/replicate_profile").execute(*args, **kwargs) + def orient_profile(self, *args, **kwargs): + """ + Re-orient an existing profile. + """ + return PyMenu(self.service, "/define/profiles/orient_profile").execute(*args, **kwargs) - class display_state_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class solution_strategy(TUIMenu): + """ + Enters the automatic initialization and case modification strategy menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.automatic_case_modification = self.__class__.automatic_case_modification(path + [("automatic_case_modification", None)], service) + super().__init__(path, service) + def enable_strategy(self, *args, **kwargs): + """ + Enables/disables automatic initialization and case modification. + """ + return PyMenu(self.service, "/define/solution_strategy/enable_strategy").execute(*args, **kwargs) + def execute_strategy(self, *args, **kwargs): + """ + Executes the currently defined automatic initialization and case modification strategy. + """ + return PyMenu(self.service, "/define/solution_strategy/execute_strategy").execute(*args, **kwargs) + def add_edit_modification(self, *args, **kwargs): + """ + Define a single case modification. + """ + return PyMenu(self.service, "/define/solution_strategy/add_edit_modification").execute(*args, **kwargs) + def copy_modification(self, *args, **kwargs): + """ + Copy a single case modification. + """ + return PyMenu(self.service, "/define/solution_strategy/copy_modification").execute(*args, **kwargs) + def delete_modification(self, *args, **kwargs): + """ + Delete a single case modification. + """ + return PyMenu(self.service, "/define/solution_strategy/delete_modification").execute(*args, **kwargs) + def enable_modification(self, *args, **kwargs): + """ + Enable a single defined case modification. + """ + return PyMenu(self.service, "/define/solution_strategy/enable_modification").execute(*args, **kwargs) + def disable_modification(self, *args, **kwargs): + """ + Disable a single defined case modification. + """ + return PyMenu(self.service, "/define/solution_strategy/disable_modification").execute(*args, **kwargs) + def import_modifications(self, *args, **kwargs): + """ + Import a list of case modifications from a tsv file. + """ + return PyMenu(self.service, "/define/solution_strategy/import_modifications").execute(*args, **kwargs) + def export_modifications(self, *args, **kwargs): + """ + Export all case modifications to a tsv file. + """ + return PyMenu(self.service, "/define/solution_strategy/export_modifications").execute(*args, **kwargs) + def continue_strategy_execution(self, *args, **kwargs): + """ + Continues execution of the currently defined automatic initialization and case modification strategy. + """ + return PyMenu(self.service, "/define/solution_strategy/continue_strategy_execution").execute(*args, **kwargs) + def automatic_initialization(self, *args, **kwargs): + """ + Defines how the case is to be automatically initialized. + """ + return PyMenu(self.service, "/define/solution_strategy/automatic_initialization").execute(*args, **kwargs) - class physics(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class automatic_case_modification(TUIMenu): + """ + Enters the automatic case modification menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def before_init_modification(self, *args, **kwargs): + """ + Specifies modification to be performed before initialization. + """ + return PyMenu(self.service, "/define/solution_strategy/automatic_case_modification/before_init_modification").execute(*args, **kwargs) + def original_settings(self, *args, **kwargs): + """ + Specifies modification to be performed after initialization to restore to original settings. + """ + return PyMenu(self.service, "/define/solution_strategy/automatic_case_modification/original_settings").execute(*args, **kwargs) + def modifications(self, *args, **kwargs): + """ + Specifies modifications to be performed during solution. + """ + return PyMenu(self.service, "/define/solution_strategy/automatic_case_modification/modifications").execute(*args, **kwargs) - class geometry(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class reference_frames(TUIMenu): + """ + Enters the reference frames menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add(self, *args, **kwargs): + """ + Creates a new reference frame. + """ + return PyMenu(self.service, "/define/reference_frames/add").execute(*args, **kwargs) + def display(self, *args, **kwargs): + """ + Displays the reference frame you specify. + """ + return PyMenu(self.service, "/define/reference_frames/display").execute(*args, **kwargs) + def display_edit(self, *args, **kwargs): + """ + Display and edit reference frame from graphics. + """ + return PyMenu(self.service, "/define/reference_frames/display_edit").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Allows you to edit a reference frame. + """ + return PyMenu(self.service, "/define/reference_frames/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes the reference frame you specify. + """ + return PyMenu(self.service, "/define/reference_frames/delete").execute(*args, **kwargs) + def hide(self, *args, **kwargs): + """ + Removes the specified reference frame from the graphics window. + """ + return PyMenu(self.service, "/define/reference_frames/hide").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Lists all of the reference frames. + """ + return PyMenu(self.service, "/define/reference_frames/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + Lists the properties of the reference frame you specify. + """ + return PyMenu(self.service, "/define/reference_frames/list_properties").execute(*args, **kwargs) - class surfaces(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class user_defined(TUIMenu): + """ + Enters the user-defined functions and scalars menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.real_gas_models = self.__class__.real_gas_models(path + [("real_gas_models", None)], service) + super().__init__(path, service) + def auto_compile_compiled_udfs(self, *args, **kwargs): + """ + For this Fluent session, specify whether to allow auto-compilation of compiled UDF when a case file (or settings file) is read. + """ + return PyMenu(self.service, "/define/user_defined/auto_compile_compiled_udfs").execute(*args, **kwargs) + def compiled_functions(self, *args, **kwargs): + """ + Opens user-defined function library. + """ + return PyMenu(self.service, "/define/user_defined/compiled_functions").execute(*args, **kwargs) + def use_built_in_compiler(self, *args, **kwargs): + """ + Enables/disables the use of a built-in compiler (Clang) when the define/user-defined/compiled-functions text command is used. This text command / compiler is available for Windows only, and is provided as part of the ANSYS Fluent installation. It is recommended that you enable this text command when the compiler you installed on your machine is an older version that is no longer supported. Note that the built-in compiler is used automatically if Fluent determines that you have not installed Microsoft Visual Studio or Clang on your computer, whether this text command is enabled or not. + """ + return PyMenu(self.service, "/define/user_defined/use_built_in_compiler").execute(*args, **kwargs) + def interpreted_functions(self, *args, **kwargs): + """ + Loads interpreted user-defined functions. + """ + return PyMenu(self.service, "/define/user_defined/interpreted_functions").execute(*args, **kwargs) + def function_hooks(self, *args, **kwargs): + """ + Hooks up user-defined functions. + """ + return PyMenu(self.service, "/define/user_defined/function_hooks").execute(*args, **kwargs) + def execute_on_demand(self, *args, **kwargs): + """ + Executes UDFs on demand. + """ + return PyMenu(self.service, "/define/user_defined/execute_on_demand").execute(*args, **kwargs) + def user_defined_memory(self, *args, **kwargs): + """ + Allocates user-defined memory. + """ + return PyMenu(self.service, "/define/user_defined/user_defined_memory").execute(*args, **kwargs) + def user_defined_node_memory(self, *args, **kwargs): + """ + Allocate user-defined node memory. + """ + return PyMenu(self.service, "/define/user_defined/user_defined_node_memory").execute(*args, **kwargs) + def use_contributed_cpp(self, *args, **kwargs): + """ + Enable/disable use of cpp from the Fluent.Inc/contrib directory. + """ + return PyMenu(self.service, "/define/user_defined/use_contributed_cpp").execute(*args, **kwargs) + def fan_model(self, *args, **kwargs): + """ + Configures user-defined fan model. + """ + return PyMenu(self.service, "/define/user_defined/fan_model").execute(*args, **kwargs) + def one_D_coupling(self, *args, **kwargs): + """ + Load 1D library. + """ + return PyMenu(self.service, "/define/user_defined/one_D_coupling").execute(*args, **kwargs) + def user_defined_scalars(self, *args, **kwargs): + """ + Defines user-defined scalars. + """ + return PyMenu(self.service, "/define/user_defined/user_defined_scalars").execute(*args, **kwargs) + def enable_udf_on_gpu(self, *args, **kwargs): + """ + Compile UDFs with OpenCL support. + """ + return PyMenu(self.service, "/define/user_defined/enable_udf_on_gpu").execute(*args, **kwargs) + def compile_customized_addon_module(self, *args, **kwargs): + """ + Compile customized addon module?. + """ + return PyMenu(self.service, "/define/user_defined/compile_customized_addon_module").execute(*args, **kwargs) - class particle_tracks(metaclass=PyNamedObjectMeta): + class real_gas_models(TUIMenu): + """ + Enters the real-gas menu to enable/configure real gas model. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def nist_real_gas_model(self, *args, **kwargs): + """ + Loads the NIST real-gas library. + """ + return PyMenu(self.service, "/define/user_defined/real_gas_models/nist_real_gas_model").execute(*args, **kwargs) + def nist_multispecies_real_gas_model(self, *args, **kwargs): + """ + Loads the NIST real-gas library. + """ + return PyMenu(self.service, "/define/user_defined/real_gas_models/nist_multispecies_real_gas_model").execute(*args, **kwargs) + def set_state(self, *args, **kwargs): + """ + Selects the state for NIST real gas model. + """ + return PyMenu(self.service, "/define/user_defined/real_gas_models/set_state").execute(*args, **kwargs) + def nist_settings(self, *args, **kwargs): """ + Specifies the name and the location for the REFPROP library and fluid files. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.uid = self.__class__.uid(path + [("uid", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - self.filter_settings = self.__class__.filter_settings(path + [("filter_settings", None)], service) - self.range = self.__class__.range(path + [("range", None)], service) - self.style_attribute = self.__class__.style_attribute(path + [("style_attribute", None)], service) - self.vector_settings = self.__class__.vector_settings(path + [("vector_settings", None)], service) - self.plot = self.__class__.plot(path + [("plot", None)], service) - self.track_single_particle_stream = self.__class__.track_single_particle_stream(path + [("track_single_particle_stream", None)], service) - self.skip = self.__class__.skip(path + [("skip", None)], service) - self.coarsen = self.__class__.coarsen(path + [("coarsen", None)], service) - self.field = self.__class__.field(path + [("field", None)], service) - self.injections_list = self.__class__.injections_list(path + [("injections_list", None)], service) - self.free_stream_particles = self.__class__.free_stream_particles(path + [("free_stream_particles", None)], service) - self.wall_film_particles = self.__class__.wall_film_particles(path + [("wall_film_particles", None)], service) - self.track_pdf_particles = self.__class__.track_pdf_particles(path + [("track_pdf_particles", None)], service) - self.color_map = self.__class__.color_map(path + [("color_map", None)], service) - self.draw_mesh = self.__class__.draw_mesh(path + [("draw_mesh", None)], service) - self.mesh_object = self.__class__.mesh_object(path + [("mesh_object", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - - class name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uid(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.node_values = self.__class__.node_values(path + [("node_values", None)], service) - - class node_values(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class filter_settings(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.field = self.__class__.field(path + [("field", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) - self.enabled = self.__class__.enabled(path + [("enabled", None)], service) - self.filter_minimum = self.__class__.filter_minimum(path + [("filter_minimum", None)], service) - self.filter_maximum = self.__class__.filter_maximum(path + [("filter_maximum", None)], service) - - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.inside = self.__class__.inside(path + [("inside", None)], service) - self.outside = self.__class__.outside(path + [("outside", None)], service) - - class inside(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class outside(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/define/user_defined/real_gas_models/nist_settings").execute(*args, **kwargs) + def user_defined_real_gas_model(self, *args, **kwargs): + """ + Loads the user-defined real-gas library. + """ + return PyMenu(self.service, "/define/user_defined/real_gas_models/user_defined_real_gas_model").execute(*args, **kwargs) + def user_defined_multispecies_real_gas_model(self, *args, **kwargs): + """ + Loads a user-defined multispecies real-gas library. + """ + return PyMenu(self.service, "/define/user_defined/real_gas_models/user_defined_multispecies_real_gas_model").execute(*args, **kwargs) - class enabled(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class named_expressions(TUIMenu): + """ + Enters the named expressions menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add(self, *args, **kwargs): + """ + Creates a new named expression. + """ + return PyMenu(self.service, "/define/named_expressions/add").execute(*args, **kwargs) + def compute(self, *args, **kwargs): + """ + Computes and prints the value of an expression. This is only available for expressions that evaluate to a single value. + """ + return PyMenu(self.service, "/define/named_expressions/compute").execute(*args, **kwargs) + def copy(self, *args, **kwargs): + """ + Allows you to copy an existing named expression. + """ + return PyMenu(self.service, "/define/named_expressions/copy").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Allows you to edit the definition of a named expression. + """ + return PyMenu(self.service, "/define/named_expressions/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Allows you to delete a named expression, as long as it is not in use. + """ + return PyMenu(self.service, "/define/named_expressions/delete").execute(*args, **kwargs) + def export_to_tsv(self, *args, **kwargs): + """ + Export one or more named expressions to a file in TSV format. + """ + return PyMenu(self.service, "/define/named_expressions/export_to_tsv").execute(*args, **kwargs) + def import_from_tsv(self, *args, **kwargs): + """ + Import one or more named expressions saved in TSV format. + """ + return PyMenu(self.service, "/define/named_expressions/import_from_tsv").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Lists all of the currently defined named expressions. + """ + return PyMenu(self.service, "/define/named_expressions/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + Lists the definition of a named expression. + """ + return PyMenu(self.service, "/define/named_expressions/list_properties").execute(*args, **kwargs) - class filter_minimum(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class virtual_boundary(TUIMenu): + """ + Manage Virtual Boundaries. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def boundary_interface(self, *args, **kwargs): + """ + Create a Boundary Interface. + """ + return PyMenu(self.service, "/define/virtual_boundary/boundary_interface").execute(*args, **kwargs) + def hole_geometry(self, *args, **kwargs): + """ + Create a Hole Geometry template. + """ + return PyMenu(self.service, "/define/virtual_boundary/hole_geometry").execute(*args, **kwargs) - class filter_maximum(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class curvilinear_coordinate_system(TUIMenu): + """ + Curvilinear Coordinate System. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def calculation_settings(self, *args, **kwargs): + """ + Define Settings for curvilinear coordinate system. + """ + return PyMenu(self.service, "/define/curvilinear_coordinate_system/calculation_settings").execute(*args, **kwargs) + def new(self, *args, **kwargs): + """ + Define a new curvilinear coordinate system. + """ + return PyMenu(self.service, "/define/curvilinear_coordinate_system/new").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edit an existing curvilinear coordinate system. + """ + return PyMenu(self.service, "/define/curvilinear_coordinate_system/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Delete Curvilinear Coordinate System. + """ + return PyMenu(self.service, "/define/curvilinear_coordinate_system/delete").execute(*args, **kwargs) + def display_settings(self, *args, **kwargs): + """ + Display settings for Curvilinear Coordinate System. + """ + return PyMenu(self.service, "/define/curvilinear_coordinate_system/display_settings").execute(*args, **kwargs) + def display(self, *args, **kwargs): + """ + Display Curvilinear Coordinate System. + """ + return PyMenu(self.service, "/define/curvilinear_coordinate_system/display").execute(*args, **kwargs) - class range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_range = self.__class__.auto_range(path + [("auto_range", None)], service) - self.clip_to_range = self.__class__.clip_to_range(path + [("clip_to_range", None)], service) + class file(TUIMenu): + """ + Enter the file menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.auto_save = self.__class__.auto_save(path + [("auto_save", None)], service) + self.cffio_options = self.__class__.cffio_options(path + [("cffio_options", None)], service) + self.export = self.__class__.export(path + [("export", None)], service) + self.transient_export = self.__class__.transient_export(path + [("transient_export", None)], service) + self.em_mapping = self.__class__.em_mapping(path + [("em_mapping", None)], service) + self.import_ = self.__class__.import_(path + [("import", None)], service) + self.interpolate = self.__class__.interpolate(path + [("interpolate", None)], service) + self.fsi = self.__class__.fsi(path + [("fsi", None)], service) + self.parametric_project = self.__class__.parametric_project(path + [("parametric_project", None)], service) + self.project = self.__class__.project(path + [("project[beta]", None)], service) + self.table_manager = self.__class__.table_manager(path + [("table_manager", None)], service) + self.solution_files = self.__class__.solution_files(path + [("solution_files", None)], service) + super().__init__(path, service) + def single_precision_coordinates(self, *args, **kwargs): + """ + Specifies whether the nodal coordinates should be written in single precision (rather than the default double precision). This text command is only available in the single-precision version of ANSYS Fluent. + """ + return PyMenu(self.service, "/file/single_precision_coordinates").execute(*args, **kwargs) + def binary_legacy_files(self, *args, **kwargs): + """ + Indicate whether to write binary or text format case and data files. + """ + return PyMenu(self.service, "/file/binary_legacy_files").execute(*args, **kwargs) + def cff_files(self, *args, **kwargs): + """ + Indicate whether to write ANSYS common fluids format (CFF) files or legacy case and data files. + """ + return PyMenu(self.service, "/file/cff_files").execute(*args, **kwargs) + def async_optimize(self, *args, **kwargs): + """ + Chooses whether to optimize file I/O using scratch disks and asynchronous operations. + """ + return PyMenu(self.service, "/file/async_optimize").execute(*args, **kwargs) + def write_pdat(self, *args, **kwargs): + """ + Enables / disables the attempt to save .pdat files. Note that this text command is no longer supported. + """ + return PyMenu(self.service, "/file/write_pdat").execute(*args, **kwargs) + def confirm_overwrite(self, *args, **kwargs): + """ + Indicate whether or not to confirm attempts to overwrite existing files. + """ + return PyMenu(self.service, "/file/confirm_overwrite").execute(*args, **kwargs) + def define_macro(self, *args, **kwargs): + """ + Saves input to a named macro. + """ + return PyMenu(self.service, "/file/define_macro").execute(*args, **kwargs) + def export_to_cfd_post(self, *args, **kwargs): + """ + Exports data files that are compatible with CFD-Post and EnSight (that is, .cdat and .cst files) and opens CFD-Post, if desired. + """ + return PyMenu(self.service, "/file/export_to_cfd_post").execute(*args, **kwargs) + def execute_macro(self, *args, **kwargs): + """ + Runs a previously defined macro. + """ + return PyMenu(self.service, "/file/execute_macro").execute(*args, **kwargs) + def read_settings(self, *args, **kwargs): + """ + Reads and sets boundary conditions from a specified file. + """ + return PyMenu(self.service, "/file/read_settings").execute(*args, **kwargs) + def read_case(self, *args, **kwargs): + """ + Read a case file. + + Parameters + ---------- + case_file_name : str + """ + return PyMenu(self.service, "/file/read_case").execute(*args, **kwargs) + def read_case_light(self, *args, **kwargs): + """ + Read a case file while skipping mesh elements. + """ + return PyMenu(self.service, "/file/read_case_light").execute(*args, **kwargs) + def read_case_data(self, *args, **kwargs): + """ + Reads a case and a data file. + """ + return PyMenu(self.service, "/file/read_case_data").execute(*args, **kwargs) + def read_data(self, *args, **kwargs): + """ + Reads a data file. + """ + return PyMenu(self.service, "/file/read_data").execute(*args, **kwargs) + def read_case_info(self, *args, **kwargs): + """ + Read basic case info. + """ + return PyMenu(self.service, "/file/read_case_info").execute(*args, **kwargs) + def read_field_functions(self, *args, **kwargs): + """ + Reads custom field function definitions from a file. + """ + return PyMenu(self.service, "/file/read_field_functions").execute(*args, **kwargs) + def read_injections(self, *args, **kwargs): + """ + Reads all DPM injections from a file. + """ + return PyMenu(self.service, "/file/read_injections").execute(*args, **kwargs) + def read_journal(self, *args, **kwargs): + """ + Read a journal file. + """ + return PyMenu(self.service, "/file/read_journal").execute(*args, **kwargs) + def read_macros(self, *args, **kwargs): + """ + Reads macro definitions from a file. + """ + return PyMenu(self.service, "/file/read_macros").execute(*args, **kwargs) + def read_profile(self, *args, **kwargs): + """ + Reads boundary profile data. + """ + return PyMenu(self.service, "/file/read_profile").execute(*args, **kwargs) + def read_transient_table(self, *args, **kwargs): + """ + Reads table of transient boundary profile data. + """ + return PyMenu(self.service, "/file/read_transient_table").execute(*args, **kwargs) + def read_pdf(self, *args, **kwargs): + """ + Reads a PDF file. + """ + return PyMenu(self.service, "/file/read_pdf").execute(*args, **kwargs) + def read_rays(self, *args, **kwargs): + """ + Reads a ray file. + """ + return PyMenu(self.service, "/file/read_rays").execute(*args, **kwargs) + def read_surface_clusters(self, *args, **kwargs): + """ + Reads surface clusters from a file. + """ + return PyMenu(self.service, "/file/read_surface_clusters").execute(*args, **kwargs) + def read_viewfactors(self, *args, **kwargs): + """ + Reads view factors from a file. + """ + return PyMenu(self.service, "/file/read_viewfactors").execute(*args, **kwargs) + def read_isat_table(self, *args, **kwargs): + """ + Reads ISAT Table. + """ + return PyMenu(self.service, "/file/read_isat_table").execute(*args, **kwargs) + def replace_mesh(self, *args, **kwargs): + """ + Replaces the mesh with a new one while preserving settings. + """ + return PyMenu(self.service, "/file/replace_mesh").execute(*args, **kwargs) + def reload_setup(self, *args, **kwargs): + """ + Discards any changes in the current ANSYS Fluent in Workbench session and removes any corresponding data from the Solution cell. This command is only available when running ANSYS Fluent in Workbench. + """ + return PyMenu(self.service, "/file/reload_setup").execute(*args, **kwargs) + def close_without_save(self, *args, **kwargs): + """ + Exits ANSYS Fluent without saving data in Workbench. This command is only available when running ANSYS Fluent in Workbench. + """ + return PyMenu(self.service, "/file/close_without_save").execute(*args, **kwargs) + def sync_workbench(self, *args, **kwargs): + """ + Directly updates Workbench with the most recent Fluent changes. This command is only available when running ANSYS Fluent in Workbench. + """ + return PyMenu(self.service, "/file/sync_workbench").execute(*args, **kwargs) + def set_batch_options(self, *args, **kwargs): + """ + Sets the batch options. + """ + return PyMenu(self.service, "/file/set_batch_options").execute(*args, **kwargs) + def set_idle_timeout(self, *args, **kwargs): + """ + Set the idle timeout. + """ + return PyMenu(self.service, "/file/set_idle_timeout").execute(*args, **kwargs) + def show_configuration(self, *args, **kwargs): + """ + Display current release and version information. + """ + return PyMenu(self.service, "/file/show_configuration").execute(*args, **kwargs) + def start_journal(self, *args, **kwargs): + """ + Start recording all input in a file. + """ + return PyMenu(self.service, "/file/start_journal").execute(*args, **kwargs) + def stop_journal(self, *args, **kwargs): + """ + Stop recording input and close the journal file. + """ + return PyMenu(self.service, "/file/stop_journal").execute(*args, **kwargs) + def stop_macro(self, *args, **kwargs): + """ + Stops recording input to a macro. + """ + return PyMenu(self.service, "/file/stop_macro").execute(*args, **kwargs) + def start_transcript(self, *args, **kwargs): + """ + Start recording input and output in a file. + """ + return PyMenu(self.service, "/file/start_transcript").execute(*args, **kwargs) + def stop_transcript(self, *args, **kwargs): + """ + Stop recording input and output and close the transcript file. + """ + return PyMenu(self.service, "/file/stop_transcript").execute(*args, **kwargs) + def write_settings(self, *args, **kwargs): + """ + Writes out current boundary conditions in use. + """ + return PyMenu(self.service, "/file/write_settings").execute(*args, **kwargs) + def write_boundary_mesh(self, *args, **kwargs): + """ + Writes the boundary mesh to a file. + """ + return PyMenu(self.service, "/file/write_boundary_mesh").execute(*args, **kwargs) + def write_case(self, *args, **kwargs): + """ + Write a case file. + """ + return PyMenu(self.service, "/file/write_case").execute(*args, **kwargs) + def write_case_light(self, *args, **kwargs): + """ + Save the case file in light-weight mode,i.e. mesh not touched. + """ + return PyMenu(self.service, "/file/write_case_light").execute(*args, **kwargs) + def data_file_options(self, *args, **kwargs): + """ + Sets derived quantities to be written in data file. + """ + return PyMenu(self.service, "/file/data_file_options").execute(*args, **kwargs) + def write_case_data(self, *args, **kwargs): + """ + Writes a case and a data file. + """ + return PyMenu(self.service, "/file/write_case_data").execute(*args, **kwargs) + def write_data(self, *args, **kwargs): + """ + Writes a data file. + """ + return PyMenu(self.service, "/file/write_data").execute(*args, **kwargs) + def write_fan_profile(self, *args, **kwargs): + """ + Computes radial profiles for a fan zone and writes them to a profile file. + """ + return PyMenu(self.service, "/file/write_fan_profile").execute(*args, **kwargs) + def write_field_functions(self, *args, **kwargs): + """ + Writes the currently defined custom field functions to a file. + """ + return PyMenu(self.service, "/file/write_field_functions").execute(*args, **kwargs) + def write_profile(self, *args, **kwargs): + """ + Writes surface data as a boundary profile file. + """ + return PyMenu(self.service, "/file/write_profile").execute(*args, **kwargs) + def write_currently_defined_profiles(self, *args, **kwargs): + """ + Write currently defined profiles. To use \*.csv format specify filename with .csv suffix. + """ + return PyMenu(self.service, "/file/write_currently_defined_profiles").execute(*args, **kwargs) + def set_target_reference_frame_for_write_profiles(self, *args, **kwargs): + """ + Set reference frame options, which will be used for position transformation during writing of profiles. + """ + return PyMenu(self.service, "/file/set_target_reference_frame_for_write_profiles").execute(*args, **kwargs) + def write_circumferential_averaged_profile(self, *args, **kwargs): + """ + Write surface data as a boundary profile file. To use \*.csv format specify filename with .csv suffix. + """ + return PyMenu(self.service, "/file/write_circumferential_averaged_profile").execute(*args, **kwargs) + def write_merge_profiles(self, *args, **kwargs): + """ + Writes a .csv file with the selected surfaces consolidated into one set of data points. + """ + return PyMenu(self.service, "/file/write_merge_profiles").execute(*args, **kwargs) + def write_pdf(self, *args, **kwargs): + """ + Writes a pdf file. + """ + return PyMenu(self.service, "/file/write_pdf").execute(*args, **kwargs) + def write_flamelet(self, *args, **kwargs): + """ + Writes a flamelet file. + """ + return PyMenu(self.service, "/file/write_flamelet").execute(*args, **kwargs) + def write_injections(self, *args, **kwargs): + """ + Writes out selected DPM injections to a file. + """ + return PyMenu(self.service, "/file/write_injections").execute(*args, **kwargs) + def write_macros(self, *args, **kwargs): + """ + Writes the currently defined macros to a file. + """ + return PyMenu(self.service, "/file/write_macros").execute(*args, **kwargs) + def write_isat_table(self, *args, **kwargs): + """ + Writes ISAT Table. + """ + return PyMenu(self.service, "/file/write_isat_table").execute(*args, **kwargs) + def write_cleanup_script(self, *args, **kwargs): + """ + Writes the cleanup-script-file for ANSYS Fluent. + """ + return PyMenu(self.service, "/file/write_cleanup_script").execute(*args, **kwargs) + def load_act_tool(self, *args, **kwargs): + """ + Load ACT Start Page. + """ + return PyMenu(self.service, "/file/load_act_tool").execute(*args, **kwargs) + def set_tui_version(self, *args, **kwargs): + """ + Set the version of the TUI commands. + """ + return PyMenu(self.service, "/file/set_tui_version").execute(*args, **kwargs) - class auto_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class auto_save(TUIMenu): + """ + Enters the auto save menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def case_frequency(self, *args, **kwargs): + """ + Specifies the frequency (in iterations, time steps, or flow time) with which case files are saved. + """ + return PyMenu(self.service, "/file/auto_save/case_frequency").execute(*args, **kwargs) + def data_frequency(self, *args, **kwargs): + """ + Specifies the frequency (in iterations, time steps, or flow time) with which data files are saved. + """ + return PyMenu(self.service, "/file/auto_save/data_frequency").execute(*args, **kwargs) + def root_name(self, *args, **kwargs): + """ + Specifies the root name for the files that are saved. + """ + return PyMenu(self.service, "/file/auto_save/root_name").execute(*args, **kwargs) + def retain_most_recent_files(self, *args, **kwargs): + """ + Sets autosave to retain the 5 most recent files. + """ + return PyMenu(self.service, "/file/auto_save/retain_most_recent_files").execute(*args, **kwargs) + def max_files(self, *args, **kwargs): + """ + Sets the maximum number of files. Once the maximum is reached, files will be erased as new files are written. + """ + return PyMenu(self.service, "/file/auto_save/max_files").execute(*args, **kwargs) + def append_file_name_with(self, *args, **kwargs): + """ + Sets the suffix for auto-saved files. The file name can be appended by flow-time, time-step value, or by user-specified flags in file name. + """ + return PyMenu(self.service, "/file/auto_save/append_file_name_with").execute(*args, **kwargs) + def save_data_file_every(self, *args, **kwargs): + """ + Specifies the type and frequency of the data file to be saved. + """ + return PyMenu(self.service, "/file/auto_save/save_data_file_every").execute(*args, **kwargs) - class clip_to_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.min_value = self.__class__.min_value(path + [("min_value", None)], service) - self.max_value = self.__class__.max_value(path + [("max_value", None)], service) + class cffio_options(TUIMenu): + """ + Enters the cffio options menu, which provides options for the I/O of case and data files in the Common Fluids Format (CFF). + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def io_mode(self, *args, **kwargs): + """ + Sets the I/O mode for writing CFF files. + + + 1. HOST: I/O is done serially by the host process. + + 2. NODE0: I/O is done serially by the node 0 process. + + 3. PARALLEL INDEPENDENT: I/O is done in parallel using the independent mode of MPI I/O. + + 4. PARALLEL COLLECTIVE: I/O is done in parallel using the collective mode of MPI I/O. + + + + """ + return PyMenu(self.service, "/file/cffio_options/io_mode").execute(*args, **kwargs) + def compression_level(self, *args, **kwargs): + """ + Sets the compression level for CFF files. The compression level can be set between 0 and 9 with 0 being least compression (fastest) and 9 being highest compression (slowest). + """ + return PyMenu(self.service, "/file/cffio_options/compression_level").execute(*args, **kwargs) + def single_precision_data(self, *args, **kwargs): + """ + Specifies whether the double-precision solver saves single-precision data when writing CFF data files, in order to reduce the size of the files. + """ + return PyMenu(self.service, "/file/cffio_options/single_precision_data").execute(*args, **kwargs) - class min_value(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class export(TUIMenu): + """ + Enter the export menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.system_coupling_definition_file_settings = self.__class__.system_coupling_definition_file_settings(path + [("system_coupling_definition_file_settings", None)], service) + self.settings = self.__class__.settings(path + [("settings", None)], service) + super().__init__(path, service) + def abaqus(self, *args, **kwargs): + """ + Writes an ABAQUS file. + """ + return PyMenu(self.service, "/file/export/abaqus").execute(*args, **kwargs) + def mechanical_apdl(self, *args, **kwargs): + """ + Write an Mechanical APDL file. + """ + return PyMenu(self.service, "/file/export/mechanical_apdl").execute(*args, **kwargs) + def mechanical_apdl_input(self, *args, **kwargs): + """ + Writes a Mechanical APDL Input file. + """ + return PyMenu(self.service, "/file/export/mechanical_apdl_input").execute(*args, **kwargs) + def ascii(self, *args, **kwargs): + """ + Writes an ASCII file. + """ + return PyMenu(self.service, "/file/export/ascii").execute(*args, **kwargs) + def common_fluids_format_post(self, *args, **kwargs): + """ + Writes common fluids format files (.cas.post and .dat.post) for mesh and data, respectively. These files are saved in the hierarchical data format. + """ + return PyMenu(self.service, "/file/export/common_fluids_format_post").execute(*args, **kwargs) + def avs(self, *args, **kwargs): + """ + Writes an AVS UCD file. + """ + return PyMenu(self.service, "/file/export/avs").execute(*args, **kwargs) + def cdat_for_cfd_post__and__ensight(self, *args, **kwargs): + """ + Write a CDAT for CFD-Post & EnSight file. + """ + return PyMenu(self.service, "/file/export/cdat_for_cfd_post__and__ensight").execute(*args, **kwargs) + def cgns(self, *args, **kwargs): + """ + Write a CGNS file. + """ + return PyMenu(self.service, "/file/export/cgns").execute(*args, **kwargs) + def custom_heat_flux(self, *args, **kwargs): + """ + Writes a generic file for heat transfer. + """ + return PyMenu(self.service, "/file/export/custom_heat_flux").execute(*args, **kwargs) + def dx(self, *args, **kwargs): + """ + Writes an IBM Data Explorer format file. + """ + return PyMenu(self.service, "/file/export/dx").execute(*args, **kwargs) + def ensight(self, *args, **kwargs): + """ + Writes EnSight geometry, velocity, and scalar files. + """ + return PyMenu(self.service, "/file/export/ensight").execute(*args, **kwargs) + def ensight_gold(self, *args, **kwargs): + """ + Writes EnSight Gold geometry, velocity, and scalar files. + """ + return PyMenu(self.service, "/file/export/ensight_gold").execute(*args, **kwargs) + def ensight_gold_parallel_surfaces(self, *args, **kwargs): + """ + Writes EnSight Gold geometry, velocity, and scalar files for surfaces in a parallel format suitable for ANSYS Ensight Enterprise. + """ + return PyMenu(self.service, "/file/export/ensight_gold_parallel_surfaces").execute(*args, **kwargs) + def ensight_gold_parallel_volume(self, *args, **kwargs): + """ + Writes EnSight Gold geometry, velocity, and scalar files for cell zones in a parallel format suitable for ANSYS Ensight Enterprise. + """ + return PyMenu(self.service, "/file/export/ensight_gold_parallel_volume").execute(*args, **kwargs) + def ensight_dvs_surfaces(self, *args, **kwargs): + """ + Write post-processing data(geometry, velocity and scalars) for surfaces using EnSight Dynamic Visualization Store Interface. + """ + return PyMenu(self.service, "/file/export/ensight_dvs_surfaces").execute(*args, **kwargs) + def ensight_dvs_volume(self, *args, **kwargs): + """ + Write post-processing data(geometry, velocity and scalars) for cell zones and boundaries attached to them using EnSight Dynamic Visualization Store Interface. + """ + return PyMenu(self.service, "/file/export/ensight_dvs_volume").execute(*args, **kwargs) + def icemcfd_for_icepak(self, *args, **kwargs): + """ + Writes a binary ICEM CFD domain file. + """ + return PyMenu(self.service, "/file/export/icemcfd_for_icepak").execute(*args, **kwargs) + def fast_mesh(self, *args, **kwargs): + """ + Writes FAST/Plot3D unstructured mesh file. + """ + return PyMenu(self.service, "/file/export/fast_mesh").execute(*args, **kwargs) + def fast_scalar(self, *args, **kwargs): + """ + Writes FAST/Plot3D unstructured scalar function file. + """ + return PyMenu(self.service, "/file/export/fast_scalar").execute(*args, **kwargs) + def fast_solution(self, *args, **kwargs): + """ + Writes FAST/Plot3D unstructured solution file. + """ + return PyMenu(self.service, "/file/export/fast_solution").execute(*args, **kwargs) + def fast_velocity(self, *args, **kwargs): + """ + Writes FAST/Plot3D unstructured vector function file. + """ + return PyMenu(self.service, "/file/export/fast_velocity").execute(*args, **kwargs) + def fieldview(self, *args, **kwargs): + """ + Writes FIELDVIEW case and data files. + """ + return PyMenu(self.service, "/file/export/fieldview").execute(*args, **kwargs) + def fieldview_data(self, *args, **kwargs): + """ + Writes FIELDVIEW case and data files. + """ + return PyMenu(self.service, "/file/export/fieldview_data").execute(*args, **kwargs) + def fieldview_unstruct(self, *args, **kwargs): + """ + Writes FIELDVIEW unstructured combined file. + """ + return PyMenu(self.service, "/file/export/fieldview_unstruct").execute(*args, **kwargs) + def fieldview_unstruct_mesh(self, *args, **kwargs): + """ + Writes FIELDVIEW unstructured mesh-only file. + """ + return PyMenu(self.service, "/file/export/fieldview_unstruct_mesh").execute(*args, **kwargs) + def fieldview_unstruct_data(self, *args, **kwargs): + """ + Writes FIELDVIEW unstructured results-only file. + """ + return PyMenu(self.service, "/file/export/fieldview_unstruct_data").execute(*args, **kwargs) + def fieldview_unstruct_surfaces(self, *args, **kwargs): + """ + Writes FIELDVIEW unstructured file for surfaces. You are prompted to select either [1], [2] or [3] to write either mesh-only, results-only, or combined for surfaces (respectively). + """ + return PyMenu(self.service, "/file/export/fieldview_unstruct_surfaces").execute(*args, **kwargs) + def fieldview_xdb(self, *args, **kwargs): + """ + Write a FieldView XDB format file. + """ + return PyMenu(self.service, "/file/export/fieldview_xdb").execute(*args, **kwargs) + def gambit(self, *args, **kwargs): + """ + Writes GAMBIT neutral file. + """ + return PyMenu(self.service, "/file/export/gambit").execute(*args, **kwargs) + def ideas(self, *args, **kwargs): + """ + Writes an I-deas universal file. + """ + return PyMenu(self.service, "/file/export/ideas").execute(*args, **kwargs) + def nastran(self, *args, **kwargs): + """ + Write a NASTRAN file. + """ + return PyMenu(self.service, "/file/export/nastran").execute(*args, **kwargs) + def patran_neutral(self, *args, **kwargs): + """ + Writes a PATRAN neutral file. + """ + return PyMenu(self.service, "/file/export/patran_neutral").execute(*args, **kwargs) + def patran_nodal(self, *args, **kwargs): + """ + Writes a PATRAN nodal results file. + """ + return PyMenu(self.service, "/file/export/patran_nodal").execute(*args, **kwargs) + def taitherm(self, *args, **kwargs): + """ + Exports TAITherm file. + """ + return PyMenu(self.service, "/file/export/taitherm").execute(*args, **kwargs) + def tecplot(self, *args, **kwargs): + """ + Writes a Tecplot+3DV format file. + """ + return PyMenu(self.service, "/file/export/tecplot").execute(*args, **kwargs) + def particle_history_data(self, *args, **kwargs): + """ + Exports particle-history data. + """ + return PyMenu(self.service, "/file/export/particle_history_data").execute(*args, **kwargs) - class max_value(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class system_coupling_definition_file_settings(TUIMenu): + """ + Enters the system coupling file (.scp) menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable_automatic_creation_of_scp_file(self, *args, **kwargs): + """ + Enables/disables automatically writing a .scp every time a case file is written. + """ + return PyMenu(self.service, "/file/export/system_coupling_definition_file_settings/enable_automatic_creation_of_scp_file").execute(*args, **kwargs) + def write_system_coupling_file(self, *args, **kwargs): + """ + Writes a system coupling (.scp) file. + """ + return PyMenu(self.service, "/file/export/system_coupling_definition_file_settings/write_system_coupling_file").execute(*args, **kwargs) - class style_attribute(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.style = self.__class__.style(path + [("style", None)], service) - self.line_width = self.__class__.line_width(path + [("line_width", None)], service) - self.arrow_space = self.__class__.arrow_space(path + [("arrow_space", None)], service) - self.arrow_scale = self.__class__.arrow_scale(path + [("arrow_scale", None)], service) - self.marker_size = self.__class__.marker_size(path + [("marker_size", None)], service) - self.sphere_size = self.__class__.sphere_size(path + [("sphere_size", None)], service) - self.sphere_lod = self.__class__.sphere_lod(path + [("sphere_lod", None)], service) - self.radius = self.__class__.radius(path + [("radius", None)], service) - self.ribbon_settings = self.__class__.ribbon_settings(path + [("ribbon_settings", None)], service) - self.sphere_settings = self.__class__.sphere_settings(path + [("sphere_settings", None)], service) + class settings(TUIMenu): + """ + Enter the export settings menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def set_cgns_export_filetype(self, *args, **kwargs): + """ + Select HDF5 or ADF as file format for CGNS. + """ + return PyMenu(self.service, "/file/export/settings/set_cgns_export_filetype").execute(*args, **kwargs) - class style(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class transient_export(TUIMenu): + """ + Enter the export menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.settings = self.__class__.settings(path + [("settings", None)], service) + super().__init__(path, service) + def abaqus(self, *args, **kwargs): + """ + Writes an ABAQUS file. + """ + return PyMenu(self.service, "/file/transient_export/abaqus").execute(*args, **kwargs) + def mechanical_apdl_input(self, *args, **kwargs): + """ + Writes a Mechanical APDL input file. + """ + return PyMenu(self.service, "/file/transient_export/mechanical_apdl_input").execute(*args, **kwargs) + def ascii(self, *args, **kwargs): + """ + Writes an ASCII file. + """ + return PyMenu(self.service, "/file/transient_export/ascii").execute(*args, **kwargs) + def avs(self, *args, **kwargs): + """ + Writes an AVS UCD file. + """ + return PyMenu(self.service, "/file/transient_export/avs").execute(*args, **kwargs) + def cdat_for_cfd_post__and__ensight(self, *args, **kwargs): + """ + Write a CDAT for CFD-Post & EnSight file. + """ + return PyMenu(self.service, "/file/transient_export/cdat_for_cfd_post__and__ensight").execute(*args, **kwargs) + def common_fluids_format_post(self, *args, **kwargs): + """ + Write an CFF Post-Only file. + """ + return PyMenu(self.service, "/file/transient_export/common_fluids_format_post").execute(*args, **kwargs) + def cgns(self, *args, **kwargs): + """ + Writes a CGNS file. + """ + return PyMenu(self.service, "/file/transient_export/cgns").execute(*args, **kwargs) + def dx(self, *args, **kwargs): + """ + Writes an IBM Data Explorer format file. + """ + return PyMenu(self.service, "/file/transient_export/dx").execute(*args, **kwargs) + def ensight_gold_transient(self, *args, **kwargs): + """ + Writes EnSight Gold geometry, velocity, and scalar files. + """ + return PyMenu(self.service, "/file/transient_export/ensight_gold_transient").execute(*args, **kwargs) + def ensight_gold_parallel_surfaces(self, *args, **kwargs): + """ + Writes EnSight Gold geometry, velocity, and scalar files for surfaces in a parallel format suitable for ANSYS Ensight Enterprise. + """ + return PyMenu(self.service, "/file/transient_export/ensight_gold_parallel_surfaces").execute(*args, **kwargs) + def ensight_gold_parallel_volume(self, *args, **kwargs): + """ + Writes EnSight Gold geometry, velocity, and scalar files for cell zones in a parallel format suitable for ANSYS Ensight Enterprise. + """ + return PyMenu(self.service, "/file/transient_export/ensight_gold_parallel_volume").execute(*args, **kwargs) + def ensight_dvs_surfaces(self, *args, **kwargs): + """ + Write post-processing data(geometry, velocity and scalars) for surfaces using EnSight Dynamic Visualization Store Interface. + """ + return PyMenu(self.service, "/file/transient_export/ensight_dvs_surfaces").execute(*args, **kwargs) + def ensight_dvs_volume(self, *args, **kwargs): + """ + Write post-processing data(geometry, velocity and scalars) for cell zones and boundaries attached to them using EnSight Dynamic Visualization Store Interface. + """ + return PyMenu(self.service, "/file/transient_export/ensight_dvs_volume").execute(*args, **kwargs) + def ensight_gold_from_existing_files(self, *args, **kwargs): + """ + Writes EnSight Gold files using ANSYS Fluent case files. + """ + return PyMenu(self.service, "/file/transient_export/ensight_gold_from_existing_files").execute(*args, **kwargs) + def fast(self, *args, **kwargs): + """ + Writes a FAST/Plot3D unstructured mesh velocity scalar file. + """ + return PyMenu(self.service, "/file/transient_export/fast").execute(*args, **kwargs) + def fast_solution(self, *args, **kwargs): + """ + Writes a FAST/Plot3D unstructured solution file. + """ + return PyMenu(self.service, "/file/transient_export/fast_solution").execute(*args, **kwargs) + def fieldview_unstruct(self, *args, **kwargs): + """ + Writes a FIELDVIEW unstructured combined file. + """ + return PyMenu(self.service, "/file/transient_export/fieldview_unstruct").execute(*args, **kwargs) + def fieldview_unstruct_mesh(self, *args, **kwargs): + """ + Writes a FIELDVIEW unstructured mesh only file. + """ + return PyMenu(self.service, "/file/transient_export/fieldview_unstruct_mesh").execute(*args, **kwargs) + def fieldview_unstruct_data(self, *args, **kwargs): + """ + Writes a FIELDVIEW unstructured results only file. + """ + return PyMenu(self.service, "/file/transient_export/fieldview_unstruct_data").execute(*args, **kwargs) + def fieldview_unstruct_surfaces(self, *args, **kwargs): + """ + Writes FIELDVIEW unstructured combined file for surfaces. + """ + return PyMenu(self.service, "/file/transient_export/fieldview_unstruct_surfaces").execute(*args, **kwargs) + def fieldview_xdb(self, *args, **kwargs): + """ + Write a FieldView XDB format file. + """ + return PyMenu(self.service, "/file/transient_export/fieldview_xdb").execute(*args, **kwargs) + def ideas(self, *args, **kwargs): + """ + Writes an I-deas universal file. + """ + return PyMenu(self.service, "/file/transient_export/ideas").execute(*args, **kwargs) + def nastran(self, *args, **kwargs): + """ + Writes a NASTRAN file. + """ + return PyMenu(self.service, "/file/transient_export/nastran").execute(*args, **kwargs) + def patran_neutral(self, *args, **kwargs): + """ + Writes a PATRAN neutral file. + """ + return PyMenu(self.service, "/file/transient_export/patran_neutral").execute(*args, **kwargs) + def taitherm(self, *args, **kwargs): + """ + Writes a TAITherm file. + """ + return PyMenu(self.service, "/file/transient_export/taitherm").execute(*args, **kwargs) + def tecplot(self, *args, **kwargs): + """ + Write a Tecplot+3DV format file. + """ + return PyMenu(self.service, "/file/transient_export/tecplot").execute(*args, **kwargs) + def particle_history_data(self, *args, **kwargs): + """ + Sets up an automatic particle-history data export. + """ + return PyMenu(self.service, "/file/transient_export/particle_history_data").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edits transient exports. + """ + return PyMenu(self.service, "/file/transient_export/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes transient exports. + """ + return PyMenu(self.service, "/file/transient_export/delete").execute(*args, **kwargs) - class line_width(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class settings(TUIMenu): + """ + Enters the automatic export settings menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def cfd_post_compatible(self, *args, **kwargs): + """ + Specifies when case files are written with the .cdat and .cst files exported for Ansys CFD-Post. Note that this setting is ignored if the Write Case File Every Time option is enabled in the Automatic Export dialog box, which is always the case starting in Release 2021 R1. + """ + return PyMenu(self.service, "/file/transient_export/settings/cfd_post_compatible").execute(*args, **kwargs) + + class em_mapping(TUIMenu): + """ + Enters the electromagnetic loss mapping menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def volumetric_energy_source(self, *args, **kwargs): + """ + Loss data provided by Ansoft will be assigned to Fluent for selected cell zones. + """ + return PyMenu(self.service, "/file/em_mapping/volumetric_energy_source").execute(*args, **kwargs) + def surface_energy_source(self, *args, **kwargs): + """ + Loss data provided by Ansoft will be assigned to Fluent for selected wall zones. + """ + return PyMenu(self.service, "/file/em_mapping/surface_energy_source").execute(*args, **kwargs) + def remove_loss_only(self, *args, **kwargs): + """ + Removes the loss data provided by Maxwell and keeps all other solution data. + """ + return PyMenu(self.service, "/file/em_mapping/remove_loss_only").execute(*args, **kwargs) + def maintain_loss_on_initialization(self, *args, **kwargs): + """ + Maintains the loss data provided by Maxwell even if solution is initialized. + """ + return PyMenu(self.service, "/file/em_mapping/maintain_loss_on_initialization").execute(*args, **kwargs) - class arrow_space(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class import_(TUIMenu): + """ + Enter the import menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.mechanical_apdl = self.__class__.mechanical_apdl(path + [("mechanical_apdl", None)], service) + self.abaqus = self.__class__.abaqus(path + [("abaqus", None)], service) + self.cfx = self.__class__.cfx(path + [("cfx", None)], service) + self.cgns = self.__class__.cgns(path + [("cgns", None)], service) + self.fmu_file = self.__class__.fmu_file(path + [("fmu_file", None)], service) + self.flamelet = self.__class__.flamelet(path + [("flamelet", None)], service) + self.lstc = self.__class__.lstc(path + [("lstc", None)], service) + self.nastran = self.__class__.nastran(path + [("nastran", None)], service) + self.partition = self.__class__.partition(path + [("partition", None)], service) + self.patran = self.__class__.patran(path + [("patran", None)], service) + self.plot3d = self.__class__.plot3d(path + [("plot3d", None)], service) + self.tecplot = self.__class__.tecplot(path + [("tecplot", None)], service) + super().__init__(path, service) + def chemkin_mechanism(self, *args, **kwargs): + """ + Reads a CHEMKIN mechanism file. + """ + return PyMenu(self.service, "/file/import/chemkin_mechanism").execute(*args, **kwargs) + def chemkin_report_each_line(self, *args, **kwargs): + """ + Enables/disables reporting after reading each line. + """ + return PyMenu(self.service, "/file/import/chemkin_report_each_line").execute(*args, **kwargs) + def fidap(self, *args, **kwargs): + """ + Imports a FIDAP neutral file. + """ + return PyMenu(self.service, "/file/import/fidap").execute(*args, **kwargs) + def fluent4_case(self, *args, **kwargs): + """ + Imports a formatted ANSYS Fluent 4 case file. + """ + return PyMenu(self.service, "/file/import/fluent4_case").execute(*args, **kwargs) + def gambit(self, *args, **kwargs): + """ + Imports a GAMBIT neutral file. + """ + return PyMenu(self.service, "/file/import/gambit").execute(*args, **kwargs) + def hypermesh(self, *args, **kwargs): + """ + Reads a HYPERMESH file as a case file. + """ + return PyMenu(self.service, "/file/import/hypermesh").execute(*args, **kwargs) + def ensight(self, *args, **kwargs): + """ + Reads an EnSight file as a case file. + """ + return PyMenu(self.service, "/file/import/ensight").execute(*args, **kwargs) + def ideas_universal(self, *args, **kwargs): + """ + Imports an I-deas Universal file. + """ + return PyMenu(self.service, "/file/import/ideas_universal").execute(*args, **kwargs) + def marc_post(self, *args, **kwargs): + """ + Reads a MARC POST file as a case file. + """ + return PyMenu(self.service, "/file/import/marc_post").execute(*args, **kwargs) + def ptc_mechanica(self, *args, **kwargs): + """ + Reads a PTC Mechanica Design file as a case file. + """ + return PyMenu(self.service, "/file/import/ptc_mechanica").execute(*args, **kwargs) + def prebfc_structured(self, *args, **kwargs): + """ + Imports a formatted PreBFC structured mesh file. + """ + return PyMenu(self.service, "/file/import/prebfc_structured").execute(*args, **kwargs) - class arrow_scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class mechanical_apdl(TUIMenu): + """ + Imports a Mechanical APDL file. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def input(self, *args, **kwargs): + """ + Reads a Mechanical APDL file as a case file. + """ + return PyMenu(self.service, "/file/import/mechanical_apdl/input").execute(*args, **kwargs) + def result(self, *args, **kwargs): + """ + Reads a Mechanical APDL result file as a case file. + """ + return PyMenu(self.service, "/file/import/mechanical_apdl/result").execute(*args, **kwargs) - class marker_size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class abaqus(TUIMenu): + """ + Imports an ABAQUS file. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def fil(self, *args, **kwargs): + """ + Reads an ABAQUS .fil result file as a case file. + """ + return PyMenu(self.service, "/file/import/abaqus/fil").execute(*args, **kwargs) + def input(self, *args, **kwargs): + """ + Reads an ABAQUS input file as a case file. + """ + return PyMenu(self.service, "/file/import/abaqus/input").execute(*args, **kwargs) + def odb(self, *args, **kwargs): + """ + Reads an ABAQUS odb file as a case file. + """ + return PyMenu(self.service, "/file/import/abaqus/odb").execute(*args, **kwargs) - class sphere_size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class cfx(TUIMenu): + """ + Imports a CFX file. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def definition(self, *args, **kwargs): + """ + Reads a CFX definition file as a case file. + """ + return PyMenu(self.service, "/file/import/cfx/definition").execute(*args, **kwargs) + def result(self, *args, **kwargs): + """ + Reads a CFX definition file as a case file. + """ + return PyMenu(self.service, "/file/import/cfx/result").execute(*args, **kwargs) - class sphere_lod(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class cgns(TUIMenu): + """ + Imports a CGNS file. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def mesh(self, *args, **kwargs): + """ + Imports a CGNS mesh file. + """ + return PyMenu(self.service, "/file/import/cgns/mesh").execute(*args, **kwargs) + def data(self, *args, **kwargs): + """ + Reads data from CGNS file. + """ + return PyMenu(self.service, "/file/import/cgns/data").execute(*args, **kwargs) + def mesh_data(self, *args, **kwargs): + """ + Imports a CGNS mesh file and data file. + """ + return PyMenu(self.service, "/file/import/cgns/mesh_data").execute(*args, **kwargs) - class radius(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class fmu_file(TUIMenu): + """ + Enters the import FMU file menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def import_fmu(self, *args, **kwargs): + """ + Imports an FMU file. + """ + return PyMenu(self.service, "/file/import/fmu_file/import_fmu").execute(*args, **kwargs) + def define_fmu(self, *args, **kwargs): + """ + Links the FMU variables with the Fluent output parameters. + """ + return PyMenu(self.service, "/file/import/fmu_file/define_fmu").execute(*args, **kwargs) + def select_fmu_local(self, *args, **kwargs): + """ + Allows you to select FMU local variables to be monitored during the calculation. + """ + return PyMenu(self.service, "/file/import/fmu_file/select_fmu_local").execute(*args, **kwargs) + def set_fmu_parameter(self, *args, **kwargs): + """ + Allows you to select FMU parameter variables and change their values. + """ + return PyMenu(self.service, "/file/import/fmu_file/set_fmu_parameter").execute(*args, **kwargs) - class ribbon_settings(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.field = self.__class__.field(path + [("field", None)], service) - self.scalefactor = self.__class__.scalefactor(path + [("scalefactor", None)], service) + class flamelet(TUIMenu): + """ + Imports a flamelet file. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def standard(self, *args, **kwargs): + """ + Reads a standard format flamelet file. + """ + return PyMenu(self.service, "/file/import/flamelet/standard").execute(*args, **kwargs) + def cfx_rif(self, *args, **kwargs): + """ + Reads a CFX-RIF format flamelet file. + """ + return PyMenu(self.service, "/file/import/flamelet/cfx_rif").execute(*args, **kwargs) - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class lstc(TUIMenu): + """ + Imports an LSTC file. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def input(self, *args, **kwargs): + """ + Reads an LSTC input file as a case file. + """ + return PyMenu(self.service, "/file/import/lstc/input").execute(*args, **kwargs) + def state(self, *args, **kwargs): + """ + Reads an LSTC result file as a case file. + """ + return PyMenu(self.service, "/file/import/lstc/state").execute(*args, **kwargs) - class scalefactor(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class nastran(TUIMenu): + """ + Imports a NASTRAN file. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def bulkdata(self, *args, **kwargs): + """ + Reads a NASTRAN file as a case file. + """ + return PyMenu(self.service, "/file/import/nastran/bulkdata").execute(*args, **kwargs) + def output2(self, *args, **kwargs): + """ + Reads a NASTRAN op2 file as a case file. + """ + return PyMenu(self.service, "/file/import/nastran/output2").execute(*args, **kwargs) - class sphere_settings(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.scale = self.__class__.scale(path + [("scale", None)], service) - self.sphere_lod = self.__class__.sphere_lod(path + [("sphere_lod", None)], service) - self.options = self.__class__.options(path + [("options", None)], service) + class partition(TUIMenu): + """ + Enters the partition menu to set conditions for partitioning an ANSYS Fluent case file during read. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def metis(self, *args, **kwargs): + """ + Reads and partitions an ANSYS Fluent case file. + """ + return PyMenu(self.service, "/file/import/partition/metis").execute(*args, **kwargs) + def metis_zone(self, *args, **kwargs): + """ + Reads and partitions an ANSYS Fluent case file. + """ + return PyMenu(self.service, "/file/import/partition/metis_zone").execute(*args, **kwargs) - class scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class patran(TUIMenu): + """ + Imports a PATRAN neutral file (zones defined by named components). + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def neutral(self, *args, **kwargs): + """ + Reads a PATRAN Neutral file (zones defined by named components) as a case file. + """ + return PyMenu(self.service, "/file/import/patran/neutral").execute(*args, **kwargs) - class sphere_lod(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class plot3d(TUIMenu): + """ + Imports a PLOT3D file. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def mesh(self, *args, **kwargs): + """ + Reads a PLOT3D file as a case file. + """ + return PyMenu(self.service, "/file/import/plot3d/mesh").execute(*args, **kwargs) - class options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.constant = self.__class__.constant(path + [("constant", None)], service) - self.variable = self.__class__.variable(path + [("variable", None)], service) + class tecplot(TUIMenu): + """ + Enters the Tecplot menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def mesh(self, *args, **kwargs): + """ + Reads a Tecplot binary file as a case file. + """ + return PyMenu(self.service, "/file/import/tecplot/mesh").execute(*args, **kwargs) - class constant(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.diameter = self.__class__.diameter(path + [("diameter", None)], service) + class interpolate(TUIMenu): + """ + Interpolates data to/from another grid. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def write_data(self, *args, **kwargs): + """ + Writes data for interpolation. + """ + return PyMenu(self.service, "/file/interpolate/write_data").execute(*args, **kwargs) + def read_data(self, *args, **kwargs): + """ + Reads and interpolates data. + """ + return PyMenu(self.service, "/file/interpolate/read_data").execute(*args, **kwargs) + def zone_selection(self, *args, **kwargs): + """ + Defines a list of cell zone IDs. If specified, interpolation data will be read/written for these cell zones only. + """ + return PyMenu(self.service, "/file/interpolate/zone_selection").execute(*args, **kwargs) - class diameter(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class fsi(TUIMenu): + """ + Enters the fluid-structure interaction menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def read_fsi_mesh(self, *args, **kwargs): + """ + Reads an FEM mesh for one-way data mapping from ANSYS Fluent. + """ + return PyMenu(self.service, "/file/fsi/read_fsi_mesh").execute(*args, **kwargs) + def display_fsi_mesh(self, *args, **kwargs): + """ + Displays the mesh for a fluid-structure interaction. + """ + return PyMenu(self.service, "/file/fsi/display_fsi_mesh").execute(*args, **kwargs) + def write_fsi_mesh(self, *args, **kwargs): + """ + Writes a fluid-structure interaction mesh file. + """ + return PyMenu(self.service, "/file/fsi/write_fsi_mesh").execute(*args, **kwargs) + def conserve_force(self, *args, **kwargs): + """ + Conserve the forces for linear line, tri and tet elements. + """ + return PyMenu(self.service, "/file/fsi/conserve_force").execute(*args, **kwargs) - class variable(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.size_by = self.__class__.size_by(path + [("size_by", None)], service) - self.range = self.__class__.range(path + [("range", None)], service) - - class size_by(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_range = self.__class__.auto_range(path + [("auto_range", None)], service) - self.clip_to_range = self.__class__.clip_to_range(path + [("clip_to_range", None)], service) - - class auto_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class clip_to_range(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.min_value = self.__class__.min_value(path + [("min_value", None)], service) - self.max_value = self.__class__.max_value(path + [("max_value", None)], service) - - class min_value(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class max_value(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vector_settings(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.style = self.__class__.style(path + [("style", None)], service) - self.vector_length = self.__class__.vector_length(path + [("vector_length", None)], service) - self.constant_color = self.__class__.constant_color(path + [("constant_color", None)], service) - self.vector_of = self.__class__.vector_of(path + [("vector_of", None)], service) - self.scale = self.__class__.scale(path + [("scale", None)], service) - self.length_to_head_ratio = self.__class__.length_to_head_ratio(path + [("length_to_head_ratio", None)], service) + class parametric_project(TUIMenu): + """ + Enter to open, save, archive parametric project. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def open(self, *args, **kwargs): + """ + Open project. + """ + return PyMenu(self.service, "/file/parametric_project/open").execute(*args, **kwargs) + def save(self, *args, **kwargs): + """ + Save Project. + """ + return PyMenu(self.service, "/file/parametric_project/save").execute(*args, **kwargs) + def save_as(self, *args, **kwargs): + """ + Save As Project. + """ + return PyMenu(self.service, "/file/parametric_project/save_as").execute(*args, **kwargs) + def save_as_copy(self, *args, **kwargs): + """ + Save As Copy. + """ + return PyMenu(self.service, "/file/parametric_project/save_as_copy").execute(*args, **kwargs) + def archive(self, *args, **kwargs): + """ + Archive Project. + """ + return PyMenu(self.service, "/file/parametric_project/archive").execute(*args, **kwargs) - class style(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class project(TUIMenu): + """ + Enter to create new project, open project, save and archive project. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def new(self, *args, **kwargs): + """ + Create New Project. + """ + return PyMenu(self.service, "/file/project[beta]/new").execute(*args, **kwargs) + def open(self, *args, **kwargs): + """ + Open project. + """ + return PyMenu(self.service, "/file/project[beta]/open").execute(*args, **kwargs) + def save(self, *args, **kwargs): + """ + Save Project. + """ + return PyMenu(self.service, "/file/project[beta]/save").execute(*args, **kwargs) + def save_as(self, *args, **kwargs): + """ + Save As Project. + """ + return PyMenu(self.service, "/file/project[beta]/save_as").execute(*args, **kwargs) + def save_as_copy(self, *args, **kwargs): + """ + Save As Copy. + """ + return PyMenu(self.service, "/file/project[beta]/save_as_copy").execute(*args, **kwargs) + def archive(self, *args, **kwargs): + """ + Archive Project. + """ + return PyMenu(self.service, "/file/project[beta]/archive").execute(*args, **kwargs) - class vector_length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.constant_length = self.__class__.constant_length(path + [("constant_length", None)], service) - self.variable_length = self.__class__.variable_length(path + [("variable_length", None)], service) + class table_manager(TUIMenu): + """ + Enters the table file manager menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def delete(self, *args, **kwargs): + """ + Deletes a table from local storage. + """ + return PyMenu(self.service, "/file/table_manager/delete").execute(*args, **kwargs) + def list_matrix_data(self, *args, **kwargs): + """ + Lists the data of a “matrix” type locally-stored table. + """ + return PyMenu(self.service, "/file/table_manager/list_matrix_data").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + Lists the properties of a locally-stored table. + """ + return PyMenu(self.service, "/file/table_manager/list_properties").execute(*args, **kwargs) + def list_tables(self, *args, **kwargs): + """ + Lists all locally-stored tables. + """ + return PyMenu(self.service, "/file/table_manager/list_tables").execute(*args, **kwargs) + def read_matrix_data_file(self, *args, **kwargs): + """ + Imports a “matrix” type table from a file into local storage. + """ + return PyMenu(self.service, "/file/table_manager/read_matrix_data_file").execute(*args, **kwargs) + def read_rgp_file(self, *args, **kwargs): + """ + Imports a set of Real Gas Property (RGP) tables from a file into local storage. + """ + return PyMenu(self.service, "/file/table_manager/read_rgp_file").execute(*args, **kwargs) + def rename(self, *args, **kwargs): + """ + Renames a locally-stored table. + """ + return PyMenu(self.service, "/file/table_manager/rename").execute(*args, **kwargs) + def store_in_case_file(self, *args, **kwargs): + """ + Sets the persistence mode for RGP tables (embedded in case file or rely on external file). + """ + return PyMenu(self.service, "/file/table_manager/store_in_case_file").execute(*args, **kwargs) - class constant_length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class solution_files(TUIMenu): + """ + Enters the solution files menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def print_solution_files(self, *args, **kwargs): + """ + Prints a list of available solution files. + """ + return PyMenu(self.service, "/file/solution_files/print_solution_files").execute(*args, **kwargs) + def load_solution(self, *args, **kwargs): + """ + Loads a solution file. + """ + return PyMenu(self.service, "/file/solution_files/load_solution").execute(*args, **kwargs) + def delete_solution(self, *args, **kwargs): + """ + Deletes solution files. + """ + return PyMenu(self.service, "/file/solution_files/delete_solution").execute(*args, **kwargs) - class variable_length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class icing(TUIMenu): + """ + FENSAP-ICE options. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def file(self, *args, **kwargs): + """ + File menu. + """ + return PyMenu(self.service, "/icing/file").execute(*args, **kwargs) + def flow(self, *args, **kwargs): + """ + Flow solver menu. + """ + return PyMenu(self.service, "/icing/flow").execute(*args, **kwargs) + def drop(self, *args, **kwargs): + """ + Droplet impingement menu. + """ + return PyMenu(self.service, "/icing/drop").execute(*args, **kwargs) + def ice(self, *args, **kwargs): + """ + Ice accretion menu. + """ + return PyMenu(self.service, "/icing/ice").execute(*args, **kwargs) + def multishot(self, *args, **kwargs): + """ + Multi-shot accretion menu. + """ + return PyMenu(self.service, "/icing/multishot").execute(*args, **kwargs) + def settings(self, *args, **kwargs): + """ + Global settings menu. + """ + return PyMenu(self.service, "/icing/settings").execute(*args, **kwargs) - class constant_color(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.enabled = self.__class__.enabled(path + [("enabled", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) + class mesh(TUIMenu): + """ + Enter the mesh menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.adapt = self.__class__.adapt(path + [("adapt", None)], service) + self.modify_zones = self.__class__.modify_zones(path + [("modify_zones", None)], service) + self.polyhedra = self.__class__.polyhedra(path + [("polyhedra", None)], service) + self.reorder = self.__class__.reorder(path + [("reorder", None)], service) + self.repair_improve = self.__class__.repair_improve(path + [("repair_improve", None)], service) + self.surface_mesh = self.__class__.surface_mesh(path + [("surface_mesh", None)], service) + super().__init__(path, service) + def adjacency(self, *args, **kwargs): + """ + Views and renames face zones adjacent to selected cell zones. + """ + return PyMenu(self.service, "/mesh/adjacency").execute(*args, **kwargs) + def check(self, *args, **kwargs): + """ + Performs various mesh consistency checks and displays a report in the console that lists the domain extents, the volume statistics, the face area statistics, and any warnings, as well as details about the various checks and mesh failures (depending on the setting specified for mesh/check-verbosity). + """ + return PyMenu(self.service, "/mesh/check").execute(*args, **kwargs) + def check_before_solve(self, *args, **kwargs): + """ + The default value for mesh/check-before-solve is “no”. If mesh/check-before-solve is set to “yes”, a mesh check operation will be invoked prior to starting solver. If grid check fails, solver will be interrupted, and relevant information will be printed in the Fluent console. + """ + return PyMenu(self.service, "/mesh/check_before_solve").execute(*args, **kwargs) + def check_verbosity(self, *args, **kwargs): + """ + Sets the level of details that will be added to the mesh check report generated by mesh/check. A value of 0 (the default) notes when checks are being performed, but does not list them individually. A value of 1 lists the individual checks as they are performed. A value of 2 enables the availability of additional mesh field variables, lists the individual checks as they are performed, and provides additional details (for example, the location of the problem, the affected cells). The check-verbosity text command can also be used to set the level of detail displayed in the mesh quality report generated by mesh/quality. A value of 0 (the default) or 1 lists the minimum orthogonal quality and the maximum aspect ratio. A value of 2 adds information about the zones that contain the cells with the lowest quality, and additional metrics such as the maximum cell squish index and the minimum expansion ratio. + """ + return PyMenu(self.service, "/mesh/check_verbosity").execute(*args, **kwargs) + def enhanced_orthogonal_quality(self, *args, **kwargs): + """ + Enables / disables an enhanced definition when calculating the orthogonal quality. When enabled, the orthogonal quality is defined using a variety quality measures, including: the orthogonality of a face relative to a vector between the face and cell centroids; a metric that detects poor cell shape at a local edge (such as twisting and/or concavity); and the variation of normals between the faces that can be constructed from the cell face. This enhanced definition is optimal for evaluating thin prism cells. + """ + return PyMenu(self.service, "/mesh/enhanced_orthogonal_quality").execute(*args, **kwargs) + def mesh_info(self, *args, **kwargs): + """ + Prints zone information size. + """ + return PyMenu(self.service, "/mesh/mesh_info").execute(*args, **kwargs) + def memory_usage(self, *args, **kwargs): + """ + Reports solver memory use. + """ + return PyMenu(self.service, "/mesh/memory_usage").execute(*args, **kwargs) + def quality(self, *args, **kwargs): + """ + Displays information about the quality of the mesh in the console, including the minimum orthogonal quality and the maximum aspect ratio. The level of detail displayed depends on the setting specified for mesh/check-verbosity. + """ + return PyMenu(self.service, "/mesh/quality").execute(*args, **kwargs) + def redistribute_boundary_layer(self, *args, **kwargs): + """ + Redistributes the nodes in a boundary layer zone to achieve a desired growth rate after anisotropic adaption. + """ + return PyMenu(self.service, "/mesh/redistribute_boundary_layer").execute(*args, **kwargs) + def replace(self, *args, **kwargs): + """ + Replace mesh and interpolate data. + """ + return PyMenu(self.service, "/mesh/replace").execute(*args, **kwargs) + def rotate(self, *args, **kwargs): + """ + Rotates the mesh. + """ + return PyMenu(self.service, "/mesh/rotate").execute(*args, **kwargs) + def scale(self, *args, **kwargs): + """ + Prompts for the scaling factors in each of the active Cartesian coordinate directions. + """ + return PyMenu(self.service, "/mesh/scale").execute(*args, **kwargs) + def size_info(self, *args, **kwargs): + """ + Prints mesh size. + """ + return PyMenu(self.service, "/mesh/size_info").execute(*args, **kwargs) + def smooth_mesh(self, *args, **kwargs): + """ + Smooths the mesh using quality-based, Laplacian, or skewness methods. + """ + return PyMenu(self.service, "/mesh/smooth_mesh").execute(*args, **kwargs) + def swap_mesh_faces(self, *args, **kwargs): + """ + Swaps mesh faces. + """ + return PyMenu(self.service, "/mesh/swap_mesh_faces").execute(*args, **kwargs) + def show_periodic_shadow_zones(self, *args, **kwargs): + """ + Option to show periodic shadow zones in user interface. + """ + return PyMenu(self.service, "/mesh/show_periodic_shadow_zones").execute(*args, **kwargs) + def translate(self, *args, **kwargs): + """ + Prompts for the translation offset in each of the active Cartesian coordinate directions. + """ + return PyMenu(self.service, "/mesh/translate").execute(*args, **kwargs) + def set_unit_system(self, *args, **kwargs): + """ + To apply standard set of units to all quantities. + """ + return PyMenu(self.service, "/mesh/set_unit_system").execute(*args, **kwargs) + def units(self, *args, **kwargs): + """ + Set unit conversion factors. + """ + return PyMenu(self.service, "/mesh/units").execute(*args, **kwargs) - class enabled(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class adapt(TUIMenu): + """ + Enters the mesh adaption menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.set = self.__class__.set(path + [("set", None)], service) + self.profile = self.__class__.profile(path + [("profile", None)], service) + self.cell_registers = self.__class__.cell_registers(path + [("cell_registers", None)], service) + self.manage_criteria = self.__class__.manage_criteria(path + [("manage_criteria", None)], service) + self.multi_layer_refinement = self.__class__.multi_layer_refinement(path + [("multi_layer_refinement", None)], service) + self.geometry = self.__class__.geometry(path + [("geometry", None)], service) + super().__init__(path, service) + def refinement_criteria(self, *args, **kwargs): + """ + Allows you to provide an expression for the refinement criterion. + """ + return PyMenu(self.service, "/mesh/adapt/refinement_criteria").execute(*args, **kwargs) + def coarsening_criteria(self, *args, **kwargs): + """ + Allows you to provide an expression for the coarsening criterion. + """ + return PyMenu(self.service, "/mesh/adapt/coarsening_criteria").execute(*args, **kwargs) + def manual_refinement_criteria(self, *args, **kwargs): + """ + Set expression for manual refinement criterion. + """ + return PyMenu(self.service, "/mesh/adapt/manual_refinement_criteria").execute(*args, **kwargs) + def manual_coarsening_criteria(self, *args, **kwargs): + """ + Set expression for manual coarsening criterion. + """ + return PyMenu(self.service, "/mesh/adapt/manual_coarsening_criteria").execute(*args, **kwargs) + def adapt_mesh(self, *args, **kwargs): + """ + Performs manual adaption on the mesh according to the methods and settings that you specified. + """ + return PyMenu(self.service, "/mesh/adapt/adapt_mesh").execute(*args, **kwargs) + def display_adaption_cells(self, *args, **kwargs): + """ + Displays the cells that are marked for adaption in the graphics window. + """ + return PyMenu(self.service, "/mesh/adapt/display_adaption_cells").execute(*args, **kwargs) + def list_adaption_cells(self, *args, **kwargs): + """ + Prints the number of cells marked for refinement, coarsening, and both to the console. + """ + return PyMenu(self.service, "/mesh/adapt/list_adaption_cells").execute(*args, **kwargs) + def free_hierarchy(self, *args, **kwargs): + """ + Deletes the defined adaption hierarchy. + """ + return PyMenu(self.service, "/mesh/adapt/free_hierarchy").execute(*args, **kwargs) + def anisotropic_adaption(self, *args, **kwargs): + """ + Applies legacy anisotropic adaption to refine the boundary layers or registers. Cells will be split in the normal direction to the boundary face. Note that this text command is only available for 3D cases that have the adaption method set to hanging node. + """ + return PyMenu(self.service, "/mesh/adapt/anisotropic_adaption").execute(*args, **kwargs) - class color(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class set(TUIMenu): + """ + Enters the set menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def method(self, *args, **kwargs): + """ + Sets the adaption method. + """ + return PyMenu(self.service, "/mesh/adapt/set/method").execute(*args, **kwargs) + def cell_zones(self, *args, **kwargs): + """ + Sets cell zones to be used for marking adaption. An empty list specifies that all zones are considered for adaption. + """ + return PyMenu(self.service, "/mesh/adapt/set/cell_zones").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Allows you set how much information about the adaption is printed to the console. + """ + return PyMenu(self.service, "/mesh/adapt/set/verbosity").execute(*args, **kwargs) + def encapsulate_children(self, *args, **kwargs): + """ + Encapsulate all children of parent cells on the same partition. + """ + return PyMenu(self.service, "/mesh/adapt/set/encapsulate_children").execute(*args, **kwargs) + def maximum_refinement_level(self, *args, **kwargs): + """ + Controls the number of levels of refinement used to split cells during the adaption. + """ + return PyMenu(self.service, "/mesh/adapt/set/maximum_refinement_level").execute(*args, **kwargs) + def minimum_edge_length(self, *args, **kwargs): + """ + Sets an approximate limit to the edge length for cells that are considered for refinement. Even if a cell is marked for refinement, it will not be refined if (for 3D) its volume is less than the cube of this field or (for 2D) its area is less than the square of this field. The default value of zero places no limits on the size of cells that are refined. + """ + return PyMenu(self.service, "/mesh/adapt/set/minimum_edge_length").execute(*args, **kwargs) + def minimum_cell_quality(self, *args, **kwargs): + """ + Sets the minimum value allowed for the orthogonal quality of cells during adaption. If your solution diverges, you may find that using a higher minimum quality value resolves the issue. This text command is only available with the PUMA 3D adaption method. + """ + return PyMenu(self.service, "/mesh/adapt/set/minimum_cell_quality").execute(*args, **kwargs) + def maximum_cell_count(self, *args, **kwargs): + """ + Sets an approximate limit to the total cell count of the mesh during adaption. Fluent uses this value to determine when to stop marking cells for refinement. A value of zero places no limits on the number of cells. + """ + return PyMenu(self.service, "/mesh/adapt/set/maximum_cell_count").execute(*args, **kwargs) + def additional_refinement_layers(self, *args, **kwargs): + """ + Allows you to specify additional refinement layers (this is an advanced control). + """ + return PyMenu(self.service, "/mesh/adapt/set/additional_refinement_layers").execute(*args, **kwargs) + def anisotropic_adaption(self, *args, **kwargs): + """ + Enables / disables anisotropic adaption for prismatic cells as part of manual adaption. Note that this text command requires that the adaption method is set to PUMA. + """ + return PyMenu(self.service, "/mesh/adapt/set/anisotropic_adaption").execute(*args, **kwargs) + def anisotropic_boundary_zones(self, *args, **kwargs): + """ + Allows you to select the boundary zones that specify directions for anisotropic refinement with the PUMA method. + """ + return PyMenu(self.service, "/mesh/adapt/set/anisotropic_boundary_zones").execute(*args, **kwargs) + def anisotropic_split_ratio(self, *args, **kwargs): + """ + Sets the split ratio for the cells as part of anisotropic refinement with the PUMA method. + """ + return PyMenu(self.service, "/mesh/adapt/set/anisotropic_split_ratio").execute(*args, **kwargs) + def display_settings(self, *args, **kwargs): + """ + Sets the graphics display options for the refinement, coarsening, and common cells. + """ + return PyMenu(self.service, "/mesh/adapt/set/display_settings").execute(*args, **kwargs) + def dynamic_adaption(self, *args, **kwargs): + """ + Adapt the mesh during solution. + """ + return PyMenu(self.service, "/mesh/adapt/set/dynamic_adaption").execute(*args, **kwargs) + def dynamic_adaption_frequency(self, *args, **kwargs): + """ + Set frequency for dynamic adaption. + """ + return PyMenu(self.service, "/mesh/adapt/set/dynamic_adaption_frequency").execute(*args, **kwargs) + def overset_adapt_dead_cells(self, *args, **kwargs): + """ + Enables/disables the adaption of dead cells in overset meshes. + """ + return PyMenu(self.service, "/mesh/adapt/set/overset_adapt_dead_cells").execute(*args, **kwargs) - class vector_of(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class profile(TUIMenu): + """ + Enters the profile menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable(self, *args, **kwargs): + """ + Enables adaption profiling. + """ + return PyMenu(self.service, "/mesh/adapt/profile/enable").execute(*args, **kwargs) + def disable(self, *args, **kwargs): + """ + Disables adaption profiling. + """ + return PyMenu(self.service, "/mesh/adapt/profile/disable").execute(*args, **kwargs) + def print(self, *args, **kwargs): + """ + Prints adaption profiling results. + """ + return PyMenu(self.service, "/mesh/adapt/profile/print").execute(*args, **kwargs) + def clear(self, *args, **kwargs): + """ + Clears the adaption profiling counters. + """ + return PyMenu(self.service, "/mesh/adapt/profile/clear").execute(*args, **kwargs) - class scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class cell_registers(TUIMenu): + """ + Enters the cell registers menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def adapt(self, *args, **kwargs): + """ + Adapt cell register objects. + """ + return PyMenu(self.service, "/mesh/adapt/cell_registers/adapt").execute(*args, **kwargs) + def add(self, *args, **kwargs): + """ + Creates a new cell register. + """ + return PyMenu(self.service, "/mesh/adapt/cell_registers/add").execute(*args, **kwargs) + def apply_poor_mesh_numerics(self, *args, **kwargs): + """ + Applies poor mesh numerics to the mesh of a cell register. + """ + return PyMenu(self.service, "/mesh/adapt/cell_registers/apply_poor_mesh_numerics").execute(*args, **kwargs) + def coarsen(self, *args, **kwargs): + """ + Coarsen the mesh based on a cell register. + """ + return PyMenu(self.service, "/mesh/adapt/cell_registers/coarsen").execute(*args, **kwargs) + def display(self, *args, **kwargs): + """ + Displays a cell register. + """ + return PyMenu(self.service, "/mesh/adapt/cell_registers/display").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edits an existing cell register. + """ + return PyMenu(self.service, "/mesh/adapt/cell_registers/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes a cell register. + """ + return PyMenu(self.service, "/mesh/adapt/cell_registers/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Lists all of the currently defined cell registers. + """ + return PyMenu(self.service, "/mesh/adapt/cell_registers/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + Lists the properties of a cell register. + """ + return PyMenu(self.service, "/mesh/adapt/cell_registers/list_properties").execute(*args, **kwargs) + def refine(self, *args, **kwargs): + """ + Refine the mesh based on a cell register. + """ + return PyMenu(self.service, "/mesh/adapt/cell_registers/refine").execute(*args, **kwargs) - class length_to_head_ratio(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class manage_criteria(TUIMenu): + """ + Enters the manage criteria menu, which provides text commands for managing automatic adaption criteria. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add(self, *args, **kwargs): + """ + Adds a new automatic adaption criterion. + """ + return PyMenu(self.service, "/mesh/adapt/manage_criteria/add").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edits an existing automatic adaption criterion. + """ + return PyMenu(self.service, "/mesh/adapt/manage_criteria/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes an existing automatic adaption criterion. + """ + return PyMenu(self.service, "/mesh/adapt/manage_criteria/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Lists all the existing automatic adaption criteria. + """ + return PyMenu(self.service, "/mesh/adapt/manage_criteria/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + Lists the properties of an existing automatic adaption criterion. + """ + return PyMenu(self.service, "/mesh/adapt/manage_criteria/list_properties").execute(*args, **kwargs) - class plot(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.x_axis_function = self.__class__.x_axis_function(path + [("x_axis_function", None)], service) - self.enabled = self.__class__.enabled(path + [("enabled", None)], service) + class multi_layer_refinement(TUIMenu): + """ + Enter the multiple boundary layer refinement menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def refine_mesh(self, *args, **kwargs): + """ + Refine the mesh for multiple boundary layers. + """ + return PyMenu(self.service, "/mesh/adapt/multi_layer_refinement/refine_mesh").execute(*args, **kwargs) + def boundary_zones(self, *args, **kwargs): + """ + Specify boundary zones for refinement. + """ + return PyMenu(self.service, "/mesh/adapt/multi_layer_refinement/boundary_zones").execute(*args, **kwargs) + def layer_count(self, *args, **kwargs): + """ + Specify the layer count for refinement. + """ + return PyMenu(self.service, "/mesh/adapt/multi_layer_refinement/layer_count").execute(*args, **kwargs) + def parameters(self, *args, **kwargs): + """ + Specify parameters for multiple boundary layer refinement. + """ + return PyMenu(self.service, "/mesh/adapt/multi_layer_refinement/parameters").execute(*args, **kwargs) - class x_axis_function(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class geometry(TUIMenu): + """ + Enters the geometry menu. Note that this text command menu is not available unless the adaption method is set to hanging node. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def reconstruct_geometry(self, *args, **kwargs): + """ + Enables/disables geometry-based adaption. + """ + return PyMenu(self.service, "/mesh/adapt/geometry/reconstruct_geometry").execute(*args, **kwargs) + def set_geometry_controls(self, *args, **kwargs): + """ + Sets geometry controls for wall zones. + """ + return PyMenu(self.service, "/mesh/adapt/geometry/set_geometry_controls").execute(*args, **kwargs) - class enabled(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class modify_zones(TUIMenu): + """ + Enters the zone modification menu. For a description of the items in this menu, see define/boundary-conditions/modify-zones. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def activate_cell_zone(self, *args, **kwargs): + """ + Activate a cell thread. + """ + return PyMenu(self.service, "/mesh/modify_zones/activate_cell_zone").execute(*args, **kwargs) + def append_mesh(self, *args, **kwargs): + """ + Append new mesh. + """ + return PyMenu(self.service, "/mesh/modify_zones/append_mesh").execute(*args, **kwargs) + def append_mesh_data(self, *args, **kwargs): + """ + Append new mesh with data. + """ + return PyMenu(self.service, "/mesh/modify_zones/append_mesh_data").execute(*args, **kwargs) + def copy_move_cell_zone(self, *args, **kwargs): + """ + Copy and translate or rotate a cell zone. + """ + return PyMenu(self.service, "/mesh/modify_zones/copy_move_cell_zone").execute(*args, **kwargs) + def create_all_shell_threads(self, *args, **kwargs): + """ + Mark all finite thickness wall for shell creation. Shell zones will be created at the start of iterations. + """ + return PyMenu(self.service, "/mesh/modify_zones/create_all_shell_threads").execute(*args, **kwargs) + def deactivate_cell_zone(self, *args, **kwargs): + """ + Deactivate cell thread. + """ + return PyMenu(self.service, "/mesh/modify_zones/deactivate_cell_zone").execute(*args, **kwargs) + def recreate_all_shells(self, *args, **kwargs): + """ + Create shell on all the walls where which were deleted using the command delete-all-shells. + """ + return PyMenu(self.service, "/mesh/modify_zones/recreate_all_shells").execute(*args, **kwargs) + def delete_all_shells(self, *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. + """ + return PyMenu(self.service, "/mesh/modify_zones/delete_all_shells").execute(*args, **kwargs) + def delete_cell_zone(self, *args, **kwargs): + """ + Delete a cell thread. + """ + return PyMenu(self.service, "/mesh/modify_zones/delete_cell_zone").execute(*args, **kwargs) + def extrude_face_zone_delta(self, *args, **kwargs): + """ + Extrude a face thread a specified distance based on a list of deltas. + """ + return PyMenu(self.service, "/mesh/modify_zones/extrude_face_zone_delta").execute(*args, **kwargs) + def extrude_face_zone_para(self, *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). + """ + return PyMenu(self.service, "/mesh/modify_zones/extrude_face_zone_para").execute(*args, **kwargs) + def fuse_face_zones(self, *args, **kwargs): + """ + Attempt to fuse zones by removing duplicate faces and nodes. + """ + return PyMenu(self.service, "/mesh/modify_zones/fuse_face_zones").execute(*args, **kwargs) + def list_zones(self, *args, **kwargs): + """ + List zone IDs, types, kinds, and names. + """ + return PyMenu(self.service, "/mesh/modify_zones/list_zones").execute(*args, **kwargs) + def make_periodic(self, *args, **kwargs): + """ + Attempt to establish periodic/shadow face zone connectivity. + """ + return PyMenu(self.service, "/mesh/modify_zones/make_periodic").execute(*args, **kwargs) + def create_periodic_interface(self, *args, **kwargs): + """ + Create a conformal or non-conformal periodic interface. + """ + return PyMenu(self.service, "/mesh/modify_zones/create_periodic_interface").execute(*args, **kwargs) + def scale_zone(self, *args, **kwargs): + """ + Scale nodal coordinates of input cell zones. + """ + return PyMenu(self.service, "/mesh/modify_zones/scale_zone").execute(*args, **kwargs) + def rotate_zone(self, *args, **kwargs): + """ + Rotate nodal coordinates of input cell zones. + """ + return PyMenu(self.service, "/mesh/modify_zones/rotate_zone").execute(*args, **kwargs) + def translate_zone(self, *args, **kwargs): + """ + Translate nodal coordinates of input cell zones. + """ + return PyMenu(self.service, "/mesh/modify_zones/translate_zone").execute(*args, **kwargs) + def matching_tolerance(self, *args, **kwargs): + """ + Set the normalized tolerance used for finding coincident nodes. + """ + return PyMenu(self.service, "/mesh/modify_zones/matching_tolerance").execute(*args, **kwargs) + def merge_zones(self, *args, **kwargs): + """ + Merge zones of the same type and condition into one. + """ + return PyMenu(self.service, "/mesh/modify_zones/merge_zones").execute(*args, **kwargs) + def mrf_to_sliding_mesh(self, *args, **kwargs): + """ + Change motion specification from MRF to moving mesh. + """ + return PyMenu(self.service, "/mesh/modify_zones/mrf_to_sliding_mesh").execute(*args, **kwargs) + def convert_all_solid_mrf_to_solid_motion(self, *args, **kwargs): + """ + Change all solid zones motion specification from MRF to solid motion. + """ + return PyMenu(self.service, "/mesh/modify_zones/convert_all_solid_mrf_to_solid_motion").execute(*args, **kwargs) + def orient_face_zone(self, *args, **kwargs): + """ + Orient the face zone. + """ + return PyMenu(self.service, "/mesh/modify_zones/orient_face_zone").execute(*args, **kwargs) + def replace_zone(self, *args, **kwargs): + """ + Replace a cell zone. + """ + return PyMenu(self.service, "/mesh/modify_zones/replace_zone").execute(*args, **kwargs) + def sep_cell_zone_mark(self, *args, **kwargs): + """ + Separate a cell zone based on cell marking. + """ + return PyMenu(self.service, "/mesh/modify_zones/sep_cell_zone_mark").execute(*args, **kwargs) + def sep_cell_zone_region(self, *args, **kwargs): + """ + Separate a cell zone based on contiguous regions. + """ + return PyMenu(self.service, "/mesh/modify_zones/sep_cell_zone_region").execute(*args, **kwargs) + def sep_face_zone_angle(self, *args, **kwargs): + """ + Separate a face zone based on significant angle. + """ + return PyMenu(self.service, "/mesh/modify_zones/sep_face_zone_angle").execute(*args, **kwargs) + def sep_face_zone_face(self, *args, **kwargs): + """ + Separate each face in a zone into unique zone. + """ + return PyMenu(self.service, "/mesh/modify_zones/sep_face_zone_face").execute(*args, **kwargs) + def sep_face_zone_mark(self, *args, **kwargs): + """ + Separate a face zone based on cell marking. + """ + return PyMenu(self.service, "/mesh/modify_zones/sep_face_zone_mark").execute(*args, **kwargs) + def sep_face_zone_region(self, *args, **kwargs): + """ + Separate a face zone based on contiguous regions. + """ + return PyMenu(self.service, "/mesh/modify_zones/sep_face_zone_region").execute(*args, **kwargs) + def slit_periodic(self, *args, **kwargs): + """ + Slit a periodic zone into two symmetry zones. + """ + return PyMenu(self.service, "/mesh/modify_zones/slit_periodic").execute(*args, **kwargs) + def slit_face_zone(self, *args, **kwargs): + """ + Slit a two-sided wall into two connected wall zones. + """ + return PyMenu(self.service, "/mesh/modify_zones/slit_face_zone").execute(*args, **kwargs) + def slit_interior_between_diff_solids(self, *args, **kwargs): + """ + Slit interior created between different solids into coupled walls. + """ + return PyMenu(self.service, "/mesh/modify_zones/slit_interior_between_diff_solids").execute(*args, **kwargs) + def zone_name(self, *args, **kwargs): + """ + Give a zone a new name. + """ + return PyMenu(self.service, "/mesh/modify_zones/zone_name").execute(*args, **kwargs) + def zone_type(self, *args, **kwargs): + """ + Set a zone's type. + """ + return PyMenu(self.service, "/mesh/modify_zones/zone_type").execute(*args, **kwargs) + def copy_mrf_to_mesh_motion(self, *args, **kwargs): + """ + Copy motion variable values for origin, axis and velocities from Frame Motion to Mesh Motion. + """ + return PyMenu(self.service, "/mesh/modify_zones/copy_mrf_to_mesh_motion").execute(*args, **kwargs) + def copy_mesh_to_mrf_motion(self, *args, **kwargs): + """ + Copy motion variable values for origin, axis and velocities from Mesh Motion to Frame Motion. + """ + return PyMenu(self.service, "/mesh/modify_zones/copy_mesh_to_mrf_motion").execute(*args, **kwargs) + def change_zone_state(self, *args, **kwargs): + """ + Change the realgas material state for a zone. + """ + return PyMenu(self.service, "/mesh/modify_zones/change_zone_state").execute(*args, **kwargs) + def change_zone_phase(self, *args, **kwargs): + """ + Change the realgas phase for a zone. + """ + return PyMenu(self.service, "/mesh/modify_zones/change_zone_phase").execute(*args, **kwargs) - class track_single_particle_stream(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.enabled = self.__class__.enabled(path + [("enabled", None)], service) - self.stream_id = self.__class__.stream_id(path + [("stream_id", None)], service) + class polyhedra(TUIMenu): + """ + Enters the polyhedra menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.options = self.__class__.options(path + [("options", None)], service) + super().__init__(path, service) + def convert_domain(self, *args, **kwargs): + """ + Converts the entire domain to polyhedra cells. + """ + return PyMenu(self.service, "/mesh/polyhedra/convert_domain").execute(*args, **kwargs) + def convert_hanging_nodes(self, *args, **kwargs): + """ + Converts cells with hanging nodes/edges to polyhedra. + """ + return PyMenu(self.service, "/mesh/polyhedra/convert_hanging_nodes").execute(*args, **kwargs) + def convert_hanging_nodes_zones(self, *args, **kwargs): + """ + Convert selected cell zones with hanging nodes and faces to polyhedra. + The selected cell zones cannot be connected to other zones. + """ + return PyMenu(self.service, "/mesh/polyhedra/convert_hanging_nodes_zones").execute(*args, **kwargs) + def convert_skewed_cells(self, *args, **kwargs): + """ + Converts skewed cells to polyhedra. + """ + return PyMenu(self.service, "/mesh/polyhedra/convert_skewed_cells").execute(*args, **kwargs) - class enabled(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class options(TUIMenu): + """ + Enters the polyhedra options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def migrate_and_reorder(self, *args, **kwargs): + """ + Enables / disables the migration of newly created partitions to the compute-nodes and the reordering of the domain as part of polyhedra conversion. This is disabled by default, because it requires significant additional memory; when disabled, it is recommended that you save the case file after conversion, read it in a new Fluent session (so that the new / stored partitions become active), and then manually reorder using the mesh/reorder/reorder-domain text command. If you want to run the calculation in the current Fluent session you can enable the migrate-and-reorder? text command prior to conversion, but you must ensure that no more than half of the available memory of your system is currently used. + """ + return PyMenu(self.service, "/mesh/polyhedra/options/migrate_and_reorder").execute(*args, **kwargs) + def preserve_boundary_layer(self, *args, **kwargs): + """ + Specifies whether boundary layer cells will be preserved when the domain is converted to polyhedra. When the value is set to 0 (default) ANSYS Fluent checks for high aspect ratio cells at the boundary layer and if any are found, Fluent asks if you want to preserve the boundary layer. When the value is set to 1, the boundary layer cells are never preserved; when it is set to 2, the boundary layer cells are always preserved (regardless of the aspect ratio of the boundary layer cells). + """ + return PyMenu(self.service, "/mesh/polyhedra/options/preserve_boundary_layer").execute(*args, **kwargs) + def preserve_interior_zones(self, *args, **kwargs): + """ + Enables the preservation of surfaces (that is, manifold zones of type interior) during the conversion of the domain to polyhedra. Note that only those zones with a name that includes the string you specify will be preserved. + """ + return PyMenu(self.service, "/mesh/polyhedra/options/preserve_interior_zones").execute(*args, **kwargs) - class stream_id(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class reorder(TUIMenu): + """ + Reorders domain menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def band_width(self, *args, **kwargs): + """ + Prints cell bandwidth. + """ + return PyMenu(self.service, "/mesh/reorder/band_width").execute(*args, **kwargs) + def reorder_domain(self, *args, **kwargs): + """ + Reorders cells and faces using the reverse Cuthill-McKee algorithm. Note that you must save a new case file (and a data file, if data exists) after reordering with this text command, as well as recreate any ray files and/or surface cluster information. + """ + return PyMenu(self.service, "/mesh/reorder/reorder_domain").execute(*args, **kwargs) + def reorder_zones(self, *args, **kwargs): + """ + Reorders zones by partition, type, and ID. + """ + return PyMenu(self.service, "/mesh/reorder/reorder_zones").execute(*args, **kwargs) - class skip(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class repair_improve(TUIMenu): + """ + Enter the repair and improve quality menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def report_poor_elements(self, *args, **kwargs): + """ + Reports invalid and poor quality elements. + """ + return PyMenu(self.service, "/mesh/repair_improve/report_poor_elements").execute(*args, **kwargs) + def improve_quality(self, *args, **kwargs): + """ + Improves poor quality cells in the mesh, if possible. + """ + return PyMenu(self.service, "/mesh/repair_improve/improve_quality").execute(*args, **kwargs) + def repair(self, *args, **kwargs): + """ + Repairs mesh problems identified by the mesh check, if possible. The repairs include fixing cells that have the wrong node order, the wrong face handedness, faces that are small or nonexistent, or very poor quality. Only interior nodes are repositioned by default; boundary nodes may be repositioned if the mesh/repair-improve/allow-repair-at-boundaries text command is enabled. Note that highly skewed cells may be converted into polyhedra, depending on whether the mesh/repair-improve/include-local-polyhedra-conversion-in-repair text command is enabled. + """ + return PyMenu(self.service, "/mesh/repair_improve/repair").execute(*args, **kwargs) + def repair_face_handedness(self, *args, **kwargs): + """ + Modifies cell centroids to repair meshes that contain left-handed faces without face node order problems. + """ + return PyMenu(self.service, "/mesh/repair_improve/repair_face_handedness").execute(*args, **kwargs) + def repair_face_node_order(self, *args, **kwargs): + """ + Modifies face nodes to repair faces with improper face node order and, therefore, eliminates any resulting left-handed faces. + """ + return PyMenu(self.service, "/mesh/repair_improve/repair_face_node_order").execute(*args, **kwargs) + def repair_periodic(self, *args, **kwargs): + """ + Modifies the mesh to enforce a rotational angle or translational distance for periodic boundaries. For translationally periodic boundaries, the command computes an average translation distance and adjusts the node coordinates on the shadow face zone to match this distance. For rotationally periodic boundaries, the command prompts for an angle and adjusts the node coordinates on the shadow face zone using this angle and the defined rotational axis for the cell zone. + """ + return PyMenu(self.service, "/mesh/repair_improve/repair_periodic").execute(*args, **kwargs) + def repair_wall_distance(self, *args, **kwargs): + """ + Corrects wall distance at very high aspect ratio hexahedral/polyhedral cells. + """ + return PyMenu(self.service, "/mesh/repair_improve/repair_wall_distance").execute(*args, **kwargs) + def allow_repair_at_boundaries(self, *args, **kwargs): + """ + Allows the adjustment of the positions of nodes on boundaries as part of the mesh repairs performed by the mesh/repair-improve/repair text command. + """ + return PyMenu(self.service, "/mesh/repair_improve/allow_repair_at_boundaries").execute(*args, **kwargs) + def include_local_polyhedra_conversion_in_repair(self, *args, **kwargs): + """ + Enables/disables the local conversion of degenerate cells into polyhedra based on skewness criteria as part of the mesh repairs performed by the mesh/repair-improve/repair text command. + """ + return PyMenu(self.service, "/mesh/repair_improve/include_local_polyhedra_conversion_in_repair").execute(*args, **kwargs) - class coarsen(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class surface_mesh(TUIMenu): + """ + Enters the Surface Mesh menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def delete(self, *args, **kwargs): + """ + Deletes surface mesh. + """ + return PyMenu(self.service, "/mesh/surface_mesh/delete").execute(*args, **kwargs) + def display(self, *args, **kwargs): + """ + Displays surface meshes. + """ + return PyMenu(self.service, "/mesh/surface_mesh/display").execute(*args, **kwargs) + def read(self, *args, **kwargs): + """ + Reads surface meshes. + """ + return PyMenu(self.service, "/mesh/surface_mesh/read").execute(*args, **kwargs) - class field(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class parameters__and__customization(TUIMenu): + """ + Enter Parameters and custom menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.parameters = self.__class__.parameters(path + [("parameters", None)], service) + self.user_defined = self.__class__.user_defined(path + [("user_defined", None)], service) + super().__init__(path, service) - class injections_list(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class parameters(TUIMenu): + """ + Enter the parameters menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.input_parameters = self.__class__.input_parameters(path + [("input_parameters", None)], service) + self.output_parameters = self.__class__.output_parameters(path + [("output_parameters", None)], service) + self.list_parameters = self.__class__.list_parameters(path + [("list_parameters", None)], service) + super().__init__(path, service) + def enable_in_TUI(self, *args, **kwargs): + """ + Enable/disable parameters in the text user interface. + """ + return PyMenu(self.service, "/parameters__and__customization/parameters/enable_in_TUI").execute(*args, **kwargs) - class free_stream_particles(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class input_parameters(TUIMenu): + """ + Enter the input-parameters menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.advance = self.__class__.advance(path + [("advance", None)], service) + super().__init__(path, service) + def edit(self, *args, **kwargs): + """ + Edit an input parameter. + """ + return PyMenu(self.service, "/parameters__and__customization/parameters/input_parameters/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Delete an input parameter. + """ + return PyMenu(self.service, "/parameters__and__customization/parameters/input_parameters/delete").execute(*args, **kwargs) - class wall_film_particles(metaclass=PyMenuMeta): + class advance(TUIMenu): + """ + Define custom variable to use input parameter. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def use_in(self, *args, **kwargs): """ + Use input parameter in solver-udf or in scheme-procedure. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class track_pdf_particles(metaclass=PyMenuMeta): + return PyMenu(self.service, "/parameters__and__customization/parameters/input_parameters/advance/use_in").execute(*args, **kwargs) + def list(self, *args, **kwargs): """ + List of custom-input-parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class color_map(metaclass=PyMenuMeta): + return PyMenu(self.service, "/parameters__and__customization/parameters/input_parameters/advance/list").execute(*args, **kwargs) + def delete(self, *args, **kwargs): """ + Delete selected custom-input-parameters. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.visible = self.__class__.visible(path + [("visible", None)], service) - self.size = self.__class__.size(path + [("size", None)], service) - self.color = self.__class__.color(path + [("color", None)], service) - self.log_scale = self.__class__.log_scale(path + [("log_scale", None)], service) - self.format = self.__class__.format(path + [("format", None)], service) - self.user_skip = self.__class__.user_skip(path + [("user_skip", None)], service) - self.show_all = self.__class__.show_all(path + [("show_all", None)], service) - self.position = self.__class__.position(path + [("position", None)], service) - self.font_name = self.__class__.font_name(path + [("font_name", None)], service) - self.font_automatic = self.__class__.font_automatic(path + [("font_automatic", None)], service) - self.font_size = self.__class__.font_size(path + [("font_size", None)], service) - self.length = self.__class__.length(path + [("length", None)], service) - self.width = self.__class__.width(path + [("width", None)], service) - - class visible(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/parameters__and__customization/parameters/input_parameters/advance/delete").execute(*args, **kwargs) - class size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class output_parameters(TUIMenu): + """ + Enter the output-parameters menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def create(self, *args, **kwargs): + """ + Create an output parameter. + """ + return PyMenu(self.service, "/parameters__and__customization/parameters/output_parameters/create").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edit an output parameter. + """ + return PyMenu(self.service, "/parameters__and__customization/parameters/output_parameters/edit").execute(*args, **kwargs) + def rename(self, *args, **kwargs): + """ + Rename an output parameter. + """ + return PyMenu(self.service, "/parameters__and__customization/parameters/output_parameters/rename").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Delete an output parameter. + """ + return PyMenu(self.service, "/parameters__and__customization/parameters/output_parameters/delete").execute(*args, **kwargs) + def print_to_console(self, *args, **kwargs): + """ + Print parameter value to console. + """ + return PyMenu(self.service, "/parameters__and__customization/parameters/output_parameters/print_to_console").execute(*args, **kwargs) + def print_all_to_console(self, *args, **kwargs): + """ + Print all parameter values to console. + """ + return PyMenu(self.service, "/parameters__and__customization/parameters/output_parameters/print_all_to_console").execute(*args, **kwargs) + def write_to_file(self, *args, **kwargs): + """ + Write parameter value to file. + """ + return PyMenu(self.service, "/parameters__and__customization/parameters/output_parameters/write_to_file").execute(*args, **kwargs) + def write_all_to_file(self, *args, **kwargs): + """ + Write all parameter values to file. + """ + return PyMenu(self.service, "/parameters__and__customization/parameters/output_parameters/write_all_to_file").execute(*args, **kwargs) - class color(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class list_parameters(TUIMenu): + """ + Enter list-param menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def input_parameters(self, *args, **kwargs): + """ + List all input parameters. + """ + return PyMenu(self.service, "/parameters__and__customization/parameters/list_parameters/input_parameters").execute(*args, **kwargs) + def output_parameters(self, *args, **kwargs): + """ + List all output parameters. + """ + return PyMenu(self.service, "/parameters__and__customization/parameters/list_parameters/output_parameters").execute(*args, **kwargs) - class log_scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class user_defined(TUIMenu): + """ + Enter the user-defined functions and scalars menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.real_gas_models = self.__class__.real_gas_models(path + [("real_gas_models", None)], service) + super().__init__(path, service) + def auto_compile_compiled_udfs(self, *args, **kwargs): + """ + For this Fluent session, specify whether to allow auto-compilation of compiled UDF when a case file (or settings file) is read. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/auto_compile_compiled_udfs").execute(*args, **kwargs) + def compiled_functions(self, *args, **kwargs): + """ + Open user-defined function library. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/compiled_functions").execute(*args, **kwargs) + def use_built_in_compiler(self, *args, **kwargs): + """ + Enable/disable the use of the built-in compiler. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/use_built_in_compiler").execute(*args, **kwargs) + def interpreted_functions(self, *args, **kwargs): + """ + Load interpreted user-defined functions. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/interpreted_functions").execute(*args, **kwargs) + def function_hooks(self, *args, **kwargs): + """ + Hook up user-defined functions. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/function_hooks").execute(*args, **kwargs) + def execute_on_demand(self, *args, **kwargs): + """ + Execute UDFs on demand. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/execute_on_demand").execute(*args, **kwargs) + def user_defined_memory(self, *args, **kwargs): + """ + Allocate user-defined memory. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/user_defined_memory").execute(*args, **kwargs) + def user_defined_node_memory(self, *args, **kwargs): + """ + Allocate user-defined node memory. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/user_defined_node_memory").execute(*args, **kwargs) + def use_contributed_cpp(self, *args, **kwargs): + """ + Enable/disable use of cpp from the Fluent.Inc/contrib directory. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/use_contributed_cpp").execute(*args, **kwargs) + def fan_model(self, *args, **kwargs): + """ + Configure user-defined fan model. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/fan_model").execute(*args, **kwargs) + def one_D_coupling(self, *args, **kwargs): + """ + Load 1D library. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/one_D_coupling").execute(*args, **kwargs) + def user_defined_scalars(self, *args, **kwargs): + """ + Define user-defined scalars. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/user_defined_scalars").execute(*args, **kwargs) + def enable_udf_on_gpu(self, *args, **kwargs): + """ + Compile UDFs with OpenCL support. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/enable_udf_on_gpu").execute(*args, **kwargs) + def compile_customized_addon_module(self, *args, **kwargs): + """ + Compile customized addon module?. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/compile_customized_addon_module").execute(*args, **kwargs) - class format(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class real_gas_models(TUIMenu): + """ + Enable/configure real gas model. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def nist_real_gas_model(self, *args, **kwargs): + """ + Load NIST real gas library. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/real_gas_models/nist_real_gas_model").execute(*args, **kwargs) + def nist_multispecies_real_gas_model(self, *args, **kwargs): + """ + Load NIST real gas library. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/real_gas_models/nist_multispecies_real_gas_model").execute(*args, **kwargs) + def set_state(self, *args, **kwargs): + """ + Select state for NIST real gas model. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/real_gas_models/set_state").execute(*args, **kwargs) + def nist_settings(self, *args, **kwargs): + """ + Select refprop library. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/real_gas_models/nist_settings").execute(*args, **kwargs) + def user_defined_real_gas_model(self, *args, **kwargs): + """ + Load user-defined real gas library. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/real_gas_models/user_defined_real_gas_model").execute(*args, **kwargs) + def user_defined_multispecies_real_gas_model(self, *args, **kwargs): + """ + Load user-defined multispecies real gas library. + """ + return PyMenu(self.service, "/parameters__and__customization/user_defined/real_gas_models/user_defined_multispecies_real_gas_model").execute(*args, **kwargs) - class user_skip(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class parallel(TUIMenu): + """ + Enter the parallel processing menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.network = self.__class__.network(path + [("network", None)], service) + self.partition = self.__class__.partition(path + [("partition", None)], service) + self.set = self.__class__.set(path + [("set", None)], service) + self.load_balance = self.__class__.load_balance(path + [("load_balance", None)], service) + self.gpgpu = self.__class__.gpgpu(path + [("gpgpu", None)], service) + self.timer = self.__class__.timer(path + [("timer", None)], service) + self.multidomain = self.__class__.multidomain(path + [("multidomain", None)], service) + super().__init__(path, service) + def check(self, *args, **kwargs): + """ + Performs checks of various factors that affect parallel performance. + """ + return PyMenu(self.service, "/parallel/check").execute(*args, **kwargs) + def check_verbosity(self, *args, **kwargs): + """ + Sets verbosity output of the parallel check. Higher verbosity corresponds to more detailed information. + """ + return PyMenu(self.service, "/parallel/check_verbosity").execute(*args, **kwargs) + def show_connectivity(self, *args, **kwargs): + """ + Prints the network connectivity for the selected compute node. + """ + return PyMenu(self.service, "/parallel/show_connectivity").execute(*args, **kwargs) + def latency(self, *args, **kwargs): + """ + Shows network latency. + """ + return PyMenu(self.service, "/parallel/latency").execute(*args, **kwargs) + def bandwidth(self, *args, **kwargs): + """ + Shows network bandwidth. + """ + return PyMenu(self.service, "/parallel/bandwidth").execute(*args, **kwargs) + def thread_number_control(self, *args, **kwargs): + """ + Thread number control. + """ + return PyMenu(self.service, "/parallel/thread_number_control").execute(*args, **kwargs) - class show_all(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class network(TUIMenu): + """ + Enter the network configuration menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def kill_all_nodes(self, *args, **kwargs): + """ + Delete all compute nodes from virtual machine. + """ + return PyMenu(self.service, "/parallel/network/kill_all_nodes").execute(*args, **kwargs) + def kill_node(self, *args, **kwargs): + """ + Kill a compute node process specified by ID. + """ + return PyMenu(self.service, "/parallel/network/kill_node").execute(*args, **kwargs) + def load_hosts(self, *args, **kwargs): + """ + Read a hosts file. + """ + return PyMenu(self.service, "/parallel/network/load_hosts").execute(*args, **kwargs) + def path(self, *args, **kwargs): + """ + Set the Fluent shell script path. + """ + return PyMenu(self.service, "/parallel/network/path").execute(*args, **kwargs) + def save_hosts(self, *args, **kwargs): + """ + Write a hosts file. + """ + return PyMenu(self.service, "/parallel/network/save_hosts").execute(*args, **kwargs) + def spawn_node(self, *args, **kwargs): + """ + Spawn a compute node process on a specified machine. + """ + return PyMenu(self.service, "/parallel/network/spawn_node").execute(*args, **kwargs) - class position(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class partition(TUIMenu): + """ + Enters the partition domain menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.automatic = self.__class__.automatic(path + [("automatic", None)], service) + self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) + def combine_partition(self, *args, **kwargs): + """ + Merges every N partitions. + """ + return PyMenu(self.service, "/parallel/partition/combine_partition").execute(*args, **kwargs) + def merge_clusters(self, *args, **kwargs): + """ + Calls the optimizer that attempts to decrease the number of interfaces by eliminating orphan cell clusters. (An orphan cluster is a group of connected cells such that each member has at least one face that is part of an interface boundary.) + """ + return PyMenu(self.service, "/parallel/partition/merge_clusters").execute(*args, **kwargs) + def method(self, *args, **kwargs): + """ + Sets the partition method. + """ + return PyMenu(self.service, "/parallel/partition/method").execute(*args, **kwargs) + def print_partitions(self, *args, **kwargs): + """ + Print partition information. + """ + return PyMenu(self.service, "/parallel/partition/print_partitions").execute(*args, **kwargs) + def print_active_partitions(self, *args, **kwargs): + """ + Prints active partition information (parallel solver). + """ + return PyMenu(self.service, "/parallel/partition/print_active_partitions").execute(*args, **kwargs) + def print_stored_partitions(self, *args, **kwargs): + """ + Prints stored partition information (parallel solver). + """ + return PyMenu(self.service, "/parallel/partition/print_stored_partitions").execute(*args, **kwargs) + def reorder_partitions(self, *args, **kwargs): + """ + Reorders partitions. + """ + return PyMenu(self.service, "/parallel/partition/reorder_partitions").execute(*args, **kwargs) + def reorder_partitions_to_architecture(self, *args, **kwargs): + """ + Reorders partitions to architecture. + """ + return PyMenu(self.service, "/parallel/partition/reorder_partitions_to_architecture").execute(*args, **kwargs) + def smooth_partition(self, *args, **kwargs): + """ + Calls the optimizer that attempts to minimize the number of interfaces by modifying the partition boundaries to reduce surface area. + """ + return PyMenu(self.service, "/parallel/partition/smooth_partition").execute(*args, **kwargs) + def use_stored_partitions(self, *args, **kwargs): + """ + Uses this partitioning. + """ + return PyMenu(self.service, "/parallel/partition/use_stored_partitions").execute(*args, **kwargs) - class font_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class automatic(TUIMenu): + """ + Enter the menu to set auto partition parameters. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def across_zones(self, *args, **kwargs): + """ + Enable auto partitioning by zone or by domain. + """ + return PyMenu(self.service, "/parallel/partition/automatic/across_zones").execute(*args, **kwargs) + def method(self, *args, **kwargs): + """ + Set the method for auto partitioning the domain. + """ + return PyMenu(self.service, "/parallel/partition/automatic/method").execute(*args, **kwargs) + def load_vector(self, *args, **kwargs): + """ + Set auto the partition load vector. + """ + return PyMenu(self.service, "/parallel/partition/automatic/load_vector").execute(*args, **kwargs) + def pre_test(self, *args, **kwargs): + """ + Set auto partition pre-testing optimization. + """ + return PyMenu(self.service, "/parallel/partition/automatic/pre_test").execute(*args, **kwargs) + def use_case_file_method(self, *args, **kwargs): + """ + Enable the use-case-file method for auto partitioning. + """ + return PyMenu(self.service, "/parallel/partition/automatic/use_case_file_method").execute(*args, **kwargs) - class font_automatic(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class set(TUIMenu): + """ + Enters the set partition parameters menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def across_zones(self, *args, **kwargs): + """ + Allows partitions to cross zone boundaries (the default). If turned off, it will restrict partitioning to within each cell zone. This is recommended only when cells in different zones require significantly different amounts of computation during the solution phase; for example, if the domain contains both solid and fluid zones. + """ + return PyMenu(self.service, "/parallel/partition/set/across_zones").execute(*args, **kwargs) + def all_off(self, *args, **kwargs): + """ + Disables all optimizations. + """ + return PyMenu(self.service, "/parallel/partition/set/all_off").execute(*args, **kwargs) + def all_on(self, *args, **kwargs): + """ + Enables all optimizations. + """ + return PyMenu(self.service, "/parallel/partition/set/all_on").execute(*args, **kwargs) + def cell_function(self, *args, **kwargs): + """ + Sets cell function. + """ + return PyMenu(self.service, "/parallel/partition/set/cell_function").execute(*args, **kwargs) + def load_distribution(self, *args, **kwargs): + """ + Sets the number of cells desired for each partition. This is useful, for example, when computing on multiple machines with significantly different performance characteristics. If left unset, each partition will contain an approximately equal number of cells. Normalized relative values may be used for the entries. + """ + return PyMenu(self.service, "/parallel/partition/set/load_distribution").execute(*args, **kwargs) + def merge(self, *args, **kwargs): + """ + Toggles the optimizer that attempts to decrease the number of interfaces by eliminating orphan cell clusters. + """ + return PyMenu(self.service, "/parallel/partition/set/merge").execute(*args, **kwargs) + def origin(self, *args, **kwargs): + """ + Sets the , , and coordinate of the origin used by those partitioning functions that require a radial distance. By default, the origin is set to (0, 0, 0). + """ + return PyMenu(self.service, "/parallel/partition/set/origin").execute(*args, **kwargs) + def pre_test(self, *args, **kwargs): + """ + Enables the operation that determines the best coordinate-splitting direction. + """ + return PyMenu(self.service, "/parallel/partition/set/pre_test").execute(*args, **kwargs) + def smooth(self, *args, **kwargs): + """ + Toggles the optimizer that attempts to minimize the number of interfaces by modifying the partition boundaries to reduce surface area. + """ + return PyMenu(self.service, "/parallel/partition/set/smooth").execute(*args, **kwargs) + def laplace_smoothing(self, *args, **kwargs): + """ + Laplace smoothing for mesh with stretched cells. + """ + return PyMenu(self.service, "/parallel/partition/set/laplace_smoothing").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Controls the amount of information that is printed out during partitioning. If set to 1 (the default), a text character. is displayed during each bisection, and partition statistics are displayed once the partitioning completes. If set to 2, additional information about the bisection operation is displayed during each bisection. If set to 0, partition statistics and information during each bisection are not displayed. + """ + return PyMenu(self.service, "/parallel/partition/set/verbosity").execute(*args, **kwargs) + def nfaces_as_weights(self, *args, **kwargs): + """ + Uses number of faces as weights. + """ + return PyMenu(self.service, "/parallel/partition/set/nfaces_as_weights").execute(*args, **kwargs) + def face_area_as_weights(self, *args, **kwargs): + """ + Uses face area as connection weights. + """ + return PyMenu(self.service, "/parallel/partition/set/face_area_as_weights").execute(*args, **kwargs) + def stretched_mesh_enhancement(self, *args, **kwargs): + """ + Enhancement for mesh with stretched cells. + """ + return PyMenu(self.service, "/parallel/partition/set/stretched_mesh_enhancement").execute(*args, **kwargs) + def layering(self, *args, **kwargs): + """ + Use layering for partitioning. + """ + return PyMenu(self.service, "/parallel/partition/set/layering").execute(*args, **kwargs) + def solid_thread_weight(self, *args, **kwargs): + """ + Uses solid thread weights. + """ + return PyMenu(self.service, "/parallel/partition/set/solid_thread_weight").execute(*args, **kwargs) + def particle_weight(self, *args, **kwargs): + """ + Sets DPM particle weight. + """ + return PyMenu(self.service, "/parallel/partition/set/particle_weight").execute(*args, **kwargs) + def vof_free_surface_weight(self, *args, **kwargs): + """ + Sets VOF free surface weight. + """ + return PyMenu(self.service, "/parallel/partition/set/vof_free_surface_weight").execute(*args, **kwargs) + def isat_weight(self, *args, **kwargs): + """ + Sets ISAT weight. + """ + return PyMenu(self.service, "/parallel/partition/set/isat_weight").execute(*args, **kwargs) + def model_weighted_partition(self, *args, **kwargs): + """ + Enables / disables model-weighted partitioning. This option works with the METIS partitioning method, and specifies that Fluent automatically calculates the weighting based on the cell count and the models and attributes specified as weights (using the parallel/partition/set/isat-weight text command, for example). + """ + return PyMenu(self.service, "/parallel/partition/set/model_weighted_partition").execute(*args, **kwargs) + def fluid_solid_rebalance_after_read_case(self, *args, **kwargs): + """ + Use optimal repartitioning after reading case file with significant solid and fluid zones. + """ + return PyMenu(self.service, "/parallel/partition/set/fluid_solid_rebalance_after_read_case").execute(*args, **kwargs) + def dpm_load_balancing(self, *args, **kwargs): + """ + Enables / disables dynamic load balancing for discrete phase model cases that use a second domain for DPM particle tracking (that is, cases for which you have enabled the define/models/dpm/parallel/hybrid-2domain? text command). + """ + return PyMenu(self.service, "/parallel/partition/set/dpm_load_balancing").execute(*args, **kwargs) - class font_size(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class set(TUIMenu): + """ + Enters the set parallel parameters menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def partition_mask(self, *args, **kwargs): + """ + Sets partition mask. + """ + return PyMenu(self.service, "/parallel/set/partition_mask").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Sets the parallel verbosity. + """ + return PyMenu(self.service, "/parallel/set/verbosity").execute(*args, **kwargs) + def time_out(self, *args, **kwargs): + """ + Sets spawn time-out in seconds. + """ + return PyMenu(self.service, "/parallel/set/time_out").execute(*args, **kwargs) + def fast_i(self, *args, **kwargs): + """ + Use fast I/O option. + """ + return PyMenu(self.service, "/parallel/set/fast_i").execute(*args, **kwargs) - class length(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class load_balance(TUIMenu): + """ + Enters the load balancing parameters menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def physical_models(self, *args, **kwargs): + """ + Uses physical-models load balancing? + """ + return PyMenu(self.service, "/parallel/load_balance/physical_models").execute(*args, **kwargs) + def dynamic_mesh(self, *args, **kwargs): + """ + Uses load balancing for dynamic mesh? + """ + return PyMenu(self.service, "/parallel/load_balance/dynamic_mesh").execute(*args, **kwargs) + def mesh_adaption(self, *args, **kwargs): + """ + Uses load balancing for mesh adaption? + """ + return PyMenu(self.service, "/parallel/load_balance/mesh_adaption").execute(*args, **kwargs) - class width(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class gpgpu(TUIMenu): + """ + Enters the GPGPU menu + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def show(self, *args, **kwargs): + """ + Lists the available GPGPUs. GPGPUs selected for use are indicated by the presence of an asterisk (*). + """ + return PyMenu(self.service, "/parallel/gpgpu/show").execute(*args, **kwargs) + def select(self, *args, **kwargs): + """ + Selects which GPGPUs to use for AMG acceleration + """ + return PyMenu(self.service, "/parallel/gpgpu/select").execute(*args, **kwargs) - class draw_mesh(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class timer(TUIMenu): + """ + Enters the timer menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def usage(self, *args, **kwargs): + """ + Prints performance statistics in the console window. + """ + return PyMenu(self.service, "/parallel/timer/usage").execute(*args, **kwargs) + def reset(self, *args, **kwargs): + """ + Adjusts domain timers. + """ + return PyMenu(self.service, "/parallel/timer/reset").execute(*args, **kwargs) - class mesh_object(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class multidomain(TUIMenu): + """ + Enters the multidomain architecture menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.conjugate_heat_transfer = self.__class__.conjugate_heat_transfer(path + [("conjugate_heat_transfer", None)], service) + self.solve = self.__class__.solve(path + [("solve", None)], service) + super().__init__(path, service) - class display_state_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class conjugate_heat_transfer(TUIMenu): + """ + Enters the conjugate heat transfer menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) + def enable(self, *args, **kwargs): + """ + Enables/disables loosely coupled conjugate heat transfer. This works in conjunction with the solve/set/transient-controls/solid-time-step-size text command (and thereby enables the use of a user-specified time step size for solid zones that can be larger than that used for the fluid zones) to increase the robustness of the energy equation calculation, and specifies that multidomain architecture is used within a single Fluent session to enhance the performance of the simulation. + """ + return PyMenu(self.service, "/parallel/multidomain/conjugate_heat_transfer/enable").execute(*args, **kwargs) - class scene(metaclass=PyNamedObjectMeta): + class set(TUIMenu): """ + Enters the set menu for loosely coupled conjugate heat transfer. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.name = self.__class__.name(path + [("name", None)], service) - self.title = self.__class__.title(path + [("title", None)], service) - self.temporary = self.__class__.temporary(path + [("temporary", None)], service) - self.display_state_name = self.__class__.display_state_name(path + [("display_state_name", None)], service) - - class name(metaclass=PyMenuMeta): + super().__init__(path, service) + def session_mode(self, *args, **kwargs): """ + Setup session mode (single/multiple) for multidomain conjugate heat transfer. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class title(metaclass=PyMenuMeta): + return PyMenu(self.service, "/parallel/multidomain/conjugate_heat_transfer/set/session_mode").execute(*args, **kwargs) + def coupling(self, *args, **kwargs): """ + Specifies when the fluid and solid zone calculations are coupled, either at a defined time period or number of fluid time steps. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class temporary(metaclass=PyMenuMeta): + return PyMenu(self.service, "/parallel/multidomain/conjugate_heat_transfer/set/coupling").execute(*args, **kwargs) + def helper_session(self, *args, **kwargs): """ + Setup helper session for multidomain conjugate heat transfer. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/parallel/multidomain/conjugate_heat_transfer/set/helper_session").execute(*args, **kwargs) - class display_state_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class solve(TUIMenu): + """ + Enter the multi-domain simulation solver menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def iterate(self, *args, **kwargs): + """ + Iteration the multidomain conjugate heat transfer. + """ + return PyMenu(self.service, "/parallel/multidomain/solve/iterate").execute(*args, **kwargs) + def dual_time_iterate(self, *args, **kwargs): + """ + Dual-time iterate the multidomain conjugate heat transfer. + """ + return PyMenu(self.service, "/parallel/multidomain/solve/dual_time_iterate").execute(*args, **kwargs) + + class plot(TUIMenu): + """ + Enter the XY plot menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.ansys_sound_analysis = self.__class__.ansys_sound_analysis(path + [("ansys_sound_analysis", None)], service) + self.cumulative_plot = self.__class__.cumulative_plot(path + [("cumulative_plot", None)], service) + self.flamelet_curves = self.__class__.flamelet_curves(path + [("flamelet_curves", None)], service) + super().__init__(path, service) + def circum_avg_axial(self, *args, **kwargs): + """ + Computes iso-axial band surfaces and plots data vs. axial coordinate on them. + """ + return PyMenu(self.service, "/plot/circum_avg_axial").execute(*args, **kwargs) + def circum_avg_radial(self, *args, **kwargs): + """ + Computes iso-radial band surfaces and plots data vs. radius on them. + """ + return PyMenu(self.service, "/plot/circum_avg_radial").execute(*args, **kwargs) + def change_fft_ref_pressure(self, *args, **kwargs): + """ + Changes reference acoustic pressure. + """ + return PyMenu(self.service, "/plot/change_fft_ref_pressure").execute(*args, **kwargs) + def fft(self, *args, **kwargs): + """ + Plots fast Fourier transform (FFT) of file data. If you respond yes to Acoustic Analysis?, then additional Y axis functions are made available. + """ + return PyMenu(self.service, "/plot/fft").execute(*args, **kwargs) + def fft_set(self, *args, **kwargs): + """ + Enter the menu to set histogram plot parameters. + """ + return PyMenu(self.service, "/plot/fft_set").execute(*args, **kwargs) + def file(self, *args, **kwargs): + """ + Plots data from an external file. + """ + return PyMenu(self.service, "/plot/file").execute(*args, **kwargs) + def datasources(self, *args, **kwargs): + """ + Enters the menu for creating and modifying plots containing multiple data sources. + """ + return PyMenu(self.service, "/plot/datasources").execute(*args, **kwargs) + def display_profile_data(self, *args, **kwargs): + """ + Plots profile data. + """ + return PyMenu(self.service, "/plot/display_profile_data").execute(*args, **kwargs) + def file_list(self, *args, **kwargs): + """ + Plots data from multiple external files. + """ + return PyMenu(self.service, "/plot/file_list").execute(*args, **kwargs) + def file_set(self, *args, **kwargs): + """ + Sets file plot parameters. + """ + return PyMenu(self.service, "/plot/file_set").execute(*args, **kwargs) + def histogram(self, *args, **kwargs): + """ + Plots a histogram of the specified solution variable using the defined range and number of intervals. + """ + return PyMenu(self.service, "/plot/histogram").execute(*args, **kwargs) + def histogram_set(self, *args, **kwargs): + """ + Sets histogram plot parameters. Sub-menu items are the same as file-set/ above. + """ + return PyMenu(self.service, "/plot/histogram_set").execute(*args, **kwargs) + def plot(self, *args, **kwargs): + """ + Plots solution on surfaces. + """ + return PyMenu(self.service, "/plot/plot").execute(*args, **kwargs) + def plot_direction(self, *args, **kwargs): + """ + Sets plot direction for XY plot. + """ + return PyMenu(self.service, "/plot/plot_direction").execute(*args, **kwargs) + def residuals(self, *args, **kwargs): + """ + Contains commands that allow you to select the variables for which you want to display XY plots of residual histories in the active graphics window. + """ + return PyMenu(self.service, "/plot/residuals").execute(*args, **kwargs) + def residuals_set(self, *args, **kwargs): + """ + Sets residual plot parameters. Sub-menu items are the same as file-set/ above. + """ + return PyMenu(self.service, "/plot/residuals_set").execute(*args, **kwargs) + def solution(self, *args, **kwargs): + """ + Plots solution on surfaces and/or zones. Zone and surface names can be indicated using a wildcard (*). + """ + return PyMenu(self.service, "/plot/solution").execute(*args, **kwargs) + def solution_set(self, *args, **kwargs): + """ + Sets solution plot parameters. Sub-menu items are the same as file-set/ above. + """ + return PyMenu(self.service, "/plot/solution_set").execute(*args, **kwargs) + def set_boundary_val_off(self, *args, **kwargs): + """ + Disables the use of boundary face values when node values are disabled in solution XY plots. This option is disabled by default, that is, boundary face values are used when node values are disabled. + """ + return PyMenu(self.service, "/plot/set_boundary_val_off").execute(*args, **kwargs) + def label_alignment(self, *args, **kwargs): + """ + Set the orientation of XY plot axis labels as either horizontal or axis-aligned. + """ + return PyMenu(self.service, "/plot/label_alignment").execute(*args, **kwargs) + + class ansys_sound_analysis(TUIMenu): + """ + Enter the Ansys sound analysis menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def write_files(self, *args, **kwargs): + """ + Read in a pressure signal or spectrum file, then optionally read in a frequency response function (FRF) or transfer function file, before writing a WAV, output pressure, and/or acoustic indicators file. + """ + return PyMenu(self.service, "/plot/ansys_sound_analysis/write_files").execute(*args, **kwargs) + def print_indicators(self, *args, **kwargs): + """ + Read in a pressure signal or spectrum file, then optionally read in a frequency response function (FRF) or transfer function file, before printing the acoustics indicators. + """ + return PyMenu(self.service, "/plot/ansys_sound_analysis/print_indicators").execute(*args, **kwargs) + + class cumulative_plot(TUIMenu): + """ + Plot the development of force, force coefficient, moment, or moment coefficient across the specified wall zones. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add(self, *args, **kwargs): + """ + Create a new cumulative plot. + """ + return PyMenu(self.service, "/plot/cumulative_plot/add").execute(*args, **kwargs) + def axes(self, *args, **kwargs): + """ + Set axes options of an object. + """ + return PyMenu(self.service, "/plot/cumulative_plot/axes").execute(*args, **kwargs) + def curves(self, *args, **kwargs): + """ + Set curves options of an object. + """ + return PyMenu(self.service, "/plot/cumulative_plot/curves").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edit an existing cumulative plot object. + """ + return PyMenu(self.service, "/plot/cumulative_plot/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Delete an existing cumulative plot object. + """ + return PyMenu(self.service, "/plot/cumulative_plot/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Print the names of the existing cumulative plot objects to the console. + """ + return PyMenu(self.service, "/plot/cumulative_plot/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + Print the properties of the specified cumulative plot object to the console. + """ + return PyMenu(self.service, "/plot/cumulative_plot/list_properties").execute(*args, **kwargs) + def plot(self, *args, **kwargs): + """ + Plot a cumulative plot in the graphics window. + """ + return PyMenu(self.service, "/plot/cumulative_plot/plot").execute(*args, **kwargs) + def print(self, *args, **kwargs): + """ + Print the value of a cumulative plot to the console. + """ + return PyMenu(self.service, "/plot/cumulative_plot/print").execute(*args, **kwargs) + def write(self, *args, **kwargs): + """ + Write a cumulative plot to a file. + """ + return PyMenu(self.service, "/plot/cumulative_plot/write").execute(*args, **kwargs) + + class flamelet_curves(TUIMenu): + """ + Enters the flamelet curves menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def write_to_file(self, *args, **kwargs): + """ + Writes curve to a file instead of plot. + """ + return PyMenu(self.service, "/plot/flamelet_curves/write_to_file").execute(*args, **kwargs) + def plot_curves(self, *args, **kwargs): + """ + Plots of a curve property. + """ + return PyMenu(self.service, "/plot/flamelet_curves/plot_curves").execute(*args, **kwargs) + + class preferences(TUIMenu): + """ + Set preferences. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.appearance = self.__class__.appearance(path + [("appearance", None)], service) + self.general = self.__class__.general(path + [("general", None)], service) + self.gpuapp = self.__class__.gpuapp(path + [("gpuapp", None)], service) + self.graphics = self.__class__.graphics(path + [("graphics", None)], service) + self.mat_pro_app = self.__class__.mat_pro_app(path + [("mat_pro_app", None)], service) + self.meshing_workflow = self.__class__.meshing_workflow(path + [("meshing_workflow", None)], service) + self.navigation = self.__class__.navigation(path + [("navigation", None)], service) + self.prj_app = self.__class__.prj_app(path + [("prj_app", None)], service) + self.simulation = self.__class__.simulation(path + [("simulation", None)], service) + self.turbo_workflow = self.__class__.turbo_workflow(path + [("turbo_workflow", None)], service) + super().__init__(path, service) + + class appearance(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.ansys_logo = self.__class__.ansys_logo(path + [("ansys_logo", None)], service) + self.charts = self.__class__.charts(path + [("charts", None)], service) + self.selections = self.__class__.selections(path + [("selections", None)], service) + super().__init__(path, service) + def application_font_size(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/application_font_size").execute(*args, **kwargs) + def axis_triad(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/axis_triad").execute(*args, **kwargs) + def color_theme(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/color_theme").execute(*args, **kwargs) + def completer(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/completer").execute(*args, **kwargs) + def custom_title_bar(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/custom_title_bar").execute(*args, **kwargs) + def default_view(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/default_view").execute(*args, **kwargs) + def graphics_background_color1(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/graphics_background_color1").execute(*args, **kwargs) + def graphics_background_color2(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/graphics_background_color2").execute(*args, **kwargs) + def graphics_background_style(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/graphics_background_style").execute(*args, **kwargs) + def graphics_color_theme(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/graphics_color_theme").execute(*args, **kwargs) + def graphics_default_manual_face_color(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/graphics_default_manual_face_color").execute(*args, **kwargs) + def graphics_default_manual_node_color(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/graphics_default_manual_node_color").execute(*args, **kwargs) + def graphics_edge_color(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/graphics_edge_color").execute(*args, **kwargs) + def graphics_foreground_color(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/graphics_foreground_color").execute(*args, **kwargs) + def graphics_partition_boundary_color(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/graphics_partition_boundary_color").execute(*args, **kwargs) + def graphics_surface_color(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/graphics_surface_color").execute(*args, **kwargs) + def graphics_title_window_framecolor(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/graphics_title_window_framecolor").execute(*args, **kwargs) + def graphics_view(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/graphics_view").execute(*args, **kwargs) + def graphics_wall_face_color(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/graphics_wall_face_color").execute(*args, **kwargs) + def group_by_tree_view(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/group_by_tree_view").execute(*args, **kwargs) + def model_color_scheme(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/model_color_scheme").execute(*args, **kwargs) + def number_of_files_recently_used(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/number_of_files_recently_used").execute(*args, **kwargs) + def number_of_pastel_colors(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/number_of_pastel_colors").execute(*args, **kwargs) + def pastel_color_saturation(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/pastel_color_saturation").execute(*args, **kwargs) + def pastel_color_value(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/pastel_color_value").execute(*args, **kwargs) + def quick_property_view(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/quick_property_view").execute(*args, **kwargs) + def ruler(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/ruler").execute(*args, **kwargs) + def show_enabled_models(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/show_enabled_models").execute(*args, **kwargs) + def show_interface_children_zone(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/show_interface_children_zone").execute(*args, **kwargs) + def show_model_edges(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/show_model_edges").execute(*args, **kwargs) + def solution_mode_edge_color_in_meshing_mode(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/solution_mode_edge_color_in_meshing_mode").execute(*args, **kwargs) + def startup_page(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/startup_page").execute(*args, **kwargs) + def surface_emissivity(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/surface_emissivity").execute(*args, **kwargs) + def surface_specularity(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/surface_specularity").execute(*args, **kwargs) + def surface_specularity_for_contours(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/surface_specularity_for_contours").execute(*args, **kwargs) + def titles(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/titles").execute(*args, **kwargs) + def titles_border_offset(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/titles_border_offset").execute(*args, **kwargs) - class rendering_options(metaclass=PyMenuMeta): + class ansys_logo(TUIMenu): """ - Enter the rendering options menu. + . """ def __init__(self, path, service): self.path = path self.service = service - def auto_spin(self, *args, **kwargs): + super().__init__(path, service) + def color(self, *args, **kwargs): """ - Enable/disable mouse view rotations to continue to spin the display after the button is released. + . """ - return PyMenu(self.service, "/results/graphics/rendering_options/auto_spin").execute(*args, **kwargs) - def device_info(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/ansys_logo/color").execute(*args, **kwargs) + def visible(self, *args, **kwargs): """ - List information for the graphics device. + . """ - return PyMenu(self.service, "/results/graphics/rendering_options/device_info").execute(*args, **kwargs) - def double_buffering(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/ansys_logo/visible").execute(*args, **kwargs) + + class charts(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.font = self.__class__.font(path + [("font", None)], service) + self.text_color = self.__class__.text_color(path + [("text_color", None)], service) + super().__init__(path, service) + def curve_colors(self, *args, **kwargs): """ - Enable/disable double-buffering. + . """ - return PyMenu(self.service, "/results/graphics/rendering_options/double_buffering").execute(*args, **kwargs) - def driver(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/charts/curve_colors").execute(*args, **kwargs) + def enable_open_glfor_modern_plots(self, *args, **kwargs): """ - Change the current graphics driver. + . """ - return PyMenu(self.service, "/results/graphics/rendering_options/driver").execute(*args, **kwargs) - def hidden_surfaces(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/charts/enable_open_glfor_modern_plots").execute(*args, **kwargs) + def legend_alignment(self, *args, **kwargs): """ - Enable/disable hidden surface removal. + . """ - return PyMenu(self.service, "/results/graphics/rendering_options/hidden_surfaces").execute(*args, **kwargs) - def hidden_surface_method(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/charts/legend_alignment").execute(*args, **kwargs) + def legend_visibility(self, *args, **kwargs): """ - Specify the method to perform hidden line and hidden surface rendering. + . """ - return PyMenu(self.service, "/results/graphics/rendering_options/hidden_surface_method").execute(*args, **kwargs) - def outer_face_cull(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/charts/legend_visibility").execute(*args, **kwargs) + def modern_plots_enabled(self, *args, **kwargs): """ - Enable/disable discarding outer faces during display. + . """ - return PyMenu(self.service, "/results/graphics/rendering_options/outer_face_cull").execute(*args, **kwargs) - def surface_edge_visibility(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/charts/modern_plots_enabled").execute(*args, **kwargs) + def modern_plots_points_threshold(self, *args, **kwargs): """ - Set edge visibility flags for surfaces. + . """ - return PyMenu(self.service, "/results/graphics/rendering_options/surface_edge_visibility").execute(*args, **kwargs) - def animation_option(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/charts/modern_plots_points_threshold").execute(*args, **kwargs) + def plots_behavior(self, *args, **kwargs): """ - Using Wireframe / All option during animation. + . """ - return PyMenu(self.service, "/results/graphics/rendering_options/animation_option").execute(*args, **kwargs) - def color_map_alignment(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/charts/plots_behavior").execute(*args, **kwargs) + def print_plot_data(self, *args, **kwargs): """ - Set the color bar alignment. + . """ - return PyMenu(self.service, "/results/graphics/rendering_options/color_map_alignment").execute(*args, **kwargs) - def help_text_color(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/charts/print_plot_data").execute(*args, **kwargs) + def print_residuals_data(self, *args, **kwargs): """ - Set the color of screen help text. + . """ - return PyMenu(self.service, "/results/graphics/rendering_options/help_text_color").execute(*args, **kwargs) - def face_displacement(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/charts/print_residuals_data").execute(*args, **kwargs) + def threshold(self, *args, **kwargs): """ - Set face displacement value in Z-buffer units along the Camera Z-axis. + . """ - return PyMenu(self.service, "/results/graphics/rendering_options/face_displacement").execute(*args, **kwargs) - def set_rendering_options(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/charts/threshold").execute(*args, **kwargs) + + class font(TUIMenu): """ - Set the rendering options. + . """ - return PyMenu(self.service, "/results/graphics/rendering_options/set_rendering_options").execute(*args, **kwargs) - def show_colormap(self, *args, **kwargs): + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def axes(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/charts/font/axes").execute(*args, **kwargs) + def axes_titles(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/charts/font/axes_titles").execute(*args, **kwargs) + def legend(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/charts/font/legend").execute(*args, **kwargs) + def title(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/charts/font/title").execute(*args, **kwargs) + + class text_color(TUIMenu): """ - Enable/Disable colormap. + . """ - return PyMenu(self.service, "/results/graphics/rendering_options/show_colormap").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def axes(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/charts/text_color/axes").execute(*args, **kwargs) + def axes_titles(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/charts/text_color/axes_titles").execute(*args, **kwargs) + def legend(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/charts/text_color/legend").execute(*args, **kwargs) + def title(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/charts/text_color/title").execute(*args, **kwargs) - class update_scene(metaclass=PyMenuMeta): + class selections(TUIMenu): """ - Enter the scene options menu. + . """ def __init__(self, path, service): self.path = path self.service = service - def select_geometry(self, *args, **kwargs): + super().__init__(path, service) + def general_displacement(self, *args, **kwargs): """ - Select geometry to be updated. + . """ - return PyMenu(self.service, "/results/graphics/update_scene/select_geometry").execute(*args, **kwargs) - def overlays(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/selections/general_displacement").execute(*args, **kwargs) + def highlight_edge_color(self, *args, **kwargs): """ - Enable/disable the overlays option. + . """ - return PyMenu(self.service, "/results/graphics/update_scene/overlays").execute(*args, **kwargs) - def draw_frame(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/selections/highlight_edge_color").execute(*args, **kwargs) + def highlight_edge_weight(self, *args, **kwargs): """ - Enable/disable drawing of the bounding frame. + . """ - return PyMenu(self.service, "/results/graphics/update_scene/draw_frame").execute(*args, **kwargs) - def delete(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/selections/highlight_edge_weight").execute(*args, **kwargs) + def highlight_face_color(self, *args, **kwargs): """ - Delete selected geometries. + . """ - return PyMenu(self.service, "/results/graphics/update_scene/delete").execute(*args, **kwargs) - def display(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/selections/highlight_face_color").execute(*args, **kwargs) + def highlight_gloss(self, *args, **kwargs): """ - Display selected geometries. + . """ - return PyMenu(self.service, "/results/graphics/update_scene/display").execute(*args, **kwargs) - def transform(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/selections/highlight_gloss").execute(*args, **kwargs) + def highlight_specular_component(self, *args, **kwargs): """ - Apply transformation matrix on selected geometries. + . """ - return PyMenu(self.service, "/results/graphics/update_scene/transform").execute(*args, **kwargs) - def pathline(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/selections/highlight_specular_component").execute(*args, **kwargs) + def highlight_transparency(self, *args, **kwargs): """ - Change pathline attributes. + . """ - return PyMenu(self.service, "/results/graphics/update_scene/pathline").execute(*args, **kwargs) - def iso_sweep(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/selections/highlight_transparency").execute(*args, **kwargs) + def mouse_hover_probe_values_enabled(self, *args, **kwargs): """ - Change iso-sweep values. + . """ - return PyMenu(self.service, "/results/graphics/update_scene/iso_sweep").execute(*args, **kwargs) - def time(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/selections/mouse_hover_probe_values_enabled").execute(*args, **kwargs) + def mouse_over_highlight_enabled(self, *args, **kwargs): """ - Change time-step value. + . """ - return PyMenu(self.service, "/results/graphics/update_scene/time").execute(*args, **kwargs) - def set_frame(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/appearance/selections/mouse_over_highlight_enabled").execute(*args, **kwargs) + def probe_tooltip_hide_delay_timer(self, *args, **kwargs): """ - Change frame options. + . """ - return PyMenu(self.service, "/results/graphics/update_scene/set_frame").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/appearance/selections/probe_tooltip_hide_delay_timer").execute(*args, **kwargs) + def probe_tooltip_show_delay_timer(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/appearance/selections/probe_tooltip_show_delay_timer").execute(*args, **kwargs) - class plot(metaclass=PyMenuMeta): + class general(TUIMenu): """ - Enter the XY plot menu. + . """ def __init__(self, path, service): self.path = path self.service = service - self.ansys_sound_analysis = self.__class__.ansys_sound_analysis(path + [("ansys_sound_analysis", None)], service) - self.cumulative_plot = self.__class__.cumulative_plot(path + [("cumulative_plot", None)], service) - self.flamelet_curves = self.__class__.flamelet_curves(path + [("flamelet_curves", None)], service) - def circum_avg_axial(self, *args, **kwargs): - """ - Compute iso-axial band surfaces and plot data vs axial coordinate on them. - """ - return PyMenu(self.service, "/results/plot/circum_avg_axial").execute(*args, **kwargs) - def circum_avg_radial(self, *args, **kwargs): + super().__init__(path, service) + def advanced_partition(self, *args, **kwargs): """ - Compute iso-radial band surfaces and plot data vs radius on them. + . """ - return PyMenu(self.service, "/results/plot/circum_avg_radial").execute(*args, **kwargs) - def change_fft_ref_pressure(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/general/advanced_partition").execute(*args, **kwargs) + def automatic_transcript(self, *args, **kwargs): """ - Change acoustic reference pressure. + . """ - return PyMenu(self.service, "/results/plot/change_fft_ref_pressure").execute(*args, **kwargs) - def fft(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/general/automatic_transcript").execute(*args, **kwargs) + def default_ioformat(self, *args, **kwargs): """ - Plot FFT of file data. + . """ - return PyMenu(self.service, "/results/plot/fft").execute(*args, **kwargs) - def fft_set(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/general/default_ioformat").execute(*args, **kwargs) + def dock_editor(self, *args, **kwargs): """ - Enter the menu to set histogram plot parameters. + . """ - return PyMenu(self.service, "/results/plot/fft_set").execute(*args, **kwargs) - def file(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/general/dock_editor").execute(*args, **kwargs) + def enable_parametric_study(self, *args, **kwargs): """ - Plot data from file. + . """ - return PyMenu(self.service, "/results/plot/file").execute(*args, **kwargs) - def datasources(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/general/enable_parametric_study").execute(*args, **kwargs) + def flow_model(self, *args, **kwargs): """ - Enter the menu to set data sources. + . """ - return PyMenu(self.service, "/results/plot/datasources").execute(*args, **kwargs) - def display_profile_data(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/general/flow_model").execute(*args, **kwargs) + def idle_timeout(self, *args, **kwargs): """ - Plot profile data. + . """ - return PyMenu(self.service, "/results/plot/display_profile_data").execute(*args, **kwargs) - def file_list(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/general/idle_timeout").execute(*args, **kwargs) + def key_behavioral_changes_message(self, *args, **kwargs): """ - Plot data from multiple files. + . """ - return PyMenu(self.service, "/results/plot/file_list").execute(*args, **kwargs) - def file_set(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/general/key_behavioral_changes_message").execute(*args, **kwargs) + def qaservice_message(self, *args, **kwargs): """ - Enter the menu to set file plot parameters. + . """ - return PyMenu(self.service, "/results/plot/file_set").execute(*args, **kwargs) - def histogram(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/general/qaservice_message").execute(*args, **kwargs) + def utlcreate_physics_on_mode_change(self, *args, **kwargs): """ - Plot a histogram of a specified scalar quantity. + . """ - return PyMenu(self.service, "/results/plot/histogram").execute(*args, **kwargs) - def histogram_set(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/general/utlcreate_physics_on_mode_change").execute(*args, **kwargs) + def utlmode(self, *args, **kwargs): """ - Enter the menu to set histogram plot parameters. + . """ - return PyMenu(self.service, "/results/plot/histogram_set").execute(*args, **kwargs) - def plot(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/general/utlmode").execute(*args, **kwargs) + + class gpuapp(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def alpha_features(self, *args, **kwargs): """ - Plot solution on surfaces. + . """ - return PyMenu(self.service, "/results/plot/plot").execute(*args, **kwargs) - def plot_direction(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/gpuapp/alpha_features").execute(*args, **kwargs) + + class graphics(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.boundary_markers = self.__class__.boundary_markers(path + [("boundary_markers", None)], service) + self.colormap_settings = self.__class__.colormap_settings(path + [("colormap_settings", None)], service) + self.embedded_windows = self.__class__.embedded_windows(path + [("embedded_windows", None)], service) + self.export_video_settings = self.__class__.export_video_settings(path + [("export_video_settings", None)], service) + self.graphics_effects = self.__class__.graphics_effects(path + [("graphics_effects", None)], service) + self.hardcopy_settings = self.__class__.hardcopy_settings(path + [("hardcopy_settings", None)], service) + self.lighting = self.__class__.lighting(path + [("lighting", None)], service) + self.manage_hoops_memory = self.__class__.manage_hoops_memory(path + [("manage_hoops_memory", None)], service) + self.material_effects = self.__class__.material_effects(path + [("material_effects", None)], service) + self.meshing_mode = self.__class__.meshing_mode(path + [("meshing_mode", None)], service) + self.performance = self.__class__.performance(path + [("performance", None)], service) + self.transparency = self.__class__.transparency(path + [("transparency", None)], service) + self.vector_settings = self.__class__.vector_settings(path + [("vector_settings", None)], service) + super().__init__(path, service) + def animation_option(self, *args, **kwargs): """ - Set plot direction for xy plot. + . """ - return PyMenu(self.service, "/results/plot/plot_direction").execute(*args, **kwargs) - def residuals(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/animation_option").execute(*args, **kwargs) + def double_buffering(self, *args, **kwargs): """ - Plot equation residual history. + . """ - return PyMenu(self.service, "/results/plot/residuals").execute(*args, **kwargs) - def residuals_set(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/double_buffering").execute(*args, **kwargs) + def enable_non_object_based_workflow(self, *args, **kwargs): """ - Enter the menu to set residual plot parameters. + . """ - return PyMenu(self.service, "/results/plot/residuals_set").execute(*args, **kwargs) - def solution(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/enable_non_object_based_workflow").execute(*args, **kwargs) + def event_poll_interval(self, *args, **kwargs): """ - Plot solution on surfaces and/or zones. + . """ - return PyMenu(self.service, "/results/plot/solution").execute(*args, **kwargs) - def solution_set(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/event_poll_interval").execute(*args, **kwargs) + def event_poll_timeout(self, *args, **kwargs): """ - Enter the menu to set solution plot parameters. + . """ - return PyMenu(self.service, "/results/plot/solution_set").execute(*args, **kwargs) - def set_boundary_val_off(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/event_poll_timeout").execute(*args, **kwargs) + def force_key_frame_animation_markers_to_off(self, *args, **kwargs): """ - Set boundary value off when node values off for XY/Solution Plot. - - Note: This setting is valid for current Fluent session only. + . """ - return PyMenu(self.service, "/results/plot/set_boundary_val_off").execute(*args, **kwargs) - def label_alignment(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/force_key_frame_animation_markers_to_off").execute(*args, **kwargs) + def graphics_window_line_width(self, *args, **kwargs): """ - Set the alignment of xy plot label to horizontal or axis aligned. + . """ - return PyMenu(self.service, "/results/plot/label_alignment").execute(*args, **kwargs) - - class ansys_sound_analysis(metaclass=PyMenuMeta): + return PyMenu(self.service, "/preferences/graphics/graphics_window_line_width").execute(*args, **kwargs) + def graphics_window_point_symbol(self, *args, **kwargs): """ - Ansys Sound analysis and specification. + . """ - def __init__(self, path, service): - self.path = path - self.service = service - def write_files(self, *args, **kwargs): - """ - Write Ansys Sound out files. - """ - return PyMenu(self.service, "/results/plot/ansys_sound_analysis/write_files").execute(*args, **kwargs) - def print_indicators(self, *args, **kwargs): - """ - Print Ansys Sound indicators. - """ - return PyMenu(self.service, "/results/plot/ansys_sound_analysis/print_indicators").execute(*args, **kwargs) - - class cumulative_plot(metaclass=PyMenuMeta): + return PyMenu(self.service, "/preferences/graphics/graphics_window_point_symbol").execute(*args, **kwargs) + def hidden_surface_removal_method(self, *args, **kwargs): """ - Plot Cumulative Force and Moments. + . """ - def __init__(self, path, service): - self.path = path - self.service = service - def add(self, *args, **kwargs): - """ - Add a new object. - """ - return PyMenu(self.service, "/results/plot/cumulative_plot/add").execute(*args, **kwargs) - def axes(self, *args, **kwargs): - """ - Set axes options of an object. - """ - return PyMenu(self.service, "/results/plot/cumulative_plot/axes").execute(*args, **kwargs) - def curves(self, *args, **kwargs): - """ - Set curves options of an object. - """ - return PyMenu(self.service, "/results/plot/cumulative_plot/curves").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edit an object. - """ - return PyMenu(self.service, "/results/plot/cumulative_plot/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Delete an object. - """ - return PyMenu(self.service, "/results/plot/cumulative_plot/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - List objects. - """ - return PyMenu(self.service, "/results/plot/cumulative_plot/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): - """ - List properties of an object. - """ - return PyMenu(self.service, "/results/plot/cumulative_plot/list_properties").execute(*args, **kwargs) - def plot(self, *args, **kwargs): - """ - Plot the Cumulative Forces/Moments. - """ - return PyMenu(self.service, "/results/plot/cumulative_plot/plot").execute(*args, **kwargs) - def print(self, *args, **kwargs): - """ - Print the Cumulative Forces/Moments. - """ - return PyMenu(self.service, "/results/plot/cumulative_plot/print").execute(*args, **kwargs) - def write(self, *args, **kwargs): - """ - Write the Cumulative Forces/Moments. - """ - return PyMenu(self.service, "/results/plot/cumulative_plot/write").execute(*args, **kwargs) - - class flamelet_curves(metaclass=PyMenuMeta): + return PyMenu(self.service, "/preferences/graphics/hidden_surface_removal_method").execute(*args, **kwargs) + def higher_resolution_graphics_window_line_width(self, *args, **kwargs): """ - Plot flamelet curves. + . """ - def __init__(self, path, service): - self.path = path - self.service = service - def write_to_file(self, *args, **kwargs): - """ - Write curve to a file instead of plot. - """ - return PyMenu(self.service, "/results/plot/flamelet_curves/write_to_file").execute(*args, **kwargs) - def plot_curves(self, *args, **kwargs): - """ - Plot of a property. - """ - return PyMenu(self.service, "/results/plot/flamelet_curves/plot_curves").execute(*args, **kwargs) - - class report(metaclass=PyMenuMeta): - """ - Enter the report menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.dpm_histogram = self.__class__.dpm_histogram(path + [("dpm_histogram", None)], service) - self.fluxes = self.__class__.fluxes(path + [("fluxes", None)], service) - self.forces = self.__class__.forces(path + [("forces", None)], service) - self.reference_values = self.__class__.reference_values(path + [("reference_values", None)], service) - self.surface_integrals = self.__class__.surface_integrals(path + [("surface_integrals", None)], service) - self.volume_integrals = self.__class__.volume_integrals(path + [("volume_integrals", None)], service) - self.modified_setting = self.__class__.modified_setting(path + [("modified_setting", None)], service) - self.population_balance = self.__class__.population_balance(path + [("population_balance", None)], service) - self.heat_exchanger = self.__class__.heat_exchanger(path + [("heat_exchanger", None)], service) - self.system = self.__class__.system(path + [("system", None)], service) - self.simulation_reports = self.__class__.simulation_reports(path + [("simulation_reports", None)], service) - def aero_optical_distortions(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/higher_resolution_graphics_window_line_width").execute(*args, **kwargs) + def lower_resolution_graphics_window_line_width(self, *args, **kwargs): """ - Optics report menu. + . """ - return PyMenu(self.service, "/results/report/aero_optical_distortions").execute(*args, **kwargs) - def dpm_summary(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/lower_resolution_graphics_window_line_width").execute(*args, **kwargs) + def marker_drawing_mode(self, *args, **kwargs): """ - Print discrete phase summary report of particle fates. + . """ - return PyMenu(self.service, "/results/report/dpm_summary").execute(*args, **kwargs) - def dpm_extended_summary(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/marker_drawing_mode").execute(*args, **kwargs) + def max_graphics_text_size(self, *args, **kwargs): """ - Print extended discrete phase summary report of particle fates, with options. + . """ - return PyMenu(self.service, "/results/report/dpm_extended_summary").execute(*args, **kwargs) - def dpm_zone_summaries_per_injection(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/max_graphics_text_size").execute(*args, **kwargs) + def min_graphics_text_size(self, *args, **kwargs): """ - Enable per-injection zone DPM summaries. + . """ - return PyMenu(self.service, "/results/report/dpm_zone_summaries_per_injection").execute(*args, **kwargs) - def dpm_sample(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/min_graphics_text_size").execute(*args, **kwargs) + def new_material_infra(self, *args, **kwargs): """ - Sample trajectories at boundaries and lines/planes. + . """ - return PyMenu(self.service, "/results/report/dpm_sample").execute(*args, **kwargs) - def dpm_sample_output_udf(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/new_material_infra").execute(*args, **kwargs) + def plot_legend_margin(self, *args, **kwargs): """ - Set the DPM sampling output UDF. + . """ - return PyMenu(self.service, "/results/report/dpm_sample_output_udf").execute(*args, **kwargs) - def dpm_sample_sort_file(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/plot_legend_margin").execute(*args, **kwargs) + def point_tool_size(self, *args, **kwargs): """ - Enable writing of sorted DPM sample files. + . """ - return PyMenu(self.service, "/results/report/dpm_sample_sort_file").execute(*args, **kwargs) - def particle_summary(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/point_tool_size").execute(*args, **kwargs) + def remove_partition_lines(self, *args, **kwargs): """ - Print summary report for all current particles. + . """ - return PyMenu(self.service, "/results/report/particle_summary").execute(*args, **kwargs) - def path_line_summary(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/remove_partition_lines").execute(*args, **kwargs) + def remove_partition_lines_tolerance(self, *args, **kwargs): """ - Print path-line-summary report. + . """ - return PyMenu(self.service, "/results/report/path_line_summary").execute(*args, **kwargs) - def print_histogram(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/remove_partition_lines_tolerance").execute(*args, **kwargs) + def rotation_centerpoint_visible(self, *args, **kwargs): """ - Print a histogram of a scalar quantity. + . """ - return PyMenu(self.service, "/results/report/print_histogram").execute(*args, **kwargs) - def write_histogram(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/rotation_centerpoint_visible").execute(*args, **kwargs) + def scroll_wheel_event_end_timer(self, *args, **kwargs): """ - Write a histogram of a scalar quantity to a file. + . """ - return PyMenu(self.service, "/results/report/write_histogram").execute(*args, **kwargs) - def projected_surface_area(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/scroll_wheel_event_end_timer").execute(*args, **kwargs) + def set_camera_normal_to_surface_increments(self, *args, **kwargs): """ - Print total area of the projection of a group of surfaces to a plane. + . """ - return PyMenu(self.service, "/results/report/projected_surface_area").execute(*args, **kwargs) - def species_mass_flow(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/set_camera_normal_to_surface_increments").execute(*args, **kwargs) + def show_hidden_lines(self, *args, **kwargs): """ - Print list of species mass flow rates at boundaries. + . """ - return PyMenu(self.service, "/results/report/species_mass_flow").execute(*args, **kwargs) - def element_mass_flow(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/show_hidden_lines").execute(*args, **kwargs) + def show_hidden_surfaces(self, *args, **kwargs): """ - Print list of element mass flow rates at boundaries. + . """ - return PyMenu(self.service, "/results/report/element_mass_flow").execute(*args, **kwargs) - def summary(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/show_hidden_surfaces").execute(*args, **kwargs) + def switch_to_open_glfor_remote_visualization(self, *args, **kwargs): """ - Print report summary. + . """ - return PyMenu(self.service, "/results/report/summary").execute(*args, **kwargs) - def uds_flow(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/switch_to_open_glfor_remote_visualization").execute(*args, **kwargs) + def test_use_external_function(self, *args, **kwargs): """ - Print list of UDS flow rate at boundaries. + . """ - return PyMenu(self.service, "/results/report/uds_flow").execute(*args, **kwargs) - def mphase_summary(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/test_use_external_function").execute(*args, **kwargs) + def text_window_line_width(self, *args, **kwargs): """ - Multiphase Summary and Recommendations. + . """ - return PyMenu(self.service, "/results/report/mphase_summary").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/graphics/text_window_line_width").execute(*args, **kwargs) - class dpm_histogram(metaclass=PyMenuMeta): + class boundary_markers(TUIMenu): """ - Enter the DPM histogram menu. + . """ def __init__(self, path, service): self.path = path self.service = service - self.set = self.__class__.set(path + [("set", None)], service) - self.setup_reduction = self.__class__.setup_reduction(path + [("setup_reduction", None)], service) - def compute_sample(self, *args, **kwargs): + super().__init__(path, service) + def color_option(self, *args, **kwargs): """ - Compute minimum/maximum of a sample variable. + . """ - return PyMenu(self.service, "/results/report/dpm_histogram/compute_sample").execute(*args, **kwargs) - def delete_sample(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/boundary_markers/color_option").execute(*args, **kwargs) + def enabled(self, *args, **kwargs): """ - Delete a sample from loaded sample list. + . """ - return PyMenu(self.service, "/results/report/dpm_histogram/delete_sample").execute(*args, **kwargs) - def list_samples(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/boundary_markers/enabled").execute(*args, **kwargs) + def exclude_from_bounding(self, *args, **kwargs): """ - Show all samples in loaded sample list. + . """ - return PyMenu(self.service, "/results/report/dpm_histogram/list_samples").execute(*args, **kwargs) - def plot_sample(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/boundary_markers/exclude_from_bounding").execute(*args, **kwargs) + def inlet_color(self, *args, **kwargs): """ - Plot a histogram of a loaded sample. + . """ - return PyMenu(self.service, "/results/report/dpm_histogram/plot_sample").execute(*args, **kwargs) - def read_sample(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/boundary_markers/inlet_color").execute(*args, **kwargs) + def marker_fraction(self, *args, **kwargs): """ - Read a sample file and add it to the sample list. + . """ - return PyMenu(self.service, "/results/report/dpm_histogram/read_sample").execute(*args, **kwargs) - def write_sample(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/boundary_markers/marker_fraction").execute(*args, **kwargs) + def marker_size_limiting_scale_multiplier(self, *args, **kwargs): """ - Write a histogram of a loaded sample into a file. + . """ - return PyMenu(self.service, "/results/report/dpm_histogram/write_sample").execute(*args, **kwargs) - def pick_sample_to_reduce(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/boundary_markers/marker_size_limiting_scale_multiplier").execute(*args, **kwargs) + def markers_limit(self, *args, **kwargs): """ - Pick a sample for which to first set-up and then perform the data reduction. + . """ - return PyMenu(self.service, "/results/report/dpm_histogram/pick_sample_to_reduce").execute(*args, **kwargs) - def reduce_picked_sample(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/boundary_markers/markers_limit").execute(*args, **kwargs) + def outlet_color(self, *args, **kwargs): """ - Reduce a sample after first picking it and setting up all data-reduction options and parameters. + . """ - return PyMenu(self.service, "/results/report/dpm_histogram/reduce_picked_sample").execute(*args, **kwargs) - - class set(metaclass=PyMenuMeta): + return PyMenu(self.service, "/preferences/graphics/boundary_markers/outlet_color").execute(*args, **kwargs) + def scale_marker(self, *args, **kwargs): """ - Enter the settings menu for the histogram. + . """ - def __init__(self, path, service): - self.path = path - self.service = service - def auto_range(self, *args, **kwargs): - """ - Automatically compute range of sampling variable for histogram plots. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/set/auto_range").execute(*args, **kwargs) - def correlation(self, *args, **kwargs): - """ - Compute correlation of sampling variable with other variable. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/set/correlation").execute(*args, **kwargs) - def cumulation_curve(self, *args, **kwargs): - """ - Compute a cumulative curve for sampling variable or correlation variable when correlation? was specified. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/set/cumulation_curve").execute(*args, **kwargs) - def diameter_statistics(self, *args, **kwargs): - """ - Compute Rosin Rammler parameters, Sauter and other mean diameters. - Requires specification of diameter as sampling variable. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/set/diameter_statistics").execute(*args, **kwargs) - def histogram_mode(self, *args, **kwargs): - """ - Use bars for histogram plot or xy-style. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/set/histogram_mode").execute(*args, **kwargs) - def minimum(self, *args, **kwargs): - """ - Specify mimimum value of x-axis variable for histogram plots. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/set/minimum").execute(*args, **kwargs) - def maximum(self, *args, **kwargs): - """ - Specify maximum value of x-axis variable for histogram plots. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/set/maximum").execute(*args, **kwargs) - def number_of_bins(self, *args, **kwargs): - """ - Specify the number of bins. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/set/number_of_bins").execute(*args, **kwargs) - def percentage(self, *args, **kwargs): - """ - Use percentages of bins to be computed. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/set/percentage").execute(*args, **kwargs) - def variable_power_3(self, *args, **kwargs): - """ - Use the cubic of the cumulation variable during computation of the cumulative curve. - When the particle mass was not sampled, the diameter can be used instead. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/set/variable_power_3").execute(*args, **kwargs) - def logarithmic(self, *args, **kwargs): - """ - Use logarithmic scaling on the abscissa (variable axis)? -- Will not work unless all values are positive. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/set/logarithmic").execute(*args, **kwargs) - def weighting(self, *args, **kwargs): - """ - Use weighting with additional variable when sorting data into samples. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/set/weighting").execute(*args, **kwargs) - - class setup_reduction(metaclass=PyMenuMeta): + return PyMenu(self.service, "/preferences/graphics/boundary_markers/scale_marker").execute(*args, **kwargs) + def show_inlet_markers(self, *args, **kwargs): """ - Set up the sample data reduction by specifying all relevant options and setting parameters as desired. + . """ - def __init__(self, path, service): - self.path = path - self.service = service - def use_weighting(self, *args, **kwargs): - """ - Specify whether to use any weighting in the averaging that is done in each bin in the data reduction. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/use_weighting").execute(*args, **kwargs) - def weighting_variable(self, *args, **kwargs): - """ - Choose the weighting variable for the averaging in each bin in the data reduction. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/weighting_variable").execute(*args, **kwargs) - def make_steady_from_unsteady_file(self, *args, **kwargs): - """ - Specify whether the unsteady sample is to be reduced into a steady-state injection file. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/make_steady_from_unsteady_file").execute(*args, **kwargs) - def reset_min_and_max(self, *args, **kwargs): - """ - Reset the min and max values of the range to be considered for a specific variable in the data reduction. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/reset_min_and_max").execute(*args, **kwargs) - def minimum(self, *args, **kwargs): - """ - Set the minimum value of the range to be considered for a specific variable in the data reduction. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/minimum").execute(*args, **kwargs) - def maximum(self, *args, **kwargs): - """ - Set the maximum value of the range to be considered for a specific variable in the data reduction. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/maximum").execute(*args, **kwargs) - def logarithmic(self, *args, **kwargs): - """ - Switch on or off logarithmic scaling to be used for a specific variable in the data reduction. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/logarithmic").execute(*args, **kwargs) - def number_of_bins(self, *args, **kwargs): - """ - Set the number of bins to be used for a specific variable in the data reduction. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/number_of_bins").execute(*args, **kwargs) - def all_variables_number_of_bins(self, *args, **kwargs): - """ - Set the number of bins to be used for ALL variables in the data reduction. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/all_variables_number_of_bins").execute(*args, **kwargs) - def list_settings(self, *args, **kwargs): - """ - List all user inputs for the sample picked for data reduction. - """ - return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/list_settings").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/graphics/boundary_markers/show_inlet_markers").execute(*args, **kwargs) + def show_outlet_markers(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/boundary_markers/show_outlet_markers").execute(*args, **kwargs) - class fluxes(metaclass=PyMenuMeta): + class colormap_settings(TUIMenu): """ - Flux report menu. + . """ def __init__(self, path, service): self.path = path self.service = service - def mass_flow(self, *args, **kwargs): + super().__init__(path, service) + def alignment(self, *args, **kwargs): """ - Print mass flow rate at inlets and outlets. + . """ - return PyMenu(self.service, "/results/report/fluxes/mass_flow").execute(*args, **kwargs) - def heat_transfer(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/colormap_settings/alignment").execute(*args, **kwargs) + def aspect_ratio_when_horizontal(self, *args, **kwargs): """ - Print heat transfer rate at boundaries. + . """ - return PyMenu(self.service, "/results/report/fluxes/heat_transfer").execute(*args, **kwargs) - def heat_transfer_sensible(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/colormap_settings/aspect_ratio_when_horizontal").execute(*args, **kwargs) + def aspect_ratio_when_vertical(self, *args, **kwargs): """ - Print sensible heat transfer rate at boundaries. + . """ - return PyMenu(self.service, "/results/report/fluxes/heat_transfer_sensible").execute(*args, **kwargs) - def rad_heat_trans(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/colormap_settings/aspect_ratio_when_vertical").execute(*args, **kwargs) + def auto_refit_on_resize(self, *args, **kwargs): """ - Print radiation heat transfer rate at boundaries. + . """ - return PyMenu(self.service, "/results/report/fluxes/rad_heat_trans").execute(*args, **kwargs) - def film_mass_flow(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/colormap_settings/auto_refit_on_resize").execute(*args, **kwargs) + def automatic_resize(self, *args, **kwargs): """ - Print film mass flow rate at boundaries. + . """ - return PyMenu(self.service, "/results/report/fluxes/film_mass_flow").execute(*args, **kwargs) - def film_heat_transfer(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/colormap_settings/automatic_resize").execute(*args, **kwargs) + def border_style(self, *args, **kwargs): """ - Print film heat transfer rate at boundaries. + . """ - return PyMenu(self.service, "/results/report/fluxes/film_heat_transfer").execute(*args, **kwargs) - def pressure_work(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/colormap_settings/border_style").execute(*args, **kwargs) + def colormap(self, *args, **kwargs): """ - Print pressure work rate at moving boundaries. + . """ - return PyMenu(self.service, "/results/report/fluxes/pressure_work").execute(*args, **kwargs) - def viscous_work(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/colormap_settings/colormap").execute(*args, **kwargs) + def isolines_position_offset(self, *args, **kwargs): """ - Print viscous work rate at boundaries. + . """ - return PyMenu(self.service, "/results/report/fluxes/viscous_work").execute(*args, **kwargs) - - class forces(metaclass=PyMenuMeta): - """ - Force report menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def wall_forces(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/colormap_settings/isolines_position_offset").execute(*args, **kwargs) + def labels(self, *args, **kwargs): """ - Print integrated pressure and viscous forces on wall zones. + . """ - return PyMenu(self.service, "/results/report/forces/wall_forces").execute(*args, **kwargs) - def wall_moments(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/colormap_settings/labels").execute(*args, **kwargs) + def levels(self, *args, **kwargs): """ - Print integrated pressure and viscous moments on wall zones. + . """ - return PyMenu(self.service, "/results/report/forces/wall_moments").execute(*args, **kwargs) - def pressure_center(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/colormap_settings/levels").execute(*args, **kwargs) + def log_scale(self, *args, **kwargs): """ - Print center of pressure on wall zones. + . """ - return PyMenu(self.service, "/results/report/forces/pressure_center").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/graphics/colormap_settings/log_scale").execute(*args, **kwargs) + def major_length_to_screen_ratio_when_horizontal(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/major_length_to_screen_ratio_when_horizontal").execute(*args, **kwargs) + def major_length_to_screen_ratio_when_vertical(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/major_length_to_screen_ratio_when_vertical").execute(*args, **kwargs) + def margin_from_edge_to_screen_ratio(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/margin_from_edge_to_screen_ratio").execute(*args, **kwargs) + def max_size_scale_factor(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/max_size_scale_factor").execute(*args, **kwargs) + def min_size_scale_factor(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/min_size_scale_factor").execute(*args, **kwargs) + def number_format_precision(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/number_format_precision").execute(*args, **kwargs) + def number_format_type(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/number_format_type").execute(*args, **kwargs) + def show_colormap(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/show_colormap").execute(*args, **kwargs) + def skip_value(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/skip_value").execute(*args, **kwargs) + def text_behavior(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_behavior").execute(*args, **kwargs) + def text_font_automatic_horizontal_size(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_automatic_horizontal_size").execute(*args, **kwargs) + def text_font_automatic_size(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_automatic_size").execute(*args, **kwargs) + def text_font_automatic_units(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_automatic_units").execute(*args, **kwargs) + def text_font_automatic_vertical_size(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_automatic_vertical_size").execute(*args, **kwargs) + def text_font_fixed_horizontal_size(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_fixed_horizontal_size").execute(*args, **kwargs) + def text_font_fixed_size(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_fixed_size").execute(*args, **kwargs) + def text_font_fixed_units(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_fixed_units").execute(*args, **kwargs) + def text_font_fixed_vertical_size(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_fixed_vertical_size").execute(*args, **kwargs) + def text_font_name(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_font_name").execute(*args, **kwargs) + def text_truncation_limit_for_horizontal_colormaps(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_truncation_limit_for_horizontal_colormaps").execute(*args, **kwargs) + def text_truncation_limit_for_vertical_colormaps(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/text_truncation_limit_for_vertical_colormaps").execute(*args, **kwargs) + def type(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/type").execute(*args, **kwargs) + def use_no_sub_windows(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/colormap_settings/use_no_sub_windows").execute(*args, **kwargs) - class reference_values(metaclass=PyMenuMeta): + class embedded_windows(TUIMenu): """ - Reference value menu. + . """ def __init__(self, path, service): self.path = path self.service = service - self.compute = self.__class__.compute(path + [("compute", None)], service) - def area(self, *args, **kwargs): + super().__init__(path, service) + def default_embedded_mesh_windows_view(self, *args, **kwargs): """ - Set reference area for normalization. + . """ - return PyMenu(self.service, "/results/report/reference_values/area").execute(*args, **kwargs) - def depth(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/embedded_windows/default_embedded_mesh_windows_view").execute(*args, **kwargs) + def default_embedded_windows_view(self, *args, **kwargs): """ - Set reference depth for volume calculation. + . """ - return PyMenu(self.service, "/results/report/reference_values/depth").execute(*args, **kwargs) - def density(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/embedded_windows/default_embedded_windows_view").execute(*args, **kwargs) + def save_embedded_window_layout(self, *args, **kwargs): """ - Set reference density for normalization. + . """ - return PyMenu(self.service, "/results/report/reference_values/density").execute(*args, **kwargs) - def enthalpy(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/embedded_windows/save_embedded_window_layout").execute(*args, **kwargs) + def show_border_for_embedded_window(self, *args, **kwargs): """ - Set reference enthalpy for enthalpy damping and normalization. + . """ - return PyMenu(self.service, "/results/report/reference_values/enthalpy").execute(*args, **kwargs) - def length(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/embedded_windows/show_border_for_embedded_window").execute(*args, **kwargs) + + class export_video_settings(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.advanced_video_quality_options = self.__class__.advanced_video_quality_options(path + [("advanced_video_quality_options", None)], service) + super().__init__(path, service) + def video_format(self, *args, **kwargs): """ - Set reference length for normalization. + . """ - return PyMenu(self.service, "/results/report/reference_values/length").execute(*args, **kwargs) - def pressure(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/export_video_settings/video_format").execute(*args, **kwargs) + def video_fps(self, *args, **kwargs): """ - Set reference pressure for normalization. + . """ - return PyMenu(self.service, "/results/report/reference_values/pressure").execute(*args, **kwargs) - def temperature(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/export_video_settings/video_fps").execute(*args, **kwargs) + def video_quality(self, *args, **kwargs): """ - Set reference temperature for normalization. + . """ - return PyMenu(self.service, "/results/report/reference_values/temperature").execute(*args, **kwargs) - def yplus(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/export_video_settings/video_quality").execute(*args, **kwargs) + def video_resoution_x(self, *args, **kwargs): """ - Set reference yplus for normalization. + . """ - return PyMenu(self.service, "/results/report/reference_values/yplus").execute(*args, **kwargs) - def velocity(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/export_video_settings/video_resoution_x").execute(*args, **kwargs) + def video_resoution_y(self, *args, **kwargs): """ - Set reference velocity for normalization. + . """ - return PyMenu(self.service, "/results/report/reference_values/velocity").execute(*args, **kwargs) - def viscosity(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/export_video_settings/video_resoution_y").execute(*args, **kwargs) + def video_scale(self, *args, **kwargs): """ - Set reference viscosity for normalization. + . """ - return PyMenu(self.service, "/results/report/reference_values/viscosity").execute(*args, **kwargs) - def zone(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/export_video_settings/video_scale").execute(*args, **kwargs) + def video_smooth_scaling(self, *args, **kwargs): """ - Set reference zone. + . """ - return PyMenu(self.service, "/results/report/reference_values/zone").execute(*args, **kwargs) - def list(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/export_video_settings/video_smooth_scaling").execute(*args, **kwargs) + def video_use_frame_resolution(self, *args, **kwargs): """ - List current reference values. + . """ - return PyMenu(self.service, "/results/report/reference_values/list").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/graphics/export_video_settings/video_use_frame_resolution").execute(*args, **kwargs) - class compute(metaclass=PyMenuMeta): + class advanced_video_quality_options(TUIMenu): """ - Enter the compute menu. + . """ def __init__(self, path, service): self.path = path self.service = service - def axis(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/axis").execute(*args, **kwargs) - def degassing(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/degassing").execute(*args, **kwargs) - def dummy_entry(self, *args, **kwargs): + super().__init__(path, service) + def bit_rate_quality(self, *args, **kwargs): """ . """ - return PyMenu(self.service, "/results/report/reference_values/compute/dummy_entry").execute(*args, **kwargs) - def exhaust_fan(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/exhaust_fan").execute(*args, **kwargs) - def fan(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/fan").execute(*args, **kwargs) - def fluid(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/fluid").execute(*args, **kwargs) - def geometry(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/geometry").execute(*args, **kwargs) - def inlet_vent(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/inlet_vent").execute(*args, **kwargs) - def intake_fan(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/intake_fan").execute(*args, **kwargs) - def interface(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/interface").execute(*args, **kwargs) - def interior(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/interior").execute(*args, **kwargs) - def mass_flow_inlet(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/mass_flow_inlet").execute(*args, **kwargs) - def mass_flow_outlet(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/mass_flow_outlet").execute(*args, **kwargs) - def network(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/network").execute(*args, **kwargs) - def network_end(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/network_end").execute(*args, **kwargs) - def outflow(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/outflow").execute(*args, **kwargs) - def outlet_vent(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/outlet_vent").execute(*args, **kwargs) - def overset(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/overset").execute(*args, **kwargs) - def periodic(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/periodic").execute(*args, **kwargs) - def porous_jump(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/porous_jump").execute(*args, **kwargs) - def pressure_far_field(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/pressure_far_field").execute(*args, **kwargs) - def pressure_inlet(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/pressure_inlet").execute(*args, **kwargs) - def pressure_outlet(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/pressure_outlet").execute(*args, **kwargs) - def radiator(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/radiator").execute(*args, **kwargs) - def rans_les_interface(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/rans_les_interface").execute(*args, **kwargs) - def recirculation_inlet(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/recirculation_inlet").execute(*args, **kwargs) - def recirculation_outlet(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/recirculation_outlet").execute(*args, **kwargs) - def shadow(self, *args, **kwargs): - """ - Compute reference values from a zone of this type. - """ - return PyMenu(self.service, "/results/report/reference_values/compute/shadow").execute(*args, **kwargs) - def solid(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/export_video_settings/advanced_video_quality_options/bit_rate_quality").execute(*args, **kwargs) + def bitrate(self, *args, **kwargs): """ - Compute reference values from a zone of this type. + . """ - return PyMenu(self.service, "/results/report/reference_values/compute/solid").execute(*args, **kwargs) - def symmetry(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/export_video_settings/advanced_video_quality_options/bitrate").execute(*args, **kwargs) + def compression_method(self, *args, **kwargs): """ - Compute reference values from a zone of this type. + . """ - return PyMenu(self.service, "/results/report/reference_values/compute/symmetry").execute(*args, **kwargs) - def velocity_inlet(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/export_video_settings/advanced_video_quality_options/compression_method").execute(*args, **kwargs) + def enable_h264(self, *args, **kwargs): """ - Compute reference values from a zone of this type. + . """ - return PyMenu(self.service, "/results/report/reference_values/compute/velocity_inlet").execute(*args, **kwargs) - def wall(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/export_video_settings/advanced_video_quality_options/enable_h264").execute(*args, **kwargs) + def key_frames(self, *args, **kwargs): """ - Compute reference values from a zone of this type. + . """ - return PyMenu(self.service, "/results/report/reference_values/compute/wall").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/graphics/export_video_settings/advanced_video_quality_options/key_frames").execute(*args, **kwargs) - class surface_integrals(metaclass=PyMenuMeta): + class graphics_effects(TUIMenu): """ - Surface Integral menu. + . """ def __init__(self, path, service): self.path = path self.service = service - def area(self, *args, **kwargs): - """ - Print total area of surfaces. - """ - return PyMenu(self.service, "/results/report/surface_integrals/area").execute(*args, **kwargs) - def area_weighted_avg(self, *args, **kwargs): + super().__init__(path, service) + def ambient_occlusion_enabled(self, *args, **kwargs): """ - Print area-weighted average of scalar on surfaces. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/area_weighted_avg").execute(*args, **kwargs) - def facet_avg(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/ambient_occlusion_enabled").execute(*args, **kwargs) + def ambient_occlusion_quality(self, *args, **kwargs): """ - Print average of scalar at facet centroids of the surfaces. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/facet_avg").execute(*args, **kwargs) - def facet_max(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/ambient_occlusion_quality").execute(*args, **kwargs) + def ambient_occlusion_strength(self, *args, **kwargs): """ - Print maximum of scalar at facet centroids of the surfaces. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/facet_max").execute(*args, **kwargs) - def facet_min(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/ambient_occlusion_strength").execute(*args, **kwargs) + def anti_aliasing(self, *args, **kwargs): """ - Print minimum of scalar at facet centroids of the surfaces. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/facet_min").execute(*args, **kwargs) - def flow_rate(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/anti_aliasing").execute(*args, **kwargs) + def bloom_blur(self, *args, **kwargs): """ - Print flow rate of scalar through surfaces. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/flow_rate").execute(*args, **kwargs) - def integral(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/bloom_blur").execute(*args, **kwargs) + def bloom_enabled(self, *args, **kwargs): """ - Print integral of scalar over surfaces. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/integral").execute(*args, **kwargs) - def mass_flow_rate(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/bloom_enabled").execute(*args, **kwargs) + def bloom_strength(self, *args, **kwargs): """ - Print mass flow rate through surfaces. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/mass_flow_rate").execute(*args, **kwargs) - def mass_weighted_avg(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/bloom_strength").execute(*args, **kwargs) + def grid_color(self, *args, **kwargs): """ - Print mass-average of scalar over surfaces. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/mass_weighted_avg").execute(*args, **kwargs) - def standard_deviation(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/grid_color").execute(*args, **kwargs) + def grid_plane_count(self, *args, **kwargs): """ - Print standard deviation of scalar. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/standard_deviation").execute(*args, **kwargs) - def sum(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/grid_plane_count").execute(*args, **kwargs) + def grid_plane_enabled(self, *args, **kwargs): """ - Print sum of scalar at facet centroids of the surfaces. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/sum").execute(*args, **kwargs) - def uniformity_index_area_weighted(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/grid_plane_enabled").execute(*args, **kwargs) + def grid_plane_offset(self, *args, **kwargs): """ - Print uniformity index of scalar over surfaces. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/uniformity_index_area_weighted").execute(*args, **kwargs) - def uniformity_index_mass_weighted(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/grid_plane_offset").execute(*args, **kwargs) + def grid_plane_size_factor(self, *args, **kwargs): """ - Print uniformity index of scalar over surfaces. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/uniformity_index_mass_weighted").execute(*args, **kwargs) - def vector_based_flux(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/grid_plane_size_factor").execute(*args, **kwargs) + def plane_direction(self, *args, **kwargs): """ - Print custom vector based flux. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/vector_based_flux").execute(*args, **kwargs) - def vector_flux(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/plane_direction").execute(*args, **kwargs) + def reflections_enabled(self, *args, **kwargs): """ - Print custom vector flux. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/vector_flux").execute(*args, **kwargs) - def vector_weighted_average(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/reflections_enabled").execute(*args, **kwargs) + def shadow_map_enabled(self, *args, **kwargs): """ - Print custom vector weighted average. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/vector_weighted_average").execute(*args, **kwargs) - def vertex_avg(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/shadow_map_enabled").execute(*args, **kwargs) + def show_edge_reflections(self, *args, **kwargs): """ - Print average of scalar at vertices of the surfaces. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/vertex_avg").execute(*args, **kwargs) - def vertex_max(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/show_edge_reflections").execute(*args, **kwargs) + def show_marker_reflections(self, *args, **kwargs): """ - Print maximkum of scalar at vertices of the surfaces. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/vertex_max").execute(*args, **kwargs) - def vertex_min(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/show_marker_reflections").execute(*args, **kwargs) + def simple_shadows_enabled(self, *args, **kwargs): """ - Print minimum of scalar at vertices of the surfaces. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/vertex_min").execute(*args, **kwargs) - def volume_flow_rate(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/graphics_effects/simple_shadows_enabled").execute(*args, **kwargs) + def update_after_mouse_release(self, *args, **kwargs): """ - Print volume flow rate through surfaces. + . """ - return PyMenu(self.service, "/results/report/surface_integrals/volume_flow_rate").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/graphics/graphics_effects/update_after_mouse_release").execute(*args, **kwargs) - class volume_integrals(metaclass=PyMenuMeta): + class hardcopy_settings(TUIMenu): """ - Volume Integral menu. + . """ def __init__(self, path, service): self.path = path self.service = service - def mass(self, *args, **kwargs): + super().__init__(path, service) + def export_edges_for_avz(self, *args, **kwargs): """ - Print total mass of specified cell zones. + . """ - return PyMenu(self.service, "/results/report/volume_integrals/mass").execute(*args, **kwargs) - def mass_avg(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/hardcopy_settings/export_edges_for_avz").execute(*args, **kwargs) + def hardcopy_driver(self, *args, **kwargs): """ - Print mass-average of scalar over cell zones. + . """ - return PyMenu(self.service, "/results/report/volume_integrals/mass_avg").execute(*args, **kwargs) - def mass_integral(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/hardcopy_settings/hardcopy_driver").execute(*args, **kwargs) + def hardcopy_line_width(self, *args, **kwargs): """ - Print mass-weighted integral of scalar over cell zones. + . """ - return PyMenu(self.service, "/results/report/volume_integrals/mass_integral").execute(*args, **kwargs) - def maximum(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/hardcopy_settings/hardcopy_line_width").execute(*args, **kwargs) + def hardware_image_accel(self, *args, **kwargs): """ - Print maximum of scalar over all cell zones. + . """ - return PyMenu(self.service, "/results/report/volume_integrals/maximum").execute(*args, **kwargs) - def minimum(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/hardcopy_settings/hardware_image_accel").execute(*args, **kwargs) + def post_script_permission_override(self, *args, **kwargs): """ - Print minimum of scalar over all cell zones. + . """ - return PyMenu(self.service, "/results/report/volume_integrals/minimum").execute(*args, **kwargs) - def sum(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/hardcopy_settings/post_script_permission_override").execute(*args, **kwargs) + def save_embedded_hardcopies_separately(self, *args, **kwargs): """ - Print sum of scalar over all cell zones. + . """ - return PyMenu(self.service, "/results/report/volume_integrals/sum").execute(*args, **kwargs) - def twopisum(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/hardcopy_settings/save_embedded_hardcopies_separately").execute(*args, **kwargs) + def save_embedded_windows_in_hardcopy(self, *args, **kwargs): """ - Print sum of scalar over all cell zones multiplied by 2\*Pi. + . """ - return PyMenu(self.service, "/results/report/volume_integrals/twopisum").execute(*args, **kwargs) - def volume(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/hardcopy_settings/save_embedded_windows_in_hardcopy").execute(*args, **kwargs) + def transparent_embedded_windows(self, *args, **kwargs): """ - Print total volume of specified cell zones. + . """ - return PyMenu(self.service, "/results/report/volume_integrals/volume").execute(*args, **kwargs) - def volume_avg(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/hardcopy_settings/transparent_embedded_windows").execute(*args, **kwargs) + + class lighting(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def ambient_light_intensity(self, *args, **kwargs): """ - Print volume-weighted average of scalar over cell zones. + . """ - return PyMenu(self.service, "/results/report/volume_integrals/volume_avg").execute(*args, **kwargs) - def volume_integral(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/lighting/ambient_light_intensity").execute(*args, **kwargs) + def headlight(self, *args, **kwargs): """ - Print integral of scalar over cell zones. + . """ - return PyMenu(self.service, "/results/report/volume_integrals/volume_integral").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/graphics/lighting/headlight").execute(*args, **kwargs) + def headlight_intensity(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/lighting/headlight_intensity").execute(*args, **kwargs) + def lighting_method(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/lighting/lighting_method").execute(*args, **kwargs) - class modified_setting(metaclass=PyMenuMeta): + class manage_hoops_memory(TUIMenu): """ - Enter the menu for setting up the Modified Settings Summary table. + . """ def __init__(self, path, service): self.path = path self.service = service - def modified_setting(self, *args, **kwargs): + super().__init__(path, service) + def enabled(self, *args, **kwargs): """ - Specify which settings will be checked for non-default status for generating the Modified Settings Summary table. + . """ - return PyMenu(self.service, "/results/report/modified_setting/modified_setting").execute(*args, **kwargs) - def write_user_setting(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/manage_hoops_memory/enabled").execute(*args, **kwargs) + def hsfimport_limit(self, *args, **kwargs): """ - Write the contents of the Modified Settings Summary table to a file. + . """ - return PyMenu(self.service, "/results/report/modified_setting/write_user_setting").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/graphics/manage_hoops_memory/hsfimport_limit").execute(*args, **kwargs) - class population_balance(metaclass=PyMenuMeta): + class material_effects(TUIMenu): """ - Population Balance menu. + . """ def __init__(self, path, service): self.path = path self.service = service - def moments(self, *args, **kwargs): + super().__init__(path, service) + def decimation_filter(self, *args, **kwargs): """ - Set moments for population balance. + . """ - return PyMenu(self.service, "/results/report/population_balance/moments").execute(*args, **kwargs) - def number_density(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/material_effects/decimation_filter").execute(*args, **kwargs) + def parameterization_source(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/material_effects/parameterization_source").execute(*args, **kwargs) + def tiling_style(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/material_effects/tiling_style").execute(*args, **kwargs) + + class meshing_mode(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def graphics_window_display_timeout(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/meshing_mode/graphics_window_display_timeout").execute(*args, **kwargs) + def graphics_window_display_timeout_value(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/meshing_mode/graphics_window_display_timeout_value").execute(*args, **kwargs) + + class performance(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.fast_display_mode = self.__class__.fast_display_mode(path + [("fast_display_mode", None)], service) + self.minimum_frame_rate = self.__class__.minimum_frame_rate(path + [("minimum_frame_rate", None)], service) + super().__init__(path, service) + def optimize_for(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/performance/optimize_for").execute(*args, **kwargs) + def ratio_of_target_frame_rate_to_classify_heavy_geometry(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/performance/ratio_of_target_frame_rate_to_classify_heavy_geometry").execute(*args, **kwargs) + def ratio_of_target_frame_rate_to_declassify_heavy_geometry(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/performance/ratio_of_target_frame_rate_to_declassify_heavy_geometry").execute(*args, **kwargs) + + class fast_display_mode(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def culling(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/performance/fast_display_mode/culling").execute(*args, **kwargs) + def faces_shown(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/performance/fast_display_mode/faces_shown").execute(*args, **kwargs) + def markers_decimation(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/performance/fast_display_mode/markers_decimation").execute(*args, **kwargs) + def nodes_shown(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/performance/fast_display_mode/nodes_shown").execute(*args, **kwargs) + def perimeter_edges_shown(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/performance/fast_display_mode/perimeter_edges_shown").execute(*args, **kwargs) + def silhouette_shown(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/performance/fast_display_mode/silhouette_shown").execute(*args, **kwargs) + def status(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/performance/fast_display_mode/status").execute(*args, **kwargs) + def transparency(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/performance/fast_display_mode/transparency").execute(*args, **kwargs) + + class minimum_frame_rate(TUIMenu): """ - Set number density functions. + . """ - return PyMenu(self.service, "/results/report/population_balance/number_density").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def dynamic_adjustment(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/performance/minimum_frame_rate/dynamic_adjustment").execute(*args, **kwargs) + def enabled(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/performance/minimum_frame_rate/enabled").execute(*args, **kwargs) + def fixed_culling_value(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/performance/minimum_frame_rate/fixed_culling_value").execute(*args, **kwargs) + def maximum_culling_threshold(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/performance/minimum_frame_rate/maximum_culling_threshold").execute(*args, **kwargs) + def minimum_culling_threshold(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/performance/minimum_frame_rate/minimum_culling_threshold").execute(*args, **kwargs) + def target_fps(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/graphics/performance/minimum_frame_rate/target_fps").execute(*args, **kwargs) - class heat_exchanger(metaclass=PyMenuMeta): + class transparency(TUIMenu): """ - Enter the heat exchanger menu. + . """ def __init__(self, path, service): self.path = path self.service = service - def computed_heat_rejection(self, *args, **kwargs): - """ - Print total heat rejection. - """ - return PyMenu(self.service, "/results/report/heat_exchanger/computed_heat_rejection").execute(*args, **kwargs) - def inlet_temperature(self, *args, **kwargs): - """ - Print inlet temperature. - """ - return PyMenu(self.service, "/results/report/heat_exchanger/inlet_temperature").execute(*args, **kwargs) - def outlet_temperature(self, *args, **kwargs): - """ - Print outlet temperature. - """ - return PyMenu(self.service, "/results/report/heat_exchanger/outlet_temperature").execute(*args, **kwargs) - def mass_flow_rate(self, *args, **kwargs): - """ - Print mass flow rate. - """ - return PyMenu(self.service, "/results/report/heat_exchanger/mass_flow_rate").execute(*args, **kwargs) - def specific_heat(self, *args, **kwargs): + super().__init__(path, service) + def algorithm_for_modern_drivers(self, *args, **kwargs): """ - Print fluid's specific heat. + . """ - return PyMenu(self.service, "/results/report/heat_exchanger/specific_heat").execute(*args, **kwargs) - - class system(metaclass=PyMenuMeta): - """ - Sytem menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def proc_stats(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/transparency/algorithm_for_modern_drivers").execute(*args, **kwargs) + def depth_peeling_layers(self, *args, **kwargs): """ - Fluent process information. + . """ - return PyMenu(self.service, "/results/report/system/proc_stats").execute(*args, **kwargs) - def sys_stats(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/transparency/depth_peeling_layers").execute(*args, **kwargs) + def depth_peeling_preference(self, *args, **kwargs): """ - System information. + . """ - return PyMenu(self.service, "/results/report/system/sys_stats").execute(*args, **kwargs) - def gpgpu_stats(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/transparency/depth_peeling_preference").execute(*args, **kwargs) + def quick_moves(self, *args, **kwargs): """ - GPGPU information. + . """ - return PyMenu(self.service, "/results/report/system/gpgpu_stats").execute(*args, **kwargs) - def time_stats(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/transparency/quick_moves").execute(*args, **kwargs) + def zsort_options(self, *args, **kwargs): """ - Time usage information. + . """ - return PyMenu(self.service, "/results/report/system/time_stats").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/graphics/transparency/zsort_options").execute(*args, **kwargs) - class simulation_reports(metaclass=PyMenuMeta): + class vector_settings(TUIMenu): """ - Enter the simulation reports menu. + . """ def __init__(self, path, service): self.path = path self.service = service - def list_simulation_reports(self, *args, **kwargs): - """ - List all report names. - """ - return PyMenu(self.service, "/results/report/simulation_reports/list_simulation_reports").execute(*args, **kwargs) - def generate_simulation_report(self, *args, **kwargs): - """ - Generate a new simulation report or regenerate an existing simulation report with the provided name. - """ - return PyMenu(self.service, "/results/report/simulation_reports/generate_simulation_report").execute(*args, **kwargs) - def view_simulation_report(self, *args, **kwargs): - """ - View a simulation report that has already been generated. In batch mode this will print the report's URL. - """ - return PyMenu(self.service, "/results/report/simulation_reports/view_simulation_report").execute(*args, **kwargs) - def export_simulation_report_as_pdf(self, *args, **kwargs): - """ - Export the provided simulation report as a PDF file. - """ - return PyMenu(self.service, "/results/report/simulation_reports/export_simulation_report_as_pdf").execute(*args, **kwargs) - def export_simulation_report_as_html(self, *args, **kwargs): - """ - Export the provided simulation report as HTML. - """ - return PyMenu(self.service, "/results/report/simulation_reports/export_simulation_report_as_html").execute(*args, **kwargs) - def write_report_names_to_file(self, *args, **kwargs): - """ - Write the list of currently generated report names to a txt file. - """ - return PyMenu(self.service, "/results/report/simulation_reports/write_report_names_to_file").execute(*args, **kwargs) - def rename_simulation_report(self, *args, **kwargs): - """ - Rename a report which has already been generated. - """ - return PyMenu(self.service, "/results/report/simulation_reports/rename_simulation_report").execute(*args, **kwargs) - def duplicate_simulation_report(self, *args, **kwargs): - """ - Duplicate a report and all of its settings to a new report. - """ - return PyMenu(self.service, "/results/report/simulation_reports/duplicate_simulation_report").execute(*args, **kwargs) - def reset_report_to_defaults(self, *args, **kwargs): + super().__init__(path, service) + def arrow3_dradius1_factor(self, *args, **kwargs): """ - Reset all report settings to default for the provided simulation report. + . """ - return PyMenu(self.service, "/results/report/simulation_reports/reset_report_to_defaults").execute(*args, **kwargs) - def delete_simulation_report(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/vector_settings/arrow3_dradius1_factor").execute(*args, **kwargs) + def arrow3_dradius2_factor(self, *args, **kwargs): """ - Delete the provided simulation report. + . """ - return PyMenu(self.service, "/results/report/simulation_reports/delete_simulation_report").execute(*args, **kwargs) - def write_simulation_report_template_file(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/vector_settings/arrow3_dradius2_factor").execute(*args, **kwargs) + def arrowhead3_dradius1_factor(self, *args, **kwargs): """ - Write a JSON template file with this case's Simulation Report settings. + . """ - return PyMenu(self.service, "/results/report/simulation_reports/write_simulation_report_template_file").execute(*args, **kwargs) - def read_simulation_report_template_file(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/graphics/vector_settings/arrowhead3_dradius1_factor").execute(*args, **kwargs) + def line_arrow3_dperpendicular_radius(self, *args, **kwargs): """ - Read a JSON template file with existing Simulation Report settings. + . """ - return PyMenu(self.service, "/results/report/simulation_reports/read_simulation_report_template_file").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/graphics/vector_settings/line_arrow3_dperpendicular_radius").execute(*args, **kwargs) - class surface(metaclass=PyMenuMeta): + class mat_pro_app(TUIMenu): """ - Enter the data surface manipulation menu. + . """ def __init__(self, path, service): self.path = path self.service = service - self.post_processing_volume = self.__class__.post_processing_volume(path + [("post_processing_volume", None)], service) - self.query = self.__class__.query(path + [("query", None)], service) - def circle_slice(self, *args, **kwargs): - """ - Extract a circular slice. - """ - return PyMenu(self.service, "/results/surface/circle_slice").execute(*args, **kwargs) - def delete_surface(self, *args, **kwargs): - """ - Remove a defined data surface. - """ - return PyMenu(self.service, "/results/surface/delete_surface").execute(*args, **kwargs) - def group_surfaces(self, *args, **kwargs): - """ - Group a set of surfaces. - """ - return PyMenu(self.service, "/results/surface/group_surfaces").execute(*args, **kwargs) - def ungroup_surface(self, *args, **kwargs): - """ - Ungroup the surface(if grouped). - """ - return PyMenu(self.service, "/results/surface/ungroup_surface").execute(*args, **kwargs) - def iso_clip(self, *args, **kwargs): - """ - Clip a data surface (surface, curve, or point) between two iso-values. - """ - return PyMenu(self.service, "/results/surface/iso_clip").execute(*args, **kwargs) - def iso_surface(self, *args, **kwargs): - """ - Extract an iso-surface (surface, curve, or point) from the curent data field. - """ - return PyMenu(self.service, "/results/surface/iso_surface").execute(*args, **kwargs) - def expression_volume(self, *args, **kwargs): - """ - Create volume with boolean expression. - """ - return PyMenu(self.service, "/results/surface/expression_volume").execute(*args, **kwargs) - def multiple_iso_surfaces(self, *args, **kwargs): - """ - Create multiple iso-surfaces from the data field at specified spacing. - """ - return PyMenu(self.service, "/results/surface/multiple_iso_surfaces").execute(*args, **kwargs) - def line_slice(self, *args, **kwargs): - """ - Extract a linear slice. - """ - return PyMenu(self.service, "/results/surface/line_slice").execute(*args, **kwargs) - def line_surface(self, *args, **kwargs): - """ - Define a "line" surface by specifying the two endpoint coordinates. - """ - return PyMenu(self.service, "/results/surface/line_surface").execute(*args, **kwargs) - def list_surfaces(self, *args, **kwargs): - """ - List the number of facets in the defined surfaces. - """ - return PyMenu(self.service, "/results/surface/list_surfaces").execute(*args, **kwargs) - def mouse_line(self, *args, **kwargs): - """ - Define a line surface using the mouse to select two points. - """ - return PyMenu(self.service, "/results/surface/mouse_line").execute(*args, **kwargs) - def mouse_plane(self, *args, **kwargs): - """ - Define a plane surface using the mouse to select three points. - """ - return PyMenu(self.service, "/results/surface/mouse_plane").execute(*args, **kwargs) - def mouse_rake(self, *args, **kwargs): + super().__init__(path, service) + def beta_features(self, *args, **kwargs): """ - Define a "rake" surface using the mouse to select the end points. + . """ - return PyMenu(self.service, "/results/surface/mouse_rake").execute(*args, **kwargs) - def partition_surface(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/mat_pro_app/beta_features").execute(*args, **kwargs) + def focus(self, *args, **kwargs): """ - Define a data surface on mesh faces on the partition boundary. + . """ - return PyMenu(self.service, "/results/surface/partition_surface").execute(*args, **kwargs) - def plane(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/mat_pro_app/focus").execute(*args, **kwargs) + def warning(self, *args, **kwargs): """ - Create a plane given 3 points bounded by the domain. + . """ - return PyMenu(self.service, "/results/surface/plane").execute(*args, **kwargs) - def plane_surface(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/mat_pro_app/warning").execute(*args, **kwargs) + + class meshing_workflow(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.draw_settings = self.__class__.draw_settings(path + [("draw_settings", None)], service) + super().__init__(path, service) + def checkpointing_option(self, *args, **kwargs): """ - Create a plane from a coordinate plane, point and normal, or three points. + . """ - return PyMenu(self.service, "/results/surface/plane_surface").execute(*args, **kwargs) - def multiple_plane_surfaces(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/meshing_workflow/checkpointing_option").execute(*args, **kwargs) + def save_checkpoint_files(self, *args, **kwargs): """ - Create multiple plane surfaces at specified spacing. + . """ - return PyMenu(self.service, "/results/surface/multiple_plane_surfaces").execute(*args, **kwargs) - def plane_slice(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/meshing_workflow/save_checkpoint_files").execute(*args, **kwargs) + def temp_folder(self, *args, **kwargs): """ - Extract a planar slice. + . """ - return PyMenu(self.service, "/results/surface/plane_slice").execute(*args, **kwargs) - def point_array(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/meshing_workflow/temp_folder").execute(*args, **kwargs) + def templates_folder(self, *args, **kwargs): """ - Extract a rectangular array of data points. + . """ - return PyMenu(self.service, "/results/surface/point_array").execute(*args, **kwargs) - def point_surface(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/meshing_workflow/templates_folder").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): """ - Define a "point" surface by specifying the coordinates. + . """ - return PyMenu(self.service, "/results/surface/point_surface").execute(*args, **kwargs) - def structural_point_surface(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/meshing_workflow/verbosity").execute(*args, **kwargs) + + class draw_settings(TUIMenu): """ - Define a "structural point" surface by specifying the coordinates. + . """ - return PyMenu(self.service, "/results/surface/structural_point_surface").execute(*args, **kwargs) - def quadric_slice(self, *args, **kwargs): + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def auto_draw(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/meshing_workflow/draw_settings/auto_draw").execute(*args, **kwargs) + def face_zone_limit(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/meshing_workflow/draw_settings/face_zone_limit").execute(*args, **kwargs) + def facet_limit(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/meshing_workflow/draw_settings/facet_limit").execute(*args, **kwargs) + + class navigation(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.mouse_mapping = self.__class__.mouse_mapping(path + [("mouse_mapping", None)], service) + super().__init__(path, service) + + class mouse_mapping(TUIMenu): """ - Extract a quadric slice. + . """ - return PyMenu(self.service, "/results/surface/quadric_slice").execute(*args, **kwargs) - def rake_surface(self, *args, **kwargs): + def __init__(self, path, service): + self.path = path + self.service = service + self.additional = self.__class__.additional(path + [("additional", None)], service) + self.basic = self.__class__.basic(path + [("basic", None)], service) + super().__init__(path, service) + def mousemaptheme(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/mousemaptheme").execute(*args, **kwargs) + + class additional(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def ctrllmbclick(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/ctrllmbclick").execute(*args, **kwargs) + def ctrllmbdrag(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/ctrllmbdrag").execute(*args, **kwargs) + def ctrlmmbclick(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/ctrlmmbclick").execute(*args, **kwargs) + def ctrlmmbdrag(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/ctrlmmbdrag").execute(*args, **kwargs) + def ctrlrmbclick(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/ctrlrmbclick").execute(*args, **kwargs) + def ctrlrmbdrag(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/ctrlrmbdrag").execute(*args, **kwargs) + def mouseprobe(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/mouseprobe").execute(*args, **kwargs) + def mousewheel(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/mousewheel").execute(*args, **kwargs) + def mousewheelsensitivity(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/mousewheelsensitivity").execute(*args, **kwargs) + def reversewheeldirection(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/reversewheeldirection").execute(*args, **kwargs) + def shiftlmbclick(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/shiftlmbclick").execute(*args, **kwargs) + def shiftlmbdrag(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/shiftlmbdrag").execute(*args, **kwargs) + def shiftmmbclick(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/shiftmmbclick").execute(*args, **kwargs) + def shiftmmbdrag(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/shiftmmbdrag").execute(*args, **kwargs) + def shiftrmbclick(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/shiftrmbclick").execute(*args, **kwargs) + def shiftrmbdrag(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/additional/shiftrmbdrag").execute(*args, **kwargs) + + class basic(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def lmb(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/basic/lmb").execute(*args, **kwargs) + def lmbclick(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/basic/lmbclick").execute(*args, **kwargs) + def mmb(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/basic/mmb").execute(*args, **kwargs) + def mmbclick(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/basic/mmbclick").execute(*args, **kwargs) + def rmb(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/basic/rmb").execute(*args, **kwargs) + def rmbclick(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/navigation/mouse_mapping/basic/rmbclick").execute(*args, **kwargs) + + class prj_app(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def advanced_flag(self, *args, **kwargs): """ - Define a "rake" surface by specifying the end points. + . """ - return PyMenu(self.service, "/results/surface/rake_surface").execute(*args, **kwargs) - def rename_surface(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/prj_app/advanced_flag").execute(*args, **kwargs) + def beta_flag(self, *args, **kwargs): """ - Rename a defined data surface. + . """ - return PyMenu(self.service, "/results/surface/rename_surface").execute(*args, **kwargs) - def sphere_slice(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/prj_app/beta_flag").execute(*args, **kwargs) + def cffoutput(self, *args, **kwargs): """ - Extract a spherical slice. + . """ - return PyMenu(self.service, "/results/surface/sphere_slice").execute(*args, **kwargs) - def ellipsoid_slice(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/prj_app/cffoutput").execute(*args, **kwargs) + def default_folder(self, *args, **kwargs): """ - Extract a ellipsoid slice. + . """ - return PyMenu(self.service, "/results/surface/ellipsoid_slice").execute(*args, **kwargs) - def cone_slice(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/prj_app/default_folder").execute(*args, **kwargs) + def display_mesh_after_case_load(self, *args, **kwargs): """ - Extract a cone slice. + . """ - return PyMenu(self.service, "/results/surface/cone_slice").execute(*args, **kwargs) - def surface_cells(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/prj_app/display_mesh_after_case_load").execute(*args, **kwargs) + def multi_console(self, *args, **kwargs): """ - Extract all cells intersected by a data surface. + . """ - return PyMenu(self.service, "/results/surface/surface_cells").execute(*args, **kwargs) - def transform_surface(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/prj_app/multi_console").execute(*args, **kwargs) + def ncpu(self, *args, **kwargs): """ - Transform surface. + . """ - return PyMenu(self.service, "/results/surface/transform_surface").execute(*args, **kwargs) - def create_imprint_surface(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/prj_app/ncpu").execute(*args, **kwargs) + def session_color(self, *args, **kwargs): """ - Imprint surface. + . """ - return PyMenu(self.service, "/results/surface/create_imprint_surface").execute(*args, **kwargs) - def zone_surface(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/prj_app/session_color").execute(*args, **kwargs) + def show_fluent_window(self, *args, **kwargs): """ - Define a data surface on a mesh zone. + . """ - return PyMenu(self.service, "/results/surface/zone_surface").execute(*args, **kwargs) - def reset_zone_surfaces(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/prj_app/show_fluent_window").execute(*args, **kwargs) + def use_default_folder(self, *args, **kwargs): """ - Reset case surface list. + . """ - return PyMenu(self.service, "/results/surface/reset_zone_surfaces").execute(*args, **kwargs) - def multiple_zone_surfaces(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/prj_app/use_default_folder").execute(*args, **kwargs) + def use_fluent_graphics(self, *args, **kwargs): """ - Create multiple data surfaces at a time. + . """ - return PyMenu(self.service, "/results/surface/multiple_zone_surfaces").execute(*args, **kwargs) - def edit_surface(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/prj_app/use_fluent_graphics").execute(*args, **kwargs) + def use_launcher(self, *args, **kwargs): """ - Edit a defined data surface. + . """ - return PyMenu(self.service, "/results/surface/edit_surface").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/prj_app/use_launcher").execute(*args, **kwargs) - class post_processing_volume(metaclass=PyMenuMeta): + class simulation(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.report_definitions = self.__class__.report_definitions(path + [("report_definitions", None)], service) + super().__init__(path, service) + def flow_model(self, *args, **kwargs): """ - Enter post-processing volume menu. + . """ - def __init__(self, path, service): - self.path = path - self.service = service - def create_from_file(self, *args, **kwargs): - """ - Read post-processing mesh from file. - """ - return PyMenu(self.service, "/results/surface/post_processing_volume/create_from_file").execute(*args, **kwargs) - def create_octree(self, *args, **kwargs): - """ - Create post-processing octree mesh based on current case. - """ - return PyMenu(self.service, "/results/surface/post_processing_volume/create_octree").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/simulation/flow_model").execute(*args, **kwargs) + def local_residual_scaling(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/simulation/local_residual_scaling").execute(*args, **kwargs) - class query(metaclass=PyMenuMeta): + class report_definitions(TUIMenu): """ - Enter surface query menu. + . """ def __init__(self, path, service): self.path = path self.service = service - def delete_query(self, *args, **kwargs): - """ - Delete saved query. - """ - return PyMenu(self.service, "/results/surface/query/delete_query").execute(*args, **kwargs) - def list_surfaces(self, *args, **kwargs): - """ - List surfaces. - """ - return PyMenu(self.service, "/results/surface/query/list_surfaces").execute(*args, **kwargs) - def named_surface_list(self, *args, **kwargs): - """ - Create named list of surfaces. - """ - return PyMenu(self.service, "/results/surface/query/named_surface_list").execute(*args, **kwargs) - def list_named_selection(self, *args, **kwargs): + super().__init__(path, service) + def automatic_plot_file(self, *args, **kwargs): """ - List named selection of surface type. + . """ - return PyMenu(self.service, "/results/surface/query/list_named_selection").execute(*args, **kwargs) - def list_queries(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/simulation/report_definitions/automatic_plot_file").execute(*args, **kwargs) + def report_plot_history_data_size(self, *args, **kwargs): """ - List all saved queries. + . """ - return PyMenu(self.service, "/results/surface/query/list_queries").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/simulation/report_definitions/report_plot_history_data_size").execute(*args, **kwargs) - class graphics_window(metaclass=PyMenuMeta): + class turbo_workflow(TUIMenu): """ - Enter graphics window menu. + . """ def __init__(self, path, service): self.path = path self.service = service - self.embedded_windows = self.__class__.embedded_windows(path + [("embedded_windows", None)], service) - self.picture = self.__class__.picture(path + [("picture", None)], service) - self.windows = self.__class__.windows(path + [("windows", None)], service) - self.titles = self.__class__.titles(path + [("titles", None)], service) - self.views = self.__class__.views(path + [("views", None)], service) - self.display_states = self.__class__.display_states(path + [("display_states", None)], service) - self.view_sync = self.__class__.view_sync(path + [("view_sync", None)], service) - def close_window(self, *args, **kwargs): - """ - Close a user graphics window. - """ - return PyMenu(self.service, "/results/graphics_window/close_window").execute(*args, **kwargs) - def close_window_by_name(self, *args, **kwargs): - """ - Close a reserved graphics window by its name. - """ - return PyMenu(self.service, "/results/graphics_window/close_window_by_name").execute(*args, **kwargs) - def open_window(self, *args, **kwargs): - """ - Open a user graphics window. - """ - return PyMenu(self.service, "/results/graphics_window/open_window").execute(*args, **kwargs) - def save_picture(self, *args, **kwargs): - """ - Generate a "hardcopy" of the active window. - """ - return PyMenu(self.service, "/results/graphics_window/save_picture").execute(*args, **kwargs) - def set_window(self, *args, **kwargs): - """ - Set a user graphics window to be the active window. - """ - return PyMenu(self.service, "/results/graphics_window/set_window").execute(*args, **kwargs) - def set_window_by_name(self, *args, **kwargs): + self.cell_zone_settings = self.__class__.cell_zone_settings(path + [("cell_zone_settings", None)], service) + self.face_zone_settings = self.__class__.face_zone_settings(path + [("face_zone_settings", None)], service) + self.graphics_settings = self.__class__.graphics_settings(path + [("graphics_settings", None)], service) + super().__init__(path, service) + def checkpointing_option(self, *args, **kwargs): """ - Set a reserved graphics window to be the active window by its name. + . """ - return PyMenu(self.service, "/results/graphics_window/set_window_by_name").execute(*args, **kwargs) - def update_layout(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/turbo_workflow/checkpointing_option").execute(*args, **kwargs) + def save_checkpoint_files(self, *args, **kwargs): """ - Update the fluent layout. + . """ - return PyMenu(self.service, "/results/graphics_window/update_layout").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/turbo_workflow/save_checkpoint_files").execute(*args, **kwargs) - class embedded_windows(metaclass=PyMenuMeta): + class cell_zone_settings(TUIMenu): """ - Enter to embed, close, move-out embedded windows. + . """ def __init__(self, path, service): self.path = path self.service = service - def close(self, *args, **kwargs): - """ - Close an embedded window. - """ - return PyMenu(self.service, "/results/graphics_window/embedded_windows/close").execute(*args, **kwargs) - def close_all(self, *args, **kwargs): - """ - Close all embedded windows for given parent window. - """ - return PyMenu(self.service, "/results/graphics_window/embedded_windows/close_all").execute(*args, **kwargs) - def embed_in(self, *args, **kwargs): + super().__init__(path, service) + def czsearch_order(self, *args, **kwargs): """ - Embed Window into another window. + . """ - return PyMenu(self.service, "/results/graphics_window/embedded_windows/embed_in").execute(*args, **kwargs) - def move_out(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/turbo_workflow/cell_zone_settings/czsearch_order").execute(*args, **kwargs) + def rotating(self, *args, **kwargs): """ - Move out an embedded window. + . """ - return PyMenu(self.service, "/results/graphics_window/embedded_windows/move_out").execute(*args, **kwargs) - def move_out_all(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/turbo_workflow/cell_zone_settings/rotating").execute(*args, **kwargs) + def stationary(self, *args, **kwargs): """ - Move out all embedded windows for given parent window. + . """ - return PyMenu(self.service, "/results/graphics_window/embedded_windows/move_out_all").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/turbo_workflow/cell_zone_settings/stationary").execute(*args, **kwargs) - class picture(metaclass=PyMenuMeta): + class face_zone_settings(TUIMenu): """ - Enter the hardcopy/save-picture options menu. + . """ def __init__(self, path, service): self.path = path self.service = service - self.color_mode = self.__class__.color_mode(path + [("color_mode", None)], service) - self.driver = self.__class__.driver(path + [("driver", None)], service) - def invert_background(self, *args, **kwargs): + super().__init__(path, service) + def blade_region(self, *args, **kwargs): """ - Use a white background when the picture is saved. + . """ - return PyMenu(self.service, "/results/graphics_window/picture/invert_background").execute(*args, **kwargs) - def landscape(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/blade_region").execute(*args, **kwargs) + def fzsearch_order(self, *args, **kwargs): """ - Plot hardcopies in landscape or portrait orientation. + . """ - return PyMenu(self.service, "/results/graphics_window/picture/landscape").execute(*args, **kwargs) - def preview(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/fzsearch_order").execute(*args, **kwargs) + def hub_region(self, *args, **kwargs): """ - Display a preview image of a hardcopy. + . """ - return PyMenu(self.service, "/results/graphics_window/picture/preview").execute(*args, **kwargs) - def x_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/hub_region").execute(*args, **kwargs) + def inlet_region(self, *args, **kwargs): """ - Set the width of raster-formatted images in pixels (0 implies current window size). + . """ - return PyMenu(self.service, "/results/graphics_window/picture/x_resolution").execute(*args, **kwargs) - def y_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/inlet_region").execute(*args, **kwargs) + def interior_region(self, *args, **kwargs): """ - Set the height of raster-formatted images in pixels (0 implies current window size). + . """ - return PyMenu(self.service, "/results/graphics_window/picture/y_resolution").execute(*args, **kwargs) - def dpi(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/interior_region").execute(*args, **kwargs) + def outlet_region(self, *args, **kwargs): """ - Set the DPI for EPS and Postscript files, specifies the resolution in dots per inch (DPI) instead of setting the width and height. + . """ - return PyMenu(self.service, "/results/graphics_window/picture/dpi").execute(*args, **kwargs) - def use_window_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/outlet_region").execute(*args, **kwargs) + def periodic1_region(self, *args, **kwargs): """ - Use the currently active window's resolution for hardcopy (ignores the x-resolution and y-resolution in this case). + . """ - return PyMenu(self.service, "/results/graphics_window/picture/use_window_resolution").execute(*args, **kwargs) - def set_standard_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/periodic1_region").execute(*args, **kwargs) + def periodic2_region(self, *args, **kwargs): """ - Select from pre-defined resolution list. + . """ - return PyMenu(self.service, "/results/graphics_window/picture/set_standard_resolution").execute(*args, **kwargs) - def jpeg_hardcopy_quality(self, *args, **kwargs): + return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/periodic2_region").execute(*args, **kwargs) + def shroud_region(self, *args, **kwargs): """ - To set jpeg hardcopy quality. + . """ - return PyMenu(self.service, "/results/graphics_window/picture/jpeg_hardcopy_quality").execute(*args, **kwargs) - - class color_mode(metaclass=PyMenuMeta): + return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/shroud_region").execute(*args, **kwargs) + def symmetry_region(self, *args, **kwargs): """ - Enter the hardcopy color mode menu. + . """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Plot hardcopies in color. - """ - return PyMenu(self.service, "/results/graphics_window/picture/color_mode/color").execute(*args, **kwargs) - def gray_scale(self, *args, **kwargs): - """ - Convert color to grayscale for hardcopy. - """ - return PyMenu(self.service, "/results/graphics_window/picture/color_mode/gray_scale").execute(*args, **kwargs) - def mono_chrome(self, *args, **kwargs): - """ - Convert color to monochrome (black and white) for hardcopy. - """ - return PyMenu(self.service, "/results/graphics_window/picture/color_mode/mono_chrome").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Display the current hardcopy color mode. - """ - return PyMenu(self.service, "/results/graphics_window/picture/color_mode/list").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/symmetry_region").execute(*args, **kwargs) + def tip1_region(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/tip1_region").execute(*args, **kwargs) + def tip2_region(self, *args, **kwargs): + """ + . + """ + return PyMenu(self.service, "/preferences/turbo_workflow/face_zone_settings/tip2_region").execute(*args, **kwargs) - class driver(metaclass=PyMenuMeta): + class graphics_settings(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def auto_draw(self, *args, **kwargs): """ - Enter the set hardcopy driver menu. + . """ - def __init__(self, path, service): - self.path = path - self.service = service - self.post_format = self.__class__.post_format(path + [("post_format", None)], service) - def dump_window(self, *args, **kwargs): - """ - Set the command used to dump the graphics window to a file. - """ - return PyMenu(self.service, "/results/graphics_window/picture/driver/dump_window").execute(*args, **kwargs) - def eps(self, *args, **kwargs): - """ - Produce encapsulated PostScript (EPS) output for hardcopies. - """ - return PyMenu(self.service, "/results/graphics_window/picture/driver/eps").execute(*args, **kwargs) - def jpeg(self, *args, **kwargs): - """ - Produce JPEG output for hardcopies. - """ - return PyMenu(self.service, "/results/graphics_window/picture/driver/jpeg").execute(*args, **kwargs) - def post_script(self, *args, **kwargs): - """ - Produce PostScript output for hardcopies. - """ - return PyMenu(self.service, "/results/graphics_window/picture/driver/post_script").execute(*args, **kwargs) - def ppm(self, *args, **kwargs): - """ - Produce PPM output for hardcopies. - """ - return PyMenu(self.service, "/results/graphics_window/picture/driver/ppm").execute(*args, **kwargs) - def tiff(self, *args, **kwargs): - """ - Use TIFF output for hardcopies. - """ - return PyMenu(self.service, "/results/graphics_window/picture/driver/tiff").execute(*args, **kwargs) - def png(self, *args, **kwargs): - """ - Use PNG output for hardcopies. - """ - return PyMenu(self.service, "/results/graphics_window/picture/driver/png").execute(*args, **kwargs) - def hsf(self, *args, **kwargs): - """ - Use HSF output for hardcopies. - """ - return PyMenu(self.service, "/results/graphics_window/picture/driver/hsf").execute(*args, **kwargs) - def avz(self, *args, **kwargs): - """ - Use AVZ output for hardcopies. - """ - return PyMenu(self.service, "/results/graphics_window/picture/driver/avz").execute(*args, **kwargs) - def glb(self, *args, **kwargs): - """ - Use GLB output for hardcopies. - """ - return PyMenu(self.service, "/results/graphics_window/picture/driver/glb").execute(*args, **kwargs) - def vrml(self, *args, **kwargs): - """ - Use VRML output for hardcopies. - """ - return PyMenu(self.service, "/results/graphics_window/picture/driver/vrml").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - List the current hardcopy driver. - """ - return PyMenu(self.service, "/results/graphics_window/picture/driver/list").execute(*args, **kwargs) - def options(self, *args, **kwargs): - """ - Set the hardcopy options. Available options are: - \\n "no gamma correction", disables gamma correction of colors, - \\n "physical size = (width,height)", where width and height - are the actual measurements of the printable area of the page - in centimeters. - \\n "subscreen = (left,right,bottom,top)", where left,right, - bottom, and top are numbers in [-1,1] describing a subwindow on - the page in which to place the hardcopy. - - \\n The options may be combined by separating them with commas. - """ - return PyMenu(self.service, "/results/graphics_window/picture/driver/options").execute(*args, **kwargs) + return PyMenu(self.service, "/preferences/turbo_workflow/graphics_settings/auto_draw").execute(*args, **kwargs) - class post_format(metaclass=PyMenuMeta): - """ - Enter the PostScript driver format menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def fast_raster(self, *args, **kwargs): - """ - Use the new raster format. - """ - return PyMenu(self.service, "/results/graphics_window/picture/driver/post_format/fast_raster").execute(*args, **kwargs) - def raster(self, *args, **kwargs): - """ - Use the original raster format. - """ - return PyMenu(self.service, "/results/graphics_window/picture/driver/post_format/raster").execute(*args, **kwargs) - def rle_raster(self, *args, **kwargs): - """ - Use the run-length encoded raster format. - """ - return PyMenu(self.service, "/results/graphics_window/picture/driver/post_format/rle_raster").execute(*args, **kwargs) - def vector(self, *args, **kwargs): - """ - Use vector format. - """ - return PyMenu(self.service, "/results/graphics_window/picture/driver/post_format/vector").execute(*args, **kwargs) + class report(TUIMenu): + """ + Enter the report menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.dpm_histogram = self.__class__.dpm_histogram(path + [("dpm_histogram", None)], service) + self.fluxes = self.__class__.fluxes(path + [("fluxes", None)], service) + self.forces = self.__class__.forces(path + [("forces", None)], service) + self.reference_values = self.__class__.reference_values(path + [("reference_values", None)], service) + self.surface_integrals = self.__class__.surface_integrals(path + [("surface_integrals", None)], service) + self.volume_integrals = self.__class__.volume_integrals(path + [("volume_integrals", None)], service) + self.modified_setting = self.__class__.modified_setting(path + [("modified_setting", None)], service) + self.population_balance = self.__class__.population_balance(path + [("population_balance", None)], service) + self.heat_exchanger = self.__class__.heat_exchanger(path + [("heat_exchanger", None)], service) + self.system = self.__class__.system(path + [("system", None)], service) + self.simulation_reports = self.__class__.simulation_reports(path + [("simulation_reports", None)], service) + super().__init__(path, service) + def aero_optical_distortions(self, *args, **kwargs): + """ + Optics report menu. + """ + return PyMenu(self.service, "/report/aero_optical_distortions").execute(*args, **kwargs) + def dpm_summary(self, *args, **kwargs): + """ + Prints discrete phase summary report. + """ + return PyMenu(self.service, "/report/dpm_summary").execute(*args, **kwargs) + def dpm_extended_summary(self, *args, **kwargs): + """ + Create an extended discrete phase summary report of the discrete phase injection(s). You can choose whether you want to save the extended report to a file or print it in the console window. For unsteady tracking, you will be asked whether you want to include in-domain particle/tracks in the report. You will be also prompted whether you want to select a single injection for the summary report. By default, all injections are included. The output depends on whether you have enabled the report/dpm-zone-summaries-per-injection? text command, in which case additional information is printed for escaped particles, such as per-injection data. Note that, for unsteady particle tracking, it is necessary to enable the report/dpm-zone-summaries-per-injection? text command before any particle parcels are injected into the domain. + """ + return PyMenu(self.service, "/report/dpm_extended_summary").execute(*args, **kwargs) + def dpm_zone_summaries_per_injection(self, *args, **kwargs): + """ + Enables/disables calculation of the escaped mass per injection. Note that for unsteady particle tracking, if you want to report the mass of escaped particles per injection, this text command must be enabled before any particles are injected into the domain. + """ + return PyMenu(self.service, "/report/dpm_zone_summaries_per_injection").execute(*args, **kwargs) + def dpm_sample(self, *args, **kwargs): + """ + Samples trajectories at boundaries and lines/planes. + """ + return PyMenu(self.service, "/report/dpm_sample").execute(*args, **kwargs) + def dpm_sample_output_udf(self, *args, **kwargs): + """ + Allows you to hook a previously loaded DEFINE_DPM_OUTPUT UDF for file format specification for sampling of trajectories and VOF-to-DPM lump conversion transcripts. + """ + return PyMenu(self.service, "/report/dpm_sample_output_udf").execute(*args, **kwargs) + def dpm_sample_sort_file(self, *args, **kwargs): + """ + Enables/disables writing of sorted DPM sample files. + """ + return PyMenu(self.service, "/report/dpm_sample_sort_file").execute(*args, **kwargs) + def particle_summary(self, *args, **kwargs): + """ + Prints summary report for all current particles. + """ + return PyMenu(self.service, "/report/particle_summary").execute(*args, **kwargs) + def path_line_summary(self, *args, **kwargs): + """ + Prints pathline summary report. + """ + return PyMenu(self.service, "/report/path_line_summary").execute(*args, **kwargs) + def print_histogram(self, *args, **kwargs): + """ + Prints a histogram of a scalar quantity. + """ + return PyMenu(self.service, "/report/print_histogram").execute(*args, **kwargs) + def write_histogram(self, *args, **kwargs): + """ + Write a histogram of a scalar quantity to a file. + """ + return PyMenu(self.service, "/report/write_histogram").execute(*args, **kwargs) + def projected_surface_area(self, *args, **kwargs): + """ + Computes the area of the projection of selected surfaces along the , , or axis. + """ + return PyMenu(self.service, "/report/projected_surface_area").execute(*args, **kwargs) + def species_mass_flow(self, *args, **kwargs): + """ + Prints list of species mass flow rate at inlets and outlets. This reports the mass flow rates of all species (in kg/s) flowing through the simulation boundaries. + """ + return PyMenu(self.service, "/report/species_mass_flow").execute(*args, **kwargs) + def element_mass_flow(self, *args, **kwargs): + """ + Prints list of element flow rate at inlets and outlets. This reports the mass flow rates of all chemical elements (in kg/s) flowing through the simulation boundaries. + """ + return PyMenu(self.service, "/report/element_mass_flow").execute(*args, **kwargs) + def summary(self, *args, **kwargs): + """ + Prints the current settings for physical models, boundary conditions, material properties, and solution parameters. + """ + return PyMenu(self.service, "/report/summary").execute(*args, **kwargs) + def uds_flow(self, *args, **kwargs): + """ + Prints list of user-defined scalar flow rate at boundaries. + """ + return PyMenu(self.service, "/report/uds_flow").execute(*args, **kwargs) + def mphase_summary(self, *args, **kwargs): + """ + Prints summary report for a multiphase case setup. + """ + return PyMenu(self.service, "/report/mphase_summary").execute(*args, **kwargs) + + class dpm_histogram(TUIMenu): + """ + Enters the DPM histogram menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.set = self.__class__.set(path + [("set", None)], service) + self.setup_reduction = self.__class__.setup_reduction(path + [("setup_reduction", None)], service) + super().__init__(path, service) + def compute_sample(self, *args, **kwargs): + """ + Computes the minimum/maximum of a sample variable. + """ + return PyMenu(self.service, "/report/dpm_histogram/compute_sample").execute(*args, **kwargs) + def delete_sample(self, *args, **kwargs): + """ + Deletes a sample from the loaded sample list. + """ + return PyMenu(self.service, "/report/dpm_histogram/delete_sample").execute(*args, **kwargs) + def list_samples(self, *args, **kwargs): + """ + Shows all samples in a loaded sample list. + """ + return PyMenu(self.service, "/report/dpm_histogram/list_samples").execute(*args, **kwargs) + def plot_sample(self, *args, **kwargs): + """ + Plots a histogram of a loaded sample. + """ + return PyMenu(self.service, "/report/dpm_histogram/plot_sample").execute(*args, **kwargs) + def read_sample(self, *args, **kwargs): + """ + Reads a sample file and adds it to the sample list. + """ + return PyMenu(self.service, "/report/dpm_histogram/read_sample").execute(*args, **kwargs) + def write_sample(self, *args, **kwargs): + """ + Write a histogram of a loaded sample into a file. + """ + return PyMenu(self.service, "/report/dpm_histogram/write_sample").execute(*args, **kwargs) + def pick_sample_to_reduce(self, *args, **kwargs): + """ + Select a sample to be reduced. + """ + return PyMenu(self.service, "/report/dpm_histogram/pick_sample_to_reduce").execute(*args, **kwargs) + def reduce_picked_sample(self, *args, **kwargs): + """ + Reduce a sample as specified by the data reduction parameters. This command is available only after you selected the sample using the pick-sample-to-reduce text command. + """ + return PyMenu(self.service, "/report/dpm_histogram/reduce_picked_sample").execute(*args, **kwargs) - class windows(metaclass=PyMenuMeta): + class set(TUIMenu): """ - Enter the window options menu. + Enters the settings menu for the histogram. """ def __init__(self, path, service): self.path = path self.service = service - self.axes = self.__class__.axes(path + [("axes", None)], service) - self.main = self.__class__.main(path + [("main", None)], service) - self.scale = self.__class__.scale(path + [("scale", None)], service) - self.text = self.__class__.text(path + [("text", None)], service) - self.video = self.__class__.video(path + [("video", None)], service) - self.xy = self.__class__.xy(path + [("xy", None)], service) - def aspect_ratio(self, *args, **kwargs): + super().__init__(path, service) + def auto_range(self, *args, **kwargs): """ - Set the aspect ratio of the active window. + Automatically computes the range of the sampling variable for histogram plots. """ - return PyMenu(self.service, "/results/graphics_window/windows/aspect_ratio").execute(*args, **kwargs) - def logo(self, *args, **kwargs): + return PyMenu(self.service, "/report/dpm_histogram/set/auto_range").execute(*args, **kwargs) + def correlation(self, *args, **kwargs): """ - Enable/disable visibility of the logo in graphics window. + Computes the correlation of the sampling variable with another variable. """ - return PyMenu(self.service, "/results/graphics_window/windows/logo").execute(*args, **kwargs) - def ruler(self, *args, **kwargs): + return PyMenu(self.service, "/report/dpm_histogram/set/correlation").execute(*args, **kwargs) + def cumulation_curve(self, *args, **kwargs): """ - Enable/disable ruler visibility. + Computes a cumulative curve for the sampling variable or correlation variable when correlation? is specified. """ - return PyMenu(self.service, "/results/graphics_window/windows/ruler").execute(*args, **kwargs) - def logo_color(self, *args, **kwargs): + return PyMenu(self.service, "/report/dpm_histogram/set/cumulation_curve").execute(*args, **kwargs) + def diameter_statistics(self, *args, **kwargs): """ - Set logo color to white/black. + Computes the Rosin Rammler parameters, Sauter, and other mean diameters. """ - return PyMenu(self.service, "/results/graphics_window/windows/logo_color").execute(*args, **kwargs) - - class axes(metaclass=PyMenuMeta): + return PyMenu(self.service, "/report/dpm_histogram/set/diameter_statistics").execute(*args, **kwargs) + def histogram_mode(self, *args, **kwargs): """ - Enter the axes window options menu. + Uses bars for the histogram plot or xy-style. """ - def __init__(self, path, service): - self.path = path - self.service = service - def border(self, *args, **kwargs): - """ - Enable/disable drawing of a border around the axes window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/axes/border").execute(*args, **kwargs) - def bottom(self, *args, **kwargs): - """ - Set the bottom boundary of the axes window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/axes/bottom").execute(*args, **kwargs) - def clear(self, *args, **kwargs): - """ - Set the transparency of the axes window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/axes/clear").execute(*args, **kwargs) - def right(self, *args, **kwargs): - """ - Set the right boundary of the axes window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/axes/right").execute(*args, **kwargs) - def visible(self, *args, **kwargs): - """ - Enable/disable axes visibility. - """ - return PyMenu(self.service, "/results/graphics_window/windows/axes/visible").execute(*args, **kwargs) - - class main(metaclass=PyMenuMeta): + return PyMenu(self.service, "/report/dpm_histogram/set/histogram_mode").execute(*args, **kwargs) + def minimum(self, *args, **kwargs): """ - Enter the main view window options menu. + Specifies the minimum value of the x-axis variable for histogram plots. """ - def __init__(self, path, service): - self.path = path - self.service = service - def border(self, *args, **kwargs): - """ - Enable/disable drawing of borders around the main viewing window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/main/border").execute(*args, **kwargs) - def bottom(self, *args, **kwargs): - """ - Set the bottom boundary of the main viewing window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/main/bottom").execute(*args, **kwargs) - def left(self, *args, **kwargs): - """ - Set the left boundary of the main viewing window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/main/left").execute(*args, **kwargs) - def right(self, *args, **kwargs): - """ - Set the right boundary of the main viewing window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/main/right").execute(*args, **kwargs) - def top(self, *args, **kwargs): - """ - Set the top boundary of the main viewing window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/main/top").execute(*args, **kwargs) - def visible(self, *args, **kwargs): - """ - Enable/disable visibility of the main viewing window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/main/visible").execute(*args, **kwargs) - - class scale(metaclass=PyMenuMeta): + return PyMenu(self.service, "/report/dpm_histogram/set/minimum").execute(*args, **kwargs) + def maximum(self, *args, **kwargs): """ - Enter the color scale window options menu. + Specifies the maximum value of the x-axis variable for histogram plots. """ - def __init__(self, path, service): - self.path = path - self.service = service - def border(self, *args, **kwargs): - """ - Enable/disable drawing of borders around the color scale window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/scale/border").execute(*args, **kwargs) - def bottom(self, *args, **kwargs): - """ - Set the bottom boundary of the color scale window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/scale/bottom").execute(*args, **kwargs) - def clear(self, *args, **kwargs): - """ - Set the transparency of the scale window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/scale/clear").execute(*args, **kwargs) - def format(self, *args, **kwargs): - """ - Set the number format of the color scale window (e.g. %0.2e). - """ - return PyMenu(self.service, "/results/graphics_window/windows/scale/format").execute(*args, **kwargs) - def font_size(self, *args, **kwargs): - """ - Set the font size of the color scale window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/scale/font_size").execute(*args, **kwargs) - def left(self, *args, **kwargs): - """ - Set the left boundary of the color scale window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/scale/left").execute(*args, **kwargs) - def margin(self, *args, **kwargs): - """ - Set the margin of the color scale window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/scale/margin").execute(*args, **kwargs) - def right(self, *args, **kwargs): - """ - Set the right boundary of the color scale window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/scale/right").execute(*args, **kwargs) - def top(self, *args, **kwargs): - """ - Set the top boundary of the color scale window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/scale/top").execute(*args, **kwargs) - def visible(self, *args, **kwargs): - """ - Enable/disable visibility of the color scale window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/scale/visible").execute(*args, **kwargs) - def alignment(self, *args, **kwargs): - """ - Set colormap to bottom/left/top/right. - """ - return PyMenu(self.service, "/results/graphics_window/windows/scale/alignment").execute(*args, **kwargs) - - class text(metaclass=PyMenuMeta): + return PyMenu(self.service, "/report/dpm_histogram/set/maximum").execute(*args, **kwargs) + def number_of_bins(self, *args, **kwargs): """ - Enter the text window options menu. + Specifies the number of bins. """ - def __init__(self, path, service): - self.path = path - self.service = service - def application(self, *args, **kwargs): - """ - Enable/disable the application name in the picture. - """ - return PyMenu(self.service, "/results/graphics_window/windows/text/application").execute(*args, **kwargs) - def border(self, *args, **kwargs): - """ - Enable/disable drawing of borders around the text window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/text/border").execute(*args, **kwargs) - def bottom(self, *args, **kwargs): - """ - Set the bottom boundary of the text window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/text/bottom").execute(*args, **kwargs) - def clear(self, *args, **kwargs): - """ - Enable/disable text window transparency. - """ - return PyMenu(self.service, "/results/graphics_window/windows/text/clear").execute(*args, **kwargs) - def company(self, *args, **kwargs): - """ - Enable/disable the company name in the picture. - """ - return PyMenu(self.service, "/results/graphics_window/windows/text/company").execute(*args, **kwargs) - def date(self, *args, **kwargs): - """ - Enable/disable the date in the picture. - """ - return PyMenu(self.service, "/results/graphics_window/windows/text/date").execute(*args, **kwargs) - def left(self, *args, **kwargs): - """ - Set the left boundary of the text window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/text/left").execute(*args, **kwargs) - def right(self, *args, **kwargs): - """ - Set the right boundary of the text window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/text/right").execute(*args, **kwargs) - def top(self, *args, **kwargs): - """ - Set the top boundary of the text window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/text/top").execute(*args, **kwargs) - def visible(self, *args, **kwargs): - """ - Enable/disable text window transparency. - """ - return PyMenu(self.service, "/results/graphics_window/windows/text/visible").execute(*args, **kwargs) - - class video(metaclass=PyMenuMeta): + return PyMenu(self.service, "/report/dpm_histogram/set/number_of_bins").execute(*args, **kwargs) + def percentage(self, *args, **kwargs): """ - Enter the video window options menu. + Uses percentages of bins to be computed. """ - def __init__(self, path, service): - self.path = path - self.service = service - def background(self, *args, **kwargs): - """ - Set the background color in the video picture. - """ - return PyMenu(self.service, "/results/graphics_window/windows/video/background").execute(*args, **kwargs) - def color_filter(self, *args, **kwargs): - """ - Set the color filter options for the picture. - """ - return PyMenu(self.service, "/results/graphics_window/windows/video/color_filter").execute(*args, **kwargs) - def foreground(self, *args, **kwargs): - """ - Set the foreground color in the video picture. - """ - return PyMenu(self.service, "/results/graphics_window/windows/video/foreground").execute(*args, **kwargs) - def on(self, *args, **kwargs): - """ - Enable/disable video picture settings. - """ - return PyMenu(self.service, "/results/graphics_window/windows/video/on").execute(*args, **kwargs) - def pixel_size(self, *args, **kwargs): - """ - Set the window size in pixels. - """ - return PyMenu(self.service, "/results/graphics_window/windows/video/pixel_size").execute(*args, **kwargs) + return PyMenu(self.service, "/report/dpm_histogram/set/percentage").execute(*args, **kwargs) + def variable_power_3(self, *args, **kwargs): + """ + Use the cubic of the cumulation variable during computation of the cumulative curve. + When the particle mass was not sampled, the diameter can be used instead. + """ + return PyMenu(self.service, "/report/dpm_histogram/set/variable_power_3").execute(*args, **kwargs) + def logarithmic(self, *args, **kwargs): + """ + Enables/disables the use of logarithmic scaling on the abscissa of the histogram. + """ + return PyMenu(self.service, "/report/dpm_histogram/set/logarithmic").execute(*args, **kwargs) + def weighting(self, *args, **kwargs): + """ + Uses weighting with additional variables when sorting data into samples. + """ + return PyMenu(self.service, "/report/dpm_histogram/set/weighting").execute(*args, **kwargs) - class xy(metaclass=PyMenuMeta): + class setup_reduction(TUIMenu): + """ + Set up the sample data reduction by specifying all relevant options and setting parameters as desired. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def use_weighting(self, *args, **kwargs): """ - Enter the X-Y plot window options menu. + Specify whether to use any weighting in the averaging that is done in each bin in the data reduction. """ - def __init__(self, path, service): - self.path = path - self.service = service - def border(self, *args, **kwargs): - """ - Enable/disable drawing of a border around the X-Y plotter window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/xy/border").execute(*args, **kwargs) - def bottom(self, *args, **kwargs): - """ - Set the bottom boundary of the X-Y plotter window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/xy/bottom").execute(*args, **kwargs) - def left(self, *args, **kwargs): - """ - Set the left boundary of the X-Y plotter window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/xy/left").execute(*args, **kwargs) - def right(self, *args, **kwargs): - """ - Set the right boundary of the X-Y plotter window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/xy/right").execute(*args, **kwargs) - def top(self, *args, **kwargs): - """ - Set the top boundary of the X-Y plotter window. - """ - return PyMenu(self.service, "/results/graphics_window/windows/xy/top").execute(*args, **kwargs) - def visible(self, *args, **kwargs): - """ - Enable/disable X-Y plotter window visibility. - """ - return PyMenu(self.service, "/results/graphics_window/windows/xy/visible").execute(*args, **kwargs) + return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/use_weighting").execute(*args, **kwargs) + def weighting_variable(self, *args, **kwargs): + """ + Choose the weighting variable for the averaging in each bin in the data reduction. + """ + return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/weighting_variable").execute(*args, **kwargs) + def make_steady_from_unsteady_file(self, *args, **kwargs): + """ + Specify whether the unsteady sample is to be reduced into a steady-state injection file. + """ + return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/make_steady_from_unsteady_file").execute(*args, **kwargs) + def reset_min_and_max(self, *args, **kwargs): + """ + Reset the min and max values of the range to be considered for a specific variable in the data reduction. + """ + return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/reset_min_and_max").execute(*args, **kwargs) + def minimum(self, *args, **kwargs): + """ + Set the minimum value of the range to be considered for a specific variable in the data reduction. + """ + return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/minimum").execute(*args, **kwargs) + def maximum(self, *args, **kwargs): + """ + Set the maximum value of the range to be considered for a specific variable in the data reduction. + """ + return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/maximum").execute(*args, **kwargs) + def logarithmic(self, *args, **kwargs): + """ + Switch on or off logarithmic scaling to be used for a specific variable in the data reduction. + """ + return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/logarithmic").execute(*args, **kwargs) + def number_of_bins(self, *args, **kwargs): + """ + Set the number of bins to be used for a specific variable in the data reduction. + """ + return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/number_of_bins").execute(*args, **kwargs) + def all_variables_number_of_bins(self, *args, **kwargs): + """ + Set the number of bins to be used for ALL variables in the data reduction. + """ + return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/all_variables_number_of_bins").execute(*args, **kwargs) + def list_settings(self, *args, **kwargs): + """ + List all user inputs for the sample picked for data reduction. + """ + return PyMenu(self.service, "/report/dpm_histogram/setup_reduction/list_settings").execute(*args, **kwargs) - class titles(metaclass=PyMenuMeta): + class fluxes(TUIMenu): + """ + Enters the fluxes menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def mass_flow(self, *args, **kwargs): """ - Set problem title. + Prints mass flow rate at inlets and outlets. + """ + return PyMenu(self.service, "/report/fluxes/mass_flow").execute(*args, **kwargs) + def heat_transfer(self, *args, **kwargs): + """ + Prints heat transfer rate at boundaries. + """ + return PyMenu(self.service, "/report/fluxes/heat_transfer").execute(*args, **kwargs) + def heat_transfer_sensible(self, *args, **kwargs): + """ + Prints the sensible heat transfer rate at the boundaries. + """ + return PyMenu(self.service, "/report/fluxes/heat_transfer_sensible").execute(*args, **kwargs) + def rad_heat_trans(self, *args, **kwargs): + """ + Prints radiation heat transfer rate at boundaries. + """ + return PyMenu(self.service, "/report/fluxes/rad_heat_trans").execute(*args, **kwargs) + def film_mass_flow(self, *args, **kwargs): + """ + Prints wall film mass flow rate at boundaries. This text command is only available when you enable the Eulerian wall film model. + """ + return PyMenu(self.service, "/report/fluxes/film_mass_flow").execute(*args, **kwargs) + def film_heat_transfer(self, *args, **kwargs): + """ + Prints wall film heat transfer rate at boundaries. This text command is only available when you enable the Eulerian wall film model. + """ + return PyMenu(self.service, "/report/fluxes/film_heat_transfer").execute(*args, **kwargs) + def pressure_work(self, *args, **kwargs): + """ + Prints the pressure work rate at the boundaries. This text command is only available when the energy equation is enabled, the absolute velocity formulation is selected, and zone motion is enabled for a fluid cell zone. + """ + return PyMenu(self.service, "/report/fluxes/pressure_work").execute(*args, **kwargs) + def viscous_work(self, *args, **kwargs): + """ + Prints the viscous work rate at the boundaries. This text command is only available when the energy equation is enabled and the pressure-based solver is selected. + """ + return PyMenu(self.service, "/report/fluxes/viscous_work").execute(*args, **kwargs) + + class forces(TUIMenu): + """ + Enters the forces menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def wall_forces(self, *args, **kwargs): + """ + Computes the forces along the specified force vector for all wall zones. + """ + return PyMenu(self.service, "/report/forces/wall_forces").execute(*args, **kwargs) + def wall_moments(self, *args, **kwargs): + """ + Computes the moments about the specified moment center for all wall zones. + """ + return PyMenu(self.service, "/report/forces/wall_moments").execute(*args, **kwargs) + def pressure_center(self, *args, **kwargs): + """ + Prints the center of pressure on wall zones. + """ + return PyMenu(self.service, "/report/forces/pressure_center").execute(*args, **kwargs) + + class reference_values(TUIMenu): + """ + Enters the reference value menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.compute = self.__class__.compute(path + [("compute", None)], service) + super().__init__(path, service) + def area(self, *args, **kwargs): + """ + Sets reference area for normalization. + """ + return PyMenu(self.service, "/report/reference_values/area").execute(*args, **kwargs) + def depth(self, *args, **kwargs): + """ + Sets reference depth for volume calculation. + """ + return PyMenu(self.service, "/report/reference_values/depth").execute(*args, **kwargs) + def density(self, *args, **kwargs): + """ + Sets reference density for normalization. + """ + return PyMenu(self.service, "/report/reference_values/density").execute(*args, **kwargs) + def enthalpy(self, *args, **kwargs): + """ + Sets reference enthalpy for enthalpy damping and normalization. + """ + return PyMenu(self.service, "/report/reference_values/enthalpy").execute(*args, **kwargs) + def length(self, *args, **kwargs): + """ + Sets reference length for normalization. + """ + return PyMenu(self.service, "/report/reference_values/length").execute(*args, **kwargs) + def pressure(self, *args, **kwargs): + """ + Sets reference pressure for normalization. + """ + return PyMenu(self.service, "/report/reference_values/pressure").execute(*args, **kwargs) + def temperature(self, *args, **kwargs): + """ + Sets reference temperature for normalization. + """ + return PyMenu(self.service, "/report/reference_values/temperature").execute(*args, **kwargs) + def yplus(self, *args, **kwargs): + """ + Sets reference yplus for calculation of Yplus Based Heat Transfer Coefficient. + """ + return PyMenu(self.service, "/report/reference_values/yplus").execute(*args, **kwargs) + def velocity(self, *args, **kwargs): + """ + Sets reference velocity for normalization. + """ + return PyMenu(self.service, "/report/reference_values/velocity").execute(*args, **kwargs) + def viscosity(self, *args, **kwargs): + """ + Sets reference viscosity for normalization. + """ + return PyMenu(self.service, "/report/reference_values/viscosity").execute(*args, **kwargs) + def zone(self, *args, **kwargs): + """ + Sets reference zone. + """ + return PyMenu(self.service, "/report/reference_values/zone").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Lists current reference values. + """ + return PyMenu(self.service, "/report/reference_values/list").execute(*args, **kwargs) + + class compute(TUIMenu): + """ + Computes reference values from zone boundary conditions. """ def __init__(self, path, service): self.path = path self.service = service - def left_top(self, *args, **kwargs): + super().__init__(path, service) + def axis(self, *args, **kwargs): """ - Set the title text for left top in title segment. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/results/graphics_window/titles/left_top").execute(*args, **kwargs) - def left_bottom(self, *args, **kwargs): + return PyMenu(self.service, "/report/reference_values/compute/axis").execute(*args, **kwargs) + def degassing(self, *args, **kwargs): """ - Set the title text for left bottom in title segment. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/results/graphics_window/titles/left_bottom").execute(*args, **kwargs) - def right_top(self, *args, **kwargs): + return PyMenu(self.service, "/report/reference_values/compute/degassing").execute(*args, **kwargs) + def dummy_entry(self, *args, **kwargs): """ - Set the title text for right top in title segment. + . """ - return PyMenu(self.service, "/results/graphics_window/titles/right_top").execute(*args, **kwargs) - def right_middle(self, *args, **kwargs): + return PyMenu(self.service, "/report/reference_values/compute/dummy_entry").execute(*args, **kwargs) + def exhaust_fan(self, *args, **kwargs): """ - Set the title text for right middle in title segment. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/results/graphics_window/titles/right_middle").execute(*args, **kwargs) - def right_bottom(self, *args, **kwargs): + return PyMenu(self.service, "/report/reference_values/compute/exhaust_fan").execute(*args, **kwargs) + def fan(self, *args, **kwargs): """ - Set the title text for right bottom in title segment. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/results/graphics_window/titles/right_bottom").execute(*args, **kwargs) - - class views(metaclass=PyMenuMeta): - """ - Enter the view manipulation menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.camera = self.__class__.camera(path + [("camera", None)], service) - def auto_scale(self, *args, **kwargs): + return PyMenu(self.service, "/report/reference_values/compute/fan").execute(*args, **kwargs) + def fluid(self, *args, **kwargs): """ - Scale and center the current scene. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/results/graphics_window/views/auto_scale").execute(*args, **kwargs) - def default_view(self, *args, **kwargs): + return PyMenu(self.service, "/report/reference_values/compute/fluid").execute(*args, **kwargs) + def geometry(self, *args, **kwargs): """ - Reset view to front and center. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/results/graphics_window/views/default_view").execute(*args, **kwargs) - def delete_view(self, *args, **kwargs): + return PyMenu(self.service, "/report/reference_values/compute/geometry").execute(*args, **kwargs) + def inlet_vent(self, *args, **kwargs): """ - Remove a view from the list. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/results/graphics_window/views/delete_view").execute(*args, **kwargs) - def last_view(self, *args, **kwargs): + return PyMenu(self.service, "/report/reference_values/compute/inlet_vent").execute(*args, **kwargs) + def intake_fan(self, *args, **kwargs): """ - Return to the camera position before the last manipulation. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/results/graphics_window/views/last_view").execute(*args, **kwargs) - def next_view(self, *args, **kwargs): + return PyMenu(self.service, "/report/reference_values/compute/intake_fan").execute(*args, **kwargs) + def interface(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/interface").execute(*args, **kwargs) + def interior(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/interior").execute(*args, **kwargs) + def mass_flow_inlet(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/mass_flow_inlet").execute(*args, **kwargs) + def mass_flow_outlet(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/mass_flow_outlet").execute(*args, **kwargs) + def network(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/network").execute(*args, **kwargs) + def network_end(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/network_end").execute(*args, **kwargs) + def outflow(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/outflow").execute(*args, **kwargs) + def outlet_vent(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/outlet_vent").execute(*args, **kwargs) + def overset(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/overset").execute(*args, **kwargs) + def periodic(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/periodic").execute(*args, **kwargs) + def porous_jump(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/porous_jump").execute(*args, **kwargs) + def pressure_far_field(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/pressure_far_field").execute(*args, **kwargs) + def pressure_inlet(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/pressure_inlet").execute(*args, **kwargs) + def pressure_outlet(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/pressure_outlet").execute(*args, **kwargs) + def radiator(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/radiator").execute(*args, **kwargs) + def rans_les_interface(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/rans_les_interface").execute(*args, **kwargs) + def recirculation_inlet(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/recirculation_inlet").execute(*args, **kwargs) + def recirculation_outlet(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/recirculation_outlet").execute(*args, **kwargs) + def shadow(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/shadow").execute(*args, **kwargs) + def solid(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/solid").execute(*args, **kwargs) + def symmetry(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/symmetry").execute(*args, **kwargs) + def velocity_inlet(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/velocity_inlet").execute(*args, **kwargs) + def wall(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/report/reference_values/compute/wall").execute(*args, **kwargs) + + class surface_integrals(TUIMenu): + """ + Enters the surface integral menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def area(self, *args, **kwargs): + """ + Prints the area of the selected surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/area").execute(*args, **kwargs) + def area_weighted_avg(self, *args, **kwargs): + """ + Print area-weighted average of scalar on surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/area_weighted_avg").execute(*args, **kwargs) + def facet_avg(self, *args, **kwargs): + """ + Prints the facet average of the specified quantity over the selected surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/facet_avg").execute(*args, **kwargs) + def facet_max(self, *args, **kwargs): + """ + Prints the maximum of the specified quantity over facet centroids of the selected surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/facet_max").execute(*args, **kwargs) + def facet_min(self, *args, **kwargs): + """ + Prints the minimum of the specified quantity over facet centroids of the selected surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/facet_min").execute(*args, **kwargs) + def flow_rate(self, *args, **kwargs): + """ + Prints the flow rate of the specified quantity over the selected surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/flow_rate").execute(*args, **kwargs) + def integral(self, *args, **kwargs): + """ + Prints the integral of the specified quantity over the selected surfaces. You can include a wildcard (*) within the surface names. + """ + return PyMenu(self.service, "/report/surface_integrals/integral").execute(*args, **kwargs) + def mass_flow_rate(self, *args, **kwargs): + """ + Prints the mass flow rate through the selected surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/mass_flow_rate").execute(*args, **kwargs) + def mass_weighted_avg(self, *args, **kwargs): + """ + Prints the mass-averaged quantity over the selected surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/mass_weighted_avg").execute(*args, **kwargs) + def standard_deviation(self, *args, **kwargs): + """ + Prints the standard deviation of the scalar at the facet centroids of the surface. + """ + return PyMenu(self.service, "/report/surface_integrals/standard_deviation").execute(*args, **kwargs) + def sum(self, *args, **kwargs): + """ + Prints sum of scalar at facet centroids of the surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/sum").execute(*args, **kwargs) + def uniformity_index_area_weighted(self, *args, **kwargs): + """ + Prints the area-weighted uniformity index of the specified quantity over the selected surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/uniformity_index_area_weighted").execute(*args, **kwargs) + def uniformity_index_mass_weighted(self, *args, **kwargs): + """ + Prints the mass-weighted uniformity index of the specified quantity over the selected surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/uniformity_index_mass_weighted").execute(*args, **kwargs) + def vector_based_flux(self, *args, **kwargs): + """ + Prints the vector-based flux of the specified quantity over the selected surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/vector_based_flux").execute(*args, **kwargs) + def vector_flux(self, *args, **kwargs): + """ + Prints the vector flux over the selected surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/vector_flux").execute(*args, **kwargs) + def vector_weighted_average(self, *args, **kwargs): + """ + Prints the vector-averaged quantity over the selected surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/vector_weighted_average").execute(*args, **kwargs) + def vertex_avg(self, *args, **kwargs): + """ + Prints the vertex average of the specified quantity over the selected surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/vertex_avg").execute(*args, **kwargs) + def vertex_max(self, *args, **kwargs): + """ + Prints the maximum of the specified quantity over vertices of the selected surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/vertex_max").execute(*args, **kwargs) + def vertex_min(self, *args, **kwargs): + """ + Prints the minimum of the specified quantity over vertices of the selected surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/vertex_min").execute(*args, **kwargs) + def volume_flow_rate(self, *args, **kwargs): + """ + Prints the volume flow rate through the selected surfaces. + """ + return PyMenu(self.service, "/report/surface_integrals/volume_flow_rate").execute(*args, **kwargs) + + class volume_integrals(TUIMenu): + """ + Enters the volume integral menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def mass(self, *args, **kwargs): + """ + Print total mass of specified cell zones. + """ + return PyMenu(self.service, "/report/volume_integrals/mass").execute(*args, **kwargs) + def mass_avg(self, *args, **kwargs): + """ + Prints mass-average of scalar over cell zones. + """ + return PyMenu(self.service, "/report/volume_integrals/mass_avg").execute(*args, **kwargs) + def mass_integral(self, *args, **kwargs): + """ + Prints mass-weighted integral of scalar over cell zones. + """ + return PyMenu(self.service, "/report/volume_integrals/mass_integral").execute(*args, **kwargs) + def maximum(self, *args, **kwargs): + """ + Prints maximum of scalar over all cell zones. + """ + return PyMenu(self.service, "/report/volume_integrals/maximum").execute(*args, **kwargs) + def minimum(self, *args, **kwargs): + """ + Prints minimum of scalar over all cell zones. + """ + return PyMenu(self.service, "/report/volume_integrals/minimum").execute(*args, **kwargs) + def sum(self, *args, **kwargs): + """ + Prints sum of scalar over all cell zones. + """ + return PyMenu(self.service, "/report/volume_integrals/sum").execute(*args, **kwargs) + def twopisum(self, *args, **kwargs): + """ + Prints sum of scalar over all cell zones multiplied by 2π. + """ + return PyMenu(self.service, "/report/volume_integrals/twopisum").execute(*args, **kwargs) + def volume(self, *args, **kwargs): + """ + Prints total volume of specified cell zones. + """ + return PyMenu(self.service, "/report/volume_integrals/volume").execute(*args, **kwargs) + def volume_avg(self, *args, **kwargs): + """ + Prints volume-weighted average of scalar over cell zones. + """ + return PyMenu(self.service, "/report/volume_integrals/volume_avg").execute(*args, **kwargs) + def volume_integral(self, *args, **kwargs): + """ + Prints integral of scalar over cell zones. + """ + return PyMenu(self.service, "/report/volume_integrals/volume_integral").execute(*args, **kwargs) + + class modified_setting(TUIMenu): + """ + Enter the modified settings menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def modified_setting(self, *args, **kwargs): + """ + Specify which areas of setup will be checked for non-default settings for generating the Modified Settings Summary table. The table is displayed tabbed with the graphics window. + """ + return PyMenu(self.service, "/report/modified_setting/modified_setting").execute(*args, **kwargs) + def write_user_setting(self, *args, **kwargs): + """ + Write the contents of the Modified Settings Summary table to a file. + """ + return PyMenu(self.service, "/report/modified_setting/write_user_setting").execute(*args, **kwargs) + + class population_balance(TUIMenu): + """ + Population Balance menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def moments(self, *args, **kwargs): + """ + Set moments for population balance. + """ + return PyMenu(self.service, "/report/population_balance/moments").execute(*args, **kwargs) + def number_density(self, *args, **kwargs): + """ + Set number density functions. + """ + return PyMenu(self.service, "/report/population_balance/number_density").execute(*args, **kwargs) + + class heat_exchanger(TUIMenu): + """ + Enters the heat exchanger menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def computed_heat_rejection(self, *args, **kwargs): + """ + Prints total heat rejection. + """ + return PyMenu(self.service, "/report/heat_exchanger/computed_heat_rejection").execute(*args, **kwargs) + def inlet_temperature(self, *args, **kwargs): + """ + Prints inlet temperature. + """ + return PyMenu(self.service, "/report/heat_exchanger/inlet_temperature").execute(*args, **kwargs) + def outlet_temperature(self, *args, **kwargs): + """ + Prints outlet temperature. + """ + return PyMenu(self.service, "/report/heat_exchanger/outlet_temperature").execute(*args, **kwargs) + def mass_flow_rate(self, *args, **kwargs): + """ + Prints mass flow rate. + """ + return PyMenu(self.service, "/report/heat_exchanger/mass_flow_rate").execute(*args, **kwargs) + def specific_heat(self, *args, **kwargs): + """ + Prints fluid’s specific heat. + """ + return PyMenu(self.service, "/report/heat_exchanger/specific_heat").execute(*args, **kwargs) + + class system(TUIMenu): + """ + Enters the system menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def proc_stats(self, *args, **kwargs): + """ + Prints ANSYS Fluent process information. This is used to report the memory usage of each of the ANSYS Fluent processes. + """ + return PyMenu(self.service, "/report/system/proc_stats").execute(*args, **kwargs) + def sys_stats(self, *args, **kwargs): + """ + System information. This is used to report the CPU configuration of the machines where ANSYS Fluent processes have been spawned. + """ + return PyMenu(self.service, "/report/system/sys_stats").execute(*args, **kwargs) + def gpgpu_stats(self, *args, **kwargs): + """ + Prints information about installed general purpose graphical processing units. + """ + return PyMenu(self.service, "/report/system/gpgpu_stats").execute(*args, **kwargs) + def time_stats(self, *args, **kwargs): + """ + Timer information. This is used to report CPU timings for user and kernel processes and detailed solver timings. + """ + return PyMenu(self.service, "/report/system/time_stats").execute(*args, **kwargs) + + class simulation_reports(TUIMenu): + """ + Enter the simulation reports menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def list_simulation_reports(self, *args, **kwargs): + """ + List all report names. + """ + return PyMenu(self.service, "/report/simulation_reports/list_simulation_reports").execute(*args, **kwargs) + def generate_simulation_report(self, *args, **kwargs): + """ + Generate a new simulation report or regenerate an existing simulation report with the provided name. + """ + return PyMenu(self.service, "/report/simulation_reports/generate_simulation_report").execute(*args, **kwargs) + def view_simulation_report(self, *args, **kwargs): + """ + View a simulation report that has already been generated. In batch mode this will print the report's URL. + """ + return PyMenu(self.service, "/report/simulation_reports/view_simulation_report").execute(*args, **kwargs) + def export_simulation_report_as_pdf(self, *args, **kwargs): + """ + Export the provided simulation report as a PDF file. + """ + return PyMenu(self.service, "/report/simulation_reports/export_simulation_report_as_pdf").execute(*args, **kwargs) + def export_simulation_report_as_html(self, *args, **kwargs): + """ + Export the provided simulation report as HTML. + """ + return PyMenu(self.service, "/report/simulation_reports/export_simulation_report_as_html").execute(*args, **kwargs) + def write_report_names_to_file(self, *args, **kwargs): + """ + Write the list of currently generated report names to a txt file. + """ + return PyMenu(self.service, "/report/simulation_reports/write_report_names_to_file").execute(*args, **kwargs) + def rename_simulation_report(self, *args, **kwargs): + """ + Rename a report which has already been generated. + """ + return PyMenu(self.service, "/report/simulation_reports/rename_simulation_report").execute(*args, **kwargs) + def duplicate_simulation_report(self, *args, **kwargs): + """ + Duplicate a report and all of its settings to a new report. + """ + return PyMenu(self.service, "/report/simulation_reports/duplicate_simulation_report").execute(*args, **kwargs) + def reset_report_to_defaults(self, *args, **kwargs): + """ + Reset all report settings to default for the provided simulation report. + """ + return PyMenu(self.service, "/report/simulation_reports/reset_report_to_defaults").execute(*args, **kwargs) + def delete_simulation_report(self, *args, **kwargs): + """ + Delete the provided simulation report. + """ + return PyMenu(self.service, "/report/simulation_reports/delete_simulation_report").execute(*args, **kwargs) + def write_simulation_report_template_file(self, *args, **kwargs): + """ + Write a JSON template file with this case's Simulation Report settings. + """ + return PyMenu(self.service, "/report/simulation_reports/write_simulation_report_template_file").execute(*args, **kwargs) + def read_simulation_report_template_file(self, *args, **kwargs): + """ + Read a JSON template file with existing Simulation Report settings. + """ + return PyMenu(self.service, "/report/simulation_reports/read_simulation_report_template_file").execute(*args, **kwargs) + + class results(TUIMenu): + """ + Enter results menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.animate = self.__class__.animate(path + [("animate", None)], service) + self.graphics = self.__class__.graphics(path + [("graphics", None)], service) + self.plot = self.__class__.plot(path + [("plot", None)], service) + self.report = self.__class__.report(path + [("report", None)], service) + self.surface = self.__class__.surface(path + [("surface", None)], service) + self.graphics_window = self.__class__.graphics_window(path + [("graphics_window", None)], service) + super().__init__(path, service) + + class animate(TUIMenu): + """ + Enter the animation menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.playback = self.__class__.playback(path + [("playback", None)], service) + super().__init__(path, service) + + class playback(TUIMenu): + """ + Enter animation playback menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.video = self.__class__.video(path + [("video", None)], service) + super().__init__(path, service) + def read(self, *args, **kwargs): """ - Return to the camera position after the current position in the stack. + Read new animation from file or already-defined animations. """ - return PyMenu(self.service, "/results/graphics_window/views/next_view").execute(*args, **kwargs) - def list_views(self, *args, **kwargs): + return PyMenu(self.service, "/results/animate/playback/read").execute(*args, **kwargs) + def play(self, *args, **kwargs): """ - List predefined and saved views. + Play the selected animation. """ - return PyMenu(self.service, "/results/graphics_window/views/list_views").execute(*args, **kwargs) - def restore_view(self, *args, **kwargs): + return PyMenu(self.service, "/results/animate/playback/play").execute(*args, **kwargs) + def write(self, *args, **kwargs): """ - Use a saved view. + Write animation sequence to the file. """ - return PyMenu(self.service, "/results/graphics_window/views/restore_view").execute(*args, **kwargs) - def read_views(self, *args, **kwargs): + return PyMenu(self.service, "/results/animate/playback/write").execute(*args, **kwargs) + def delete(self, *args, **kwargs): """ - Read views from a view file. + Delete animation sequence. """ - return PyMenu(self.service, "/results/graphics_window/views/read_views").execute(*args, **kwargs) - def save_view(self, *args, **kwargs): + return PyMenu(self.service, "/results/animate/playback/delete").execute(*args, **kwargs) + def stored_view(self, *args, **kwargs): """ - Save the current view to the view list. + Play the 3D animation sequence using the view stored in the sequence. """ - return PyMenu(self.service, "/results/graphics_window/views/save_view").execute(*args, **kwargs) - def write_views(self, *args, **kwargs): + return PyMenu(self.service, "/results/animate/playback/stored_view").execute(*args, **kwargs) + def set_custom_frames(self, *args, **kwargs): """ - Write selected views to a view file. + Set custom frames start, end, skip frames for video export. """ - return PyMenu(self.service, "/results/graphics_window/views/write_views").execute(*args, **kwargs) + return PyMenu(self.service, "/results/animate/playback/set_custom_frames").execute(*args, **kwargs) - class camera(metaclass=PyMenuMeta): + class video(TUIMenu): """ - Enter the camera menu to modify the current viewing parameters. + Set options for exporting video file menu. """ def __init__(self, path, service): self.path = path self.service = service - def dolly_camera(self, *args, **kwargs): + self.advance_quality = self.__class__.advance_quality(path + [("advance_quality", None)], service) + super().__init__(path, service) + def fps(self, *args, **kwargs): """ - Adjust the camera position and target. + Set the Frame Per Sec(FPS) for exporting video file. """ - return PyMenu(self.service, "/results/graphics_window/views/camera/dolly_camera").execute(*args, **kwargs) - def field(self, *args, **kwargs): + return PyMenu(self.service, "/results/animate/playback/video/fps").execute(*args, **kwargs) + def format(self, *args, **kwargs): """ - Set the field of view (width and height). + Set format for exporting video file. """ - return PyMenu(self.service, "/results/graphics_window/views/camera/field").execute(*args, **kwargs) - def orbit_camera(self, *args, **kwargs): + return PyMenu(self.service, "/results/animate/playback/video/format").execute(*args, **kwargs) + def quality(self, *args, **kwargs): """ - Adjust the camera position without modifying the target. + Set quality for exporting video file. """ - return PyMenu(self.service, "/results/graphics_window/views/camera/orbit_camera").execute(*args, **kwargs) - def pan_camera(self, *args, **kwargs): + return PyMenu(self.service, "/results/animate/playback/video/quality").execute(*args, **kwargs) + def name(self, *args, **kwargs): """ - Adjust the camera target without modifying the position. + Exporting video file name. """ - return PyMenu(self.service, "/results/graphics_window/views/camera/pan_camera").execute(*args, **kwargs) - def position(self, *args, **kwargs): + return PyMenu(self.service, "/results/animate/playback/video/name").execute(*args, **kwargs) + def use_original_resolution(self, *args, **kwargs): """ - Set the camera position. + Enable original resolution. """ - return PyMenu(self.service, "/results/graphics_window/views/camera/position").execute(*args, **kwargs) - def projection(self, *args, **kwargs): + return PyMenu(self.service, "/results/animate/playback/video/use_original_resolution").execute(*args, **kwargs) + def scale(self, *args, **kwargs): """ - Set the camera projection type. + Set scale by which video resolution will expand. """ - return PyMenu(self.service, "/results/graphics_window/views/camera/projection").execute(*args, **kwargs) - def roll_camera(self, *args, **kwargs): + return PyMenu(self.service, "/results/animate/playback/video/scale").execute(*args, **kwargs) + def set_standard_resolution(self, *args, **kwargs): """ - Adjust the camera up-vector. + Select from pre-defined resolution list. """ - return PyMenu(self.service, "/results/graphics_window/views/camera/roll_camera").execute(*args, **kwargs) - def target(self, *args, **kwargs): + return PyMenu(self.service, "/results/animate/playback/video/set_standard_resolution").execute(*args, **kwargs) + def width(self, *args, **kwargs): """ - Set the point to be the center of the camera view. + Set the width for exporting video file. """ - return PyMenu(self.service, "/results/graphics_window/views/camera/target").execute(*args, **kwargs) - def up_vector(self, *args, **kwargs): + return PyMenu(self.service, "/results/animate/playback/video/width").execute(*args, **kwargs) + def height(self, *args, **kwargs): """ - Set the camera up-vector. + Set the height for exporting video file. """ - return PyMenu(self.service, "/results/graphics_window/views/camera/up_vector").execute(*args, **kwargs) - def zoom_camera(self, *args, **kwargs): + return PyMenu(self.service, "/results/animate/playback/video/height").execute(*args, **kwargs) + + class advance_quality(TUIMenu): """ - Adjust the camera field of view. + Advance Quality setting. """ - return PyMenu(self.service, "/results/graphics_window/views/camera/zoom_camera").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def bitrate_scale(self, *args, **kwargs): + """ + Mp4 bitrate scale - Best-64000 High-32000 Medium-16000 Low-8000. + """ + return PyMenu(self.service, "/results/animate/playback/video/advance_quality/bitrate_scale").execute(*args, **kwargs) + def enable_h264(self, *args, **kwargs): + """ + H264 encoding flag. + """ + return PyMenu(self.service, "/results/animate/playback/video/advance_quality/enable_h264").execute(*args, **kwargs) + def bitrate(self, *args, **kwargs): + """ + Set video bitrate(kbits/sec) for exporting video file. + """ + return PyMenu(self.service, "/results/animate/playback/video/advance_quality/bitrate").execute(*args, **kwargs) + def compression_method(self, *args, **kwargs): + """ + Compression methode for Microsoft AVI movie. + """ + return PyMenu(self.service, "/results/animate/playback/video/advance_quality/compression_method").execute(*args, **kwargs) + def keyframe(self, *args, **kwargs): + """ + Set video keyframe rate for exporting video file. + """ + return PyMenu(self.service, "/results/animate/playback/video/advance_quality/keyframe").execute(*args, **kwargs) - class display_states(metaclass=PyMenuMeta): + class graphics(TUIMenu): + """ + Enter graphics menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.expert = self.__class__.expert(path + [("expert", None)], service) + self.lights = self.__class__.lights(path + [("lights", None)], service) + self.objects = self.__class__.objects(path + [("objects", None)], service) + self.rendering_options = self.__class__.rendering_options(path + [("rendering_options", None)], service) + self.update_scene = self.__class__.update_scene(path + [("update_scene", None)], service) + super().__init__(path, service) + def annotate(self, *args, **kwargs): """ - Enter the display state manipulation menu. + Add a text annotation string to the active graphics window. + """ + return PyMenu(self.service, "/results/graphics/annotate").execute(*args, **kwargs) + def clear_annotations(self, *args, **kwargs): + """ + Delete all annotation text. + """ + return PyMenu(self.service, "/results/graphics/clear_annotations").execute(*args, **kwargs) + def color_map(self, *args, **kwargs): + """ + Enter the color-map menu. + """ + return PyMenu(self.service, "/results/graphics/color_map").execute(*args, **kwargs) + def hsf_file(self, *args, **kwargs): + """ + Display hoops stream file data to active graphics window. + """ + return PyMenu(self.service, "/results/graphics/hsf_file").execute(*args, **kwargs) + + class expert(TUIMenu): + """ + Enter expert menu. """ def __init__(self, path, service): self.path = path self.service = service - def list(self, *args, **kwargs): + self.flamelet_data = self.__class__.flamelet_data(path + [("flamelet_data", None)], service) + self.particle_tracks = self.__class__.particle_tracks(path + [("particle_tracks", None)], service) + self.path_lines = self.__class__.path_lines(path + [("path_lines", None)], service) + self.pdf_data = self.__class__.pdf_data(path + [("pdf_data", None)], service) + self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) + def add_custom_vector(self, *args, **kwargs): """ - Print the names of the available display states to the console. + Add new custom vector definition. """ - return PyMenu(self.service, "/results/graphics_window/display_states/list").execute(*args, **kwargs) - def apply(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/expert/add_custom_vector").execute(*args, **kwargs) + def contour(self, *args, **kwargs): """ - Apply a display state to the active window. + Display contours of a flow variable. """ - return PyMenu(self.service, "/results/graphics_window/display_states/apply").execute(*args, **kwargs) - def delete(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/expert/contour").execute(*args, **kwargs) + def display_custom_vector(self, *args, **kwargs): """ - Delete a display state. + Display custom vector. """ - return PyMenu(self.service, "/results/graphics_window/display_states/delete").execute(*args, **kwargs) - def use_active(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/expert/display_custom_vector").execute(*args, **kwargs) + def graphics_window_layout(self, *args, **kwargs): """ - Update an existing display state's settings to match those of the active graphics window. + Arrange the graphics window layout. """ - return PyMenu(self.service, "/results/graphics_window/display_states/use_active").execute(*args, **kwargs) - def copy(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/expert/graphics_window_layout").execute(*args, **kwargs) + def mesh(self, *args, **kwargs): """ - Create a new display state with settings copied from an existing display state. + Display the mesh. """ - return PyMenu(self.service, "/results/graphics_window/display_states/copy").execute(*args, **kwargs) - def read(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/expert/mesh").execute(*args, **kwargs) + def mesh_outline(self, *args, **kwargs): """ - Read display states from a file. + Display the mesh boundaries. """ - return PyMenu(self.service, "/results/graphics_window/display_states/read").execute(*args, **kwargs) - def write(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/expert/mesh_outline").execute(*args, **kwargs) + def mesh_partition_boundary(self, *args, **kwargs): """ - Write display states to a file. + Display mesh partition boundaries. """ - return PyMenu(self.service, "/results/graphics_window/display_states/write").execute(*args, **kwargs) - def edit(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/expert/mesh_partition_boundary").execute(*args, **kwargs) + def multigrid_coarsening(self, *args, **kwargs): """ - Edit a particular display state setting. + Display a coarse mesh level from the last multigrid coarsening. """ - return PyMenu(self.service, "/results/graphics_window/display_states/edit").execute(*args, **kwargs) - def create(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/expert/multigrid_coarsening").execute(*args, **kwargs) + def profile(self, *args, **kwargs): """ - Create a new display state. + Display profiles of a flow variable. """ - return PyMenu(self.service, "/results/graphics_window/display_states/create").execute(*args, **kwargs) - - class view_sync(metaclass=PyMenuMeta): - """ - Enter the display state manipulation menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def list(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/expert/profile").execute(*args, **kwargs) + def reacting_channel_curves(self, *args, **kwargs): """ - Print window ids of open windows. + Plot/Report the reacting channel variables. """ - return PyMenu(self.service, "/results/graphics_window/view_sync/list").execute(*args, **kwargs) - def start(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/expert/reacting_channel_curves").execute(*args, **kwargs) + def re_render(self, *args, **kwargs): """ - Start view synchronization. + Re-render the last contour, profile, or velocity vector plot + with updated surfaces, meshes, lights, colormap, rendering options, etc., + without recalculating the contour data. """ - return PyMenu(self.service, "/results/graphics_window/view_sync/start").execute(*args, **kwargs) - def stop(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/expert/re_render").execute(*args, **kwargs) + def re_scale(self, *args, **kwargs): """ - Stop view synchronization. + Re-render the last contour, profile, or velocity vector plot + with updated scale, surfaces, meshes, lights, colormap, rendering options, etc., + without recalculating the field data. """ - return PyMenu(self.service, "/results/graphics_window/view_sync/stop").execute(*args, **kwargs) - def remove_all(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/expert/re_scale").execute(*args, **kwargs) + def set_list_tree_separator(self, *args, **kwargs): """ - Unsynchronize all windows. + Set the separator character for list tree. """ - return PyMenu(self.service, "/results/graphics_window/view_sync/remove_all").execute(*args, **kwargs) - def add_all(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/expert/set_list_tree_separator").execute(*args, **kwargs) + def surface_cells(self, *args, **kwargs): """ - Synchronize all windows. + Draw the cells on the specified surfaces. """ - return PyMenu(self.service, "/results/graphics_window/view_sync/add_all").execute(*args, **kwargs) - def add(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/expert/surface_cells").execute(*args, **kwargs) + def surface_mesh(self, *args, **kwargs): """ - Add list of window ids for synchronization. + Draw the mesh defined by the specified surfaces. """ - return PyMenu(self.service, "/results/graphics_window/view_sync/add").execute(*args, **kwargs) - def remove(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/expert/surface_mesh").execute(*args, **kwargs) + def vector(self, *args, **kwargs): """ - Remove list of window ids from synchronization. + Display space vectors. """ - return PyMenu(self.service, "/results/graphics_window/view_sync/remove").execute(*args, **kwargs) + return PyMenu(self.service, "/results/graphics/expert/vector").execute(*args, **kwargs) + def velocity_vector(self, *args, **kwargs): + """ + Display velocity vectors. + """ + return PyMenu(self.service, "/results/graphics/expert/velocity_vector").execute(*args, **kwargs) + def zone_mesh(self, *args, **kwargs): + """ + Draw the mesh defined by specified face zones. + """ + return PyMenu(self.service, "/results/graphics/expert/zone_mesh").execute(*args, **kwargs) - class solution(metaclass=PyMenuMeta): - """ - Enter solution menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.calculation_activities = self.__class__.calculation_activities(path + [("calculation_activities", None)], service) - self.cell_registers = self.__class__.cell_registers(path + [("cell_registers", None)], service) - self.controls = self.__class__.controls(path + [("controls", None)], service) - self.expert = self.__class__.expert(path + [("expert", None)], service) - self.initialize = self.__class__.initialize(path + [("initialize", None)], service) - self.methods = self.__class__.methods(path + [("methods", None)], service) - self.monitors = self.__class__.monitors(path + [("monitors", None)], service) - self.report_definitions = self.__class__.report_definitions(path + [("report_definitions", None)], service) - self.run_calculation = self.__class__.run_calculation(path + [("run_calculation", None)], service) + class flamelet_data(TUIMenu): + """ + Display flamelet data. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def draw_number_box(self, *args, **kwargs): + """ + Enable/disable display of the numbers box. + """ + return PyMenu(self.service, "/results/graphics/expert/flamelet_data/draw_number_box").execute(*args, **kwargs) + def plot_1d_slice(self, *args, **kwargs): + """ + Enable/disable plot of the 1D-slice. + """ + return PyMenu(self.service, "/results/graphics/expert/flamelet_data/plot_1d_slice").execute(*args, **kwargs) + def write_to_file(self, *args, **kwargs): + """ + Enable/disable writing the 1D-slice to file instead of plot. + """ + return PyMenu(self.service, "/results/graphics/expert/flamelet_data/write_to_file").execute(*args, **kwargs) + def carpet_plot(self, *args, **kwargs): + """ + Enable/disable display of carpet plot of a property. + """ + return PyMenu(self.service, "/results/graphics/expert/flamelet_data/carpet_plot").execute(*args, **kwargs) - class calculation_activities(metaclass=PyMenuMeta): - """ - Enter calculation activities menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.animate = self.__class__.animate(path + [("animate", None)], service) - self.auto_save = self.__class__.auto_save(path + [("auto_save", None)], service) - self.cell_register_operations = self.__class__.cell_register_operations(path + [("cell_register_operations", None)], service) - self.execute_commands = self.__class__.execute_commands(path + [("execute_commands", None)], service) - self.solution_strategy = self.__class__.solution_strategy(path + [("solution_strategy", None)], service) + class particle_tracks(TUIMenu): + """ + Enter the particle tracks menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def particle_tracks(self, *args, **kwargs): + """ + Calculate and display particle tracks from defined injections. + """ + return PyMenu(self.service, "/results/graphics/expert/particle_tracks/particle_tracks").execute(*args, **kwargs) + def plot_write_xy_plot(self, *args, **kwargs): + """ + Plot or write XY plot of particle tracks. + """ + return PyMenu(self.service, "/results/graphics/expert/particle_tracks/plot_write_xy_plot").execute(*args, **kwargs) - class animate(metaclass=PyMenuMeta): - """ - Enter the animation menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.define = self.__class__.define(path + [("define", None)], service) - self.objects = self.__class__.objects(path + [("objects", None)], service) + class path_lines(TUIMenu): + """ + Enter the pathlines menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def path_lines(self, *args, **kwargs): + """ + Display pathlines from a surface. + """ + return PyMenu(self.service, "/results/graphics/expert/path_lines/path_lines").execute(*args, **kwargs) + def plot_write_xy_plot(self, *args, **kwargs): + """ + Plot or write XY plot of pathline. + """ + return PyMenu(self.service, "/results/graphics/expert/path_lines/plot_write_xy_plot").execute(*args, **kwargs) + def write_to_files(self, *args, **kwargs): + """ + Write Pathlines to a File. + """ + return PyMenu(self.service, "/results/graphics/expert/path_lines/write_to_files").execute(*args, **kwargs) - class define(metaclass=PyMenuMeta): + class pdf_data(TUIMenu): """ - Enter the animation definition menu. + Enter the PDF data menu. """ def __init__(self, path, service): self.path = path self.service = service - def define_monitor(self, *args, **kwargs): + super().__init__(path, service) + def draw_number_box(self, *args, **kwargs): """ - Define new animation. + Enable/disable the display of the numbers box. """ - return PyMenu(self.service, "/solution/calculation_activities/animate/define/define_monitor").execute(*args, **kwargs) - def edit_monitor(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/expert/pdf_data/draw_number_box").execute(*args, **kwargs) + def plot_1d_slice(self, *args, **kwargs): """ - Change animation monitor attributes. + Enable/disable a plot of the 1D-slice. """ - return PyMenu(self.service, "/solution/calculation_activities/animate/define/edit_monitor").execute(*args, **kwargs) + return PyMenu(self.service, "/results/graphics/expert/pdf_data/plot_1d_slice").execute(*args, **kwargs) + def write_to_file(self, *args, **kwargs): + """ + Enable/disable writing the 1D-slice to file instead of plot. + """ + return PyMenu(self.service, "/results/graphics/expert/pdf_data/write_to_file").execute(*args, **kwargs) + def carpet_plot(self, *args, **kwargs): + """ + Enable/disable the display of a carpet plot of a property. + """ + return PyMenu(self.service, "/results/graphics/expert/pdf_data/carpet_plot").execute(*args, **kwargs) - class objects(metaclass=PyMenuMeta): + class set(TUIMenu): """ - Enter to define, edit, delete solution animation objects. + Enter the set menu to set display parameters. """ def __init__(self, path, service): self.path = path self.service = service - def create(self, *args, **kwargs): + self.colors = self.__class__.colors(path + [("colors", None)], service) + self.contours = self.__class__.contours(path + [("contours", None)], service) + self.picture = self.__class__.picture(path + [("picture", None)], service) + self.lights = self.__class__.lights(path + [("lights", None)], service) + self.particle_tracks = self.__class__.particle_tracks(path + [("particle_tracks", None)], service) + self.path_lines = self.__class__.path_lines(path + [("path_lines", None)], service) + self.rendering_options = self.__class__.rendering_options(path + [("rendering_options", None)], service) + self.titles = self.__class__.titles(path + [("titles", None)], service) + self.velocity_vectors = self.__class__.velocity_vectors(path + [("velocity_vectors", None)], service) + self.windows = self.__class__.windows(path + [("windows", None)], service) + super().__init__(path, service) + def color_map(self, *args, **kwargs): + """ + Enter the color-map menu. + """ + return PyMenu(self.service, "/results/graphics/expert/set/color_map").execute(*args, **kwargs) + def element_shrink(self, *args, **kwargs): + """ + Set percentage to shrink elements. + """ + return PyMenu(self.service, "/results/graphics/expert/set/element_shrink").execute(*args, **kwargs) + def filled_mesh(self, *args, **kwargs): + """ + Enable/disable the filled mesh option. + """ + return PyMenu(self.service, "/results/graphics/expert/set/filled_mesh").execute(*args, **kwargs) + def mesh_level(self, *args, **kwargs): + """ + Set coarse mesh level to be drawn. + """ + return PyMenu(self.service, "/results/graphics/expert/set/mesh_level").execute(*args, **kwargs) + def mesh_partitions(self, *args, **kwargs): + """ + Enable/disable drawing of the mesh partition boundaries. + """ + return PyMenu(self.service, "/results/graphics/expert/set/mesh_partitions").execute(*args, **kwargs) + def mesh_surfaces(self, *args, **kwargs): + """ + Set surface IDs to be drawn as mesh. + """ + return PyMenu(self.service, "/results/graphics/expert/set/mesh_surfaces").execute(*args, **kwargs) + def mesh_zones(self, *args, **kwargs): + """ + Set zone IDs to be drawn as mesh. + """ + return PyMenu(self.service, "/results/graphics/expert/set/mesh_zones").execute(*args, **kwargs) + def line_weight(self, *args, **kwargs): + """ + Set the line-weight factor for the window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/line_weight").execute(*args, **kwargs) + def marker_size(self, *args, **kwargs): + """ + Set the size of markers used to represent points. + """ + return PyMenu(self.service, "/results/graphics/expert/set/marker_size").execute(*args, **kwargs) + def marker_symbol(self, *args, **kwargs): + """ + Set the type of markers used to represent points. + """ + return PyMenu(self.service, "/results/graphics/expert/set/marker_symbol").execute(*args, **kwargs) + def mesh_display_configuration(self, *args, **kwargs): + """ + Set mesh display configuration. + """ + return PyMenu(self.service, "/results/graphics/expert/set/mesh_display_configuration").execute(*args, **kwargs) + def mirror_zones(self, *args, **kwargs): + """ + Set zones to mirror the domain about. + """ + return PyMenu(self.service, "/results/graphics/expert/set/mirror_zones").execute(*args, **kwargs) + def n_stream_func(self, *args, **kwargs): + """ + Set the number of iterations used in computing stream function. + """ + return PyMenu(self.service, "/results/graphics/expert/set/n_stream_func").execute(*args, **kwargs) + def nodewt_based_interp(self, *args, **kwargs): + """ + Use more accurate node-weight based interpolation for postprocessing. + """ + return PyMenu(self.service, "/results/graphics/expert/set/nodewt_based_interp").execute(*args, **kwargs) + def overlays(self, *args, **kwargs): + """ + Enable/disable overlays. + """ + return PyMenu(self.service, "/results/graphics/expert/set/overlays").execute(*args, **kwargs) + def periodic_instancing(self, *args, **kwargs): + """ + Set periodic instancing. """ - Create new graphics object. + return PyMenu(self.service, "/results/graphics/expert/set/periodic_instancing").execute(*args, **kwargs) + def proximity_zones(self, *args, **kwargs): """ - return PyMenu(self.service, "/solution/calculation_activities/animate/objects/create").execute(*args, **kwargs) - def edit(self, *args, **kwargs): + Set zones to be used for boundary cell distance and boundary proximity. """ - Edit graphics object. + return PyMenu(self.service, "/results/graphics/expert/set/proximity_zones").execute(*args, **kwargs) + def render_mesh(self, *args, **kwargs): """ - return PyMenu(self.service, "/solution/calculation_activities/animate/objects/edit").execute(*args, **kwargs) - def copy(self, *args, **kwargs): + Enable/disable rendering the mesh on top of contours, vectors, etc. """ - Copy graphics object. + return PyMenu(self.service, "/results/graphics/expert/set/render_mesh").execute(*args, **kwargs) + def reset_graphics(self, *args, **kwargs): """ - return PyMenu(self.service, "/solution/calculation_activities/animate/objects/copy").execute(*args, **kwargs) - def delete(self, *args, **kwargs): + Reset the graphics system. """ - Delete graphics object. + return PyMenu(self.service, "/results/graphics/expert/set/reset_graphics").execute(*args, **kwargs) + def zero_angle_dir(self, *args, **kwargs): """ - return PyMenu(self.service, "/solution/calculation_activities/animate/objects/delete").execute(*args, **kwargs) - def clear_history(self, *args, **kwargs): + Set the vector having zero angular coordinates. """ - Clear object history. + return PyMenu(self.service, "/results/graphics/expert/set/zero_angle_dir").execute(*args, **kwargs) + def duplicate_node_display(self, *args, **kwargs): """ - return PyMenu(self.service, "/solution/calculation_activities/animate/objects/clear_history").execute(*args, **kwargs) + Set flag to remove duplicate nodes in mesh display. + """ + return PyMenu(self.service, "/results/graphics/expert/set/duplicate_node_display").execute(*args, **kwargs) - class auto_save(metaclass=PyMenuMeta): - """ - Enter the auto save menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def case_frequency(self, *args, **kwargs): - """ - Set the preference for saving case files. - """ - return PyMenu(self.service, "/solution/calculation_activities/auto_save/case_frequency").execute(*args, **kwargs) - def data_frequency(self, *args, **kwargs): - """ - Set the iteration or time step increment for saving data files. - """ - return PyMenu(self.service, "/solution/calculation_activities/auto_save/data_frequency").execute(*args, **kwargs) - def root_name(self, *args, **kwargs): - """ - Set the root name for auto-saved files. The number of iterations or time steps will be appended to this root name. - """ - return PyMenu(self.service, "/solution/calculation_activities/auto_save/root_name").execute(*args, **kwargs) - def retain_most_recent_files(self, *args, **kwargs): - """ - After the maximum (as in max-files) is reached, a file will be deleted for each file saved. - """ - return PyMenu(self.service, "/solution/calculation_activities/auto_save/retain_most_recent_files").execute(*args, **kwargs) - def max_files(self, *args, **kwargs): - """ - Set the maximum number of data files to save. After the maximum is reached, a file will be deleted for each file saved. - """ - return PyMenu(self.service, "/solution/calculation_activities/auto_save/max_files").execute(*args, **kwargs) - def append_file_name_with(self, *args, **kwargs): - """ - Set the suffix for auto-saved files. The file name can be appended by flow-time, time-step value or by user specified flags in file name. - """ - return PyMenu(self.service, "/solution/calculation_activities/auto_save/append_file_name_with").execute(*args, **kwargs) - def save_data_file_every(self, *args, **kwargs): - """ - Set the auto save frequency type to either time-step or crank-angle and set the corresponding frequency. - """ - return PyMenu(self.service, "/solution/calculation_activities/auto_save/save_data_file_every").execute(*args, **kwargs) + class colors(TUIMenu): + """ + Enter the color options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.by_type = self.__class__.by_type(path + [("by_type", None)], service) + self.by_surface = self.__class__.by_surface(path + [("by_surface", None)], service) + super().__init__(path, service) + def background(self, *args, **kwargs): + """ + Set the background (window) color. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/background").execute(*args, **kwargs) + def color_by_type(self, *args, **kwargs): + """ + Determine whether to color meshes by type or by surface (ID). + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/color_by_type").execute(*args, **kwargs) + def foreground(self, *args, **kwargs): + """ + Set the foreground (text and window frame) color. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/foreground").execute(*args, **kwargs) + def far_field_faces(self, *args, **kwargs): + """ + Set the color of far field faces. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/far_field_faces").execute(*args, **kwargs) + def inlet_faces(self, *args, **kwargs): + """ + Set the color of inlet faces. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/inlet_faces").execute(*args, **kwargs) + def interior_faces(self, *args, **kwargs): + """ + Set the color of interior faces. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/interior_faces").execute(*args, **kwargs) + def internal_faces(self, *args, **kwargs): + """ + Set the color of internal interface faces. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/internal_faces").execute(*args, **kwargs) + def outlet_faces(self, *args, **kwargs): + """ + Set the color of outlet faces. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/outlet_faces").execute(*args, **kwargs) + def overset_faces(self, *args, **kwargs): + """ + Set the color of overset faces. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/overset_faces").execute(*args, **kwargs) + def periodic_faces(self, *args, **kwargs): + """ + Set the color of periodic faces. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/periodic_faces").execute(*args, **kwargs) + def rans_les_interface_faces(self, *args, **kwargs): + """ + Set the color of RANS/LES interface faces. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/rans_les_interface_faces").execute(*args, **kwargs) + def reset_user_colors(self, *args, **kwargs): + """ + Reset all user colors. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/reset_user_colors").execute(*args, **kwargs) + def show_user_colors(self, *args, **kwargs): + """ + List currently defined user colors. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/show_user_colors").execute(*args, **kwargs) + def symmetry_faces(self, *args, **kwargs): + """ + Set the color of symmetric faces. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/symmetry_faces").execute(*args, **kwargs) + def axis_faces(self, *args, **kwargs): + """ + Set the color of axisymmetric faces. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/axis_faces").execute(*args, **kwargs) + def free_surface_faces(self, *args, **kwargs): + """ + Set the color of free-surface faces. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/free_surface_faces").execute(*args, **kwargs) + def traction_faces(self, *args, **kwargs): + """ + Set the color of traction faces. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/traction_faces").execute(*args, **kwargs) + def user_color(self, *args, **kwargs): + """ + Explicitly set color of display zone. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/user_color").execute(*args, **kwargs) + def wall_faces(self, *args, **kwargs): + """ + Set the color of wall faces. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/wall_faces").execute(*args, **kwargs) + def interface_faces(self, *args, **kwargs): + """ + Set the color of mesh Interfaces. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/interface_faces").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + List available colors. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/list").execute(*args, **kwargs) + def reset_colors(self, *args, **kwargs): + """ + Reset individual mesh surface colors to the defaults. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/reset_colors").execute(*args, **kwargs) + def surface(self, *args, **kwargs): + """ + Set the color of surfaces. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/surface").execute(*args, **kwargs) + def skip_label(self, *args, **kwargs): + """ + Set the number of labels to be skipped in the colopmap scale. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/skip_label").execute(*args, **kwargs) + def automatic_skip(self, *args, **kwargs): + """ + Determine whether to skip labels in the colopmap scale automatically. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/automatic_skip").execute(*args, **kwargs) + def graphics_color_theme(self, *args, **kwargs): + """ + Enter the graphics color theme menu. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/graphics_color_theme").execute(*args, **kwargs) - class cell_register_operations(metaclass=PyMenuMeta): - """ - Manage Cell Register Operations. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def add(self, *args, **kwargs): - """ - Add a new object. - """ - return PyMenu(self.service, "/solution/calculation_activities/cell_register_operations/add").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edit an object. - """ - return PyMenu(self.service, "/solution/calculation_activities/cell_register_operations/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Delete an object. - """ - return PyMenu(self.service, "/solution/calculation_activities/cell_register_operations/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - List objects. - """ - return PyMenu(self.service, "/solution/calculation_activities/cell_register_operations/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): - """ - List properties of an object. - """ - return PyMenu(self.service, "/solution/calculation_activities/cell_register_operations/list_properties").execute(*args, **kwargs) + class by_type(TUIMenu): + """ + Enter the zone type color and material assignment menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.type_name = self.__class__.type_name(path + [("type_name", None)], service) + super().__init__(path, service) + def only_list_case_boundaries(self, *args, **kwargs): + """ + Only list the boundary types that are assigned in this case. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/only_list_case_boundaries").execute(*args, **kwargs) + def use_inherent_material_color(self, *args, **kwargs): + """ + Use inherent material color for boundary zones. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/use_inherent_material_color").execute(*args, **kwargs) + def reset(self, *args, **kwargs): + """ + To reset colors and/or materials to the defaults. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/reset").execute(*args, **kwargs) - class execute_commands(metaclass=PyMenuMeta): - """ - Enter the execute-monitor-commands menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def add_edit(self, *args, **kwargs): - """ - Add or edit execute-commands. - """ - return PyMenu(self.service, "/solution/calculation_activities/execute_commands/add_edit").execute(*args, **kwargs) - def enable(self, *args, **kwargs): - """ - Enable an execute-command. - """ - return PyMenu(self.service, "/solution/calculation_activities/execute_commands/enable").execute(*args, **kwargs) - def disable(self, *args, **kwargs): - """ - Disable an execute-command. - """ - return PyMenu(self.service, "/solution/calculation_activities/execute_commands/disable").execute(*args, **kwargs) - def copy(self, *args, **kwargs): - """ - Copy an execute-command. - """ - return PyMenu(self.service, "/solution/calculation_activities/execute_commands/copy").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Delete an execute-command. - """ - return PyMenu(self.service, "/solution/calculation_activities/execute_commands/delete").execute(*args, **kwargs) - def export(self, *args, **kwargs): - """ - Export execute-commands to a TSV file. - """ - return PyMenu(self.service, "/solution/calculation_activities/execute_commands/export").execute(*args, **kwargs) - def import_(self, *args, **kwargs): - """ - Import execute-commands from a TSV file. - """ - return PyMenu(self.service, "/solution/calculation_activities/execute_commands/import").execute(*args, **kwargs) + class type_name(TUIMenu): + """ + Select the boundary type to specify colors and/or materials. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.axis = self.__class__.axis(path + [("axis", None)], service) + self.far_field = self.__class__.far_field(path + [("far_field", None)], service) + self.free_surface = self.__class__.free_surface(path + [("free_surface", None)], service) + self.inlet = self.__class__.inlet(path + [("inlet", None)], service) + self.interface = self.__class__.interface(path + [("interface", None)], service) + self.interior = self.__class__.interior(path + [("interior", None)], service) + self.internal = self.__class__.internal(path + [("internal", None)], service) + self.outlet = self.__class__.outlet(path + [("outlet", None)], service) + self.overset = self.__class__.overset(path + [("overset", None)], service) + self.periodic = self.__class__.periodic(path + [("periodic", None)], service) + self.rans_les_interface = self.__class__.rans_les_interface(path + [("rans_les_interface", None)], service) + self.surface = self.__class__.surface(path + [("surface", None)], service) + self.symmetry = self.__class__.symmetry(path + [("symmetry", None)], service) + self.traction = self.__class__.traction(path + [("traction", None)], service) + self.wall = self.__class__.wall(path + [("wall", None)], service) + super().__init__(path, service) - class solution_strategy(metaclass=PyMenuMeta): - """ - Enter the automatic initialization and case modification strategy menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.automatic_case_modification = self.__class__.automatic_case_modification(path + [("automatic_case_modification", None)], service) - def enable_strategy(self, *args, **kwargs): - """ - Specify whether automatic initialization and case modification should be enabled. - """ - return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/enable_strategy").execute(*args, **kwargs) - def execute_strategy(self, *args, **kwargs): - """ - Execute the automatic initialization and case modification strategy defined at present. - """ - return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/execute_strategy").execute(*args, **kwargs) - def add_edit_modification(self, *args, **kwargs): - """ - Define a single case modification. - """ - return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/add_edit_modification").execute(*args, **kwargs) - def copy_modification(self, *args, **kwargs): - """ - Copy a single case modification. - """ - return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/copy_modification").execute(*args, **kwargs) - def delete_modification(self, *args, **kwargs): - """ - Delete a single case modification. - """ - return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/delete_modification").execute(*args, **kwargs) - def enable_modification(self, *args, **kwargs): - """ - Enable a single defined case modification. - """ - return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/enable_modification").execute(*args, **kwargs) - def disable_modification(self, *args, **kwargs): - """ - Disable a single defined case modification. - """ - return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/disable_modification").execute(*args, **kwargs) - def import_modifications(self, *args, **kwargs): - """ - Import a list of case modifications from a tsv file. - """ - return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/import_modifications").execute(*args, **kwargs) - def export_modifications(self, *args, **kwargs): - """ - Export all case modifications to a tsv file. - """ - return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/export_modifications").execute(*args, **kwargs) - def continue_strategy_execution(self, *args, **kwargs): - """ - Continue execution of the automatic initialization and case modification strategy defined at present. - """ - return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/continue_strategy_execution").execute(*args, **kwargs) - def automatic_initialization(self, *args, **kwargs): - """ - Define how the case is to be initialized automatically. - """ - return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/automatic_initialization").execute(*args, **kwargs) + class axis(TUIMenu): + """ + Set the material and/or color for the selected boundary type. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/axis/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/axis/material").execute(*args, **kwargs) + + class far_field(TUIMenu): + """ + Set the material and/or color for the selected boundary type. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/far_field/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/far_field/material").execute(*args, **kwargs) + + class free_surface(TUIMenu): + """ + Set the material and/or color for the selected boundary type. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/free_surface/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/free_surface/material").execute(*args, **kwargs) + + class inlet(TUIMenu): + """ + Set the material and/or color for the selected boundary type. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/inlet/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/inlet/material").execute(*args, **kwargs) + + class interface(TUIMenu): + """ + Set the material and/or color for the selected boundary type. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/interface/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/interface/material").execute(*args, **kwargs) + + class interior(TUIMenu): + """ + Set the material and/or color for the selected boundary type. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/interior/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/interior/material").execute(*args, **kwargs) + + class internal(TUIMenu): + """ + Set the material and/or color for the selected boundary type. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/internal/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/internal/material").execute(*args, **kwargs) + + class outlet(TUIMenu): + """ + Set the material and/or color for the selected boundary type. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/outlet/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/outlet/material").execute(*args, **kwargs) - class automatic_case_modification(metaclass=PyMenuMeta): - """ - Define how the case is to be modified as the solution progresses. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def before_init_modification(self, *args, **kwargs): - """ - Specify modification to be performed before initialization. - """ - return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/automatic_case_modification/before_init_modification").execute(*args, **kwargs) - def original_settings(self, *args, **kwargs): - """ - Specify modification to be performed after initialization to restore to original settings. - """ - return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/automatic_case_modification/original_settings").execute(*args, **kwargs) - def modifications(self, *args, **kwargs): - """ - Specify modifications to be performed during solution. - """ - return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/automatic_case_modification/modifications").execute(*args, **kwargs) + class overset(TUIMenu): + """ + Set the material and/or color for the selected boundary type. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/overset/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/overset/material").execute(*args, **kwargs) - class cell_registers(metaclass=PyMenuMeta): - """ - Manage Cell Registers. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def adapt(self, *args, **kwargs): - """ - Adapt cell register objects. - """ - return PyMenu(self.service, "/solution/cell_registers/adapt").execute(*args, **kwargs) - def add(self, *args, **kwargs): - """ - Add a new object. - """ - return PyMenu(self.service, "/solution/cell_registers/add").execute(*args, **kwargs) - def apply_poor_mesh_numerics(self, *args, **kwargs): - """ - Apply poor mesh numerics to cell register objects. - """ - return PyMenu(self.service, "/solution/cell_registers/apply_poor_mesh_numerics").execute(*args, **kwargs) - def coarsen(self, *args, **kwargs): - """ - Coarsen cell register objects. - """ - return PyMenu(self.service, "/solution/cell_registers/coarsen").execute(*args, **kwargs) - def display(self, *args, **kwargs): - """ - Display cell register objects. - """ - return PyMenu(self.service, "/solution/cell_registers/display").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edit an object. - """ - return PyMenu(self.service, "/solution/cell_registers/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Delete an object. - """ - return PyMenu(self.service, "/solution/cell_registers/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - List objects. - """ - return PyMenu(self.service, "/solution/cell_registers/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): - """ - List properties of an object. - """ - return PyMenu(self.service, "/solution/cell_registers/list_properties").execute(*args, **kwargs) - def refine(self, *args, **kwargs): - """ - Refine cell register objects. - """ - return PyMenu(self.service, "/solution/cell_registers/refine").execute(*args, **kwargs) + class periodic(TUIMenu): + """ + Set the material and/or color for the selected boundary type. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/periodic/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/periodic/material").execute(*args, **kwargs) - class controls(metaclass=PyMenuMeta): - """ - Enter the controls menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.acoustics_wave_equation_controls = self.__class__.acoustics_wave_equation_controls(path + [("acoustics_wave_equation_controls", None)], service) - self.advanced = self.__class__.advanced(path + [("advanced", None)], service) - self.contact_solution_controls = self.__class__.contact_solution_controls(path + [("contact_solution_controls", None)], service) - self.query = self.__class__.query(path + [("query", None)], service) - def courant_number(self, *args, **kwargs): - """ - Set the fine mesh Courant number (time step factor). - """ - return PyMenu(self.service, "/solution/controls/courant_number").execute(*args, **kwargs) - def equations(self, *args, **kwargs): - """ - Enter the equations menu. - """ - return PyMenu(self.service, "/solution/controls/equations").execute(*args, **kwargs) - def limits(self, *args, **kwargs): - """ - Set solver limits for the values of various solution variables. - """ - return PyMenu(self.service, "/solution/controls/limits").execute(*args, **kwargs) - def p_v_controls(self, *args, **kwargs): - """ - Set P-V-Controls. - """ - return PyMenu(self.service, "/solution/controls/p_v_controls").execute(*args, **kwargs) - def relaxation_factor(self, *args, **kwargs): - """ - Enter the relaxation-factor menu. - """ - return PyMenu(self.service, "/solution/controls/relaxation_factor").execute(*args, **kwargs) - def set_controls_to_default(self, *args, **kwargs): - """ - Set controls to default values. - """ - return PyMenu(self.service, "/solution/controls/set_controls_to_default").execute(*args, **kwargs) - def under_relaxation(self, *args, **kwargs): - """ - Enter the under-relaxation menu. - """ - return PyMenu(self.service, "/solution/controls/under_relaxation").execute(*args, **kwargs) + class rans_les_interface(TUIMenu): + """ + Set the material and/or color for the selected boundary type. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/rans_les_interface/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/rans_les_interface/material").execute(*args, **kwargs) - class acoustics_wave_equation_controls(metaclass=PyMenuMeta): - """ - Enter menu for acoustics wave equation solver controls. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.expert = self.__class__.expert(path + [("expert", None)], service) - def relative_convergence_criterion(self, *args, **kwargs): - """ - Specify convergence tolerance for the timestep iterations - as the target residual reduction factor. - """ - return PyMenu(self.service, "/solution/controls/acoustics_wave_equation_controls/relative_convergence_criterion").execute(*args, **kwargs) - def max_iterations_per_timestep(self, *args, **kwargs): - """ - Specify maximum number of iterations per timestep. - """ - return PyMenu(self.service, "/solution/controls/acoustics_wave_equation_controls/max_iterations_per_timestep").execute(*args, **kwargs) + class surface(TUIMenu): + """ + Set the material and/or color for the selected boundary type. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/surface/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/surface/material").execute(*args, **kwargs) - class expert(metaclass=PyMenuMeta): - """ - Enter menu for expert controls. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def under_relaxation_factor(self, *args, **kwargs): - """ - Specify under-relaxation factor to be used in - the diagonal matrix elements of implicit solver. - """ - return PyMenu(self.service, "/solution/controls/acoustics_wave_equation_controls/expert/under_relaxation_factor").execute(*args, **kwargs) - def explicit_relaxation_factor(self, *args, **kwargs): - """ - Specify explicit relaxation factor to be applied to - the solution correction when updating solution in the timestep iterations. - """ - return PyMenu(self.service, "/solution/controls/acoustics_wave_equation_controls/expert/explicit_relaxation_factor").execute(*args, **kwargs) + class symmetry(TUIMenu): + """ + Set the material and/or color for the selected boundary type. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/symmetry/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/symmetry/material").execute(*args, **kwargs) - class advanced(metaclass=PyMenuMeta): - """ - Controls advanced options. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.amg_options = self.__class__.amg_options(path + [("amg_options", None)], service) - self.fast_transient_settings = self.__class__.fast_transient_settings(path + [("fast_transient_settings", None)], service) - def correction_tolerance(self, *args, **kwargs): - """ - Enter the correction tolerance menu. - """ - return PyMenu(self.service, "/solution/controls/advanced/correction_tolerance").execute(*args, **kwargs) - def multi_grid_amg(self, *args, **kwargs): - """ - Set the parameters that govern the algebraic multigrid procedure. - """ - return PyMenu(self.service, "/solution/controls/advanced/multi_grid_amg").execute(*args, **kwargs) - def multi_grid_controls(self, *args, **kwargs): - """ - Enter the multi-grid-controls menu. - """ - return PyMenu(self.service, "/solution/controls/advanced/multi_grid_controls").execute(*args, **kwargs) - def multi_grid_fas(self, *args, **kwargs): - """ - Set the coefficients that govern the FAS multigrid procedure. - """ - return PyMenu(self.service, "/solution/controls/advanced/multi_grid_fas").execute(*args, **kwargs) - def multi_stage(self, *args, **kwargs): - """ - Set the multiple-stage time stepping scheme coefficients. - """ - return PyMenu(self.service, "/solution/controls/advanced/multi_stage").execute(*args, **kwargs) - def relaxation_method(self, *args, **kwargs): - """ - Set the solver relaxation method. - """ - return PyMenu(self.service, "/solution/controls/advanced/relaxation_method").execute(*args, **kwargs) - def slope_limiter_set(self, *args, **kwargs): - """ - Enter the slope limiter set menu. - """ - return PyMenu(self.service, "/solution/controls/advanced/slope_limiter_set").execute(*args, **kwargs) + class traction(TUIMenu): + """ + Set the material and/or color for the selected boundary type. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/traction/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/traction/material").execute(*args, **kwargs) - class amg_options(metaclass=PyMenuMeta): - """ - Enter AMG options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def laplace_coarsening(self, *args, **kwargs): - """ - Set AMG laplace coarsening options. - """ - return PyMenu(self.service, "/solution/controls/advanced/amg_options/laplace_coarsening").execute(*args, **kwargs) - def conservative_amg_coarsening(self, *args, **kwargs): - """ - Use conservative AMG coarsening?. - """ - return PyMenu(self.service, "/solution/controls/advanced/amg_options/conservative_amg_coarsening").execute(*args, **kwargs) - def aggressive_amg_coarsening(self, *args, **kwargs): + class wall(TUIMenu): + """ + Set the material and/or color for the selected boundary type. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Set a color for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/wall/color").execute(*args, **kwargs) + def material(self, *args, **kwargs): + """ + Set a material for the selected boundary type. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_type/type_name/wall/material").execute(*args, **kwargs) + + class by_surface(TUIMenu): + """ + Enter the surface(s) color and material assignment menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def surfaces(self, *args, **kwargs): + """ + Select the surface(s) to specify colors and/or materials. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_surface/surfaces").execute(*args, **kwargs) + def use_inherent_material_color(self, *args, **kwargs): + """ + Use inherent material color for surfaces. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_surface/use_inherent_material_color").execute(*args, **kwargs) + def reset(self, *args, **kwargs): + """ + To reset colors and/or materials to the defaults. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_surface/reset").execute(*args, **kwargs) + def list_surfaces_by_color(self, *args, **kwargs): + """ + To list the surfaces by its color. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_surface/list_surfaces_by_color").execute(*args, **kwargs) + def list_surfaces_by_material(self, *args, **kwargs): + """ + To list the surfaces by its material. + """ + return PyMenu(self.service, "/results/graphics/expert/set/colors/by_surface/list_surfaces_by_material").execute(*args, **kwargs) + + class contours(TUIMenu): """ - Use aggressive AMG coarsening. + Enter the contour options menu. """ - return PyMenu(self.service, "/solution/controls/advanced/amg_options/aggressive_amg_coarsening").execute(*args, **kwargs) - def amg_gpgpu_options(self, *args, **kwargs): + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def auto_range(self, *args, **kwargs): + """ + Enable/disable auto-computation of range for contours. + """ + return PyMenu(self.service, "/results/graphics/expert/set/contours/auto_range").execute(*args, **kwargs) + def clip_to_range(self, *args, **kwargs): + """ + Enable/disable the clip to range option for filled contours. + """ + return PyMenu(self.service, "/results/graphics/expert/set/contours/clip_to_range").execute(*args, **kwargs) + def surfaces(self, *args, **kwargs): + """ + Set surfaces to be contoured. + """ + return PyMenu(self.service, "/results/graphics/expert/set/contours/surfaces").execute(*args, **kwargs) + def filled_contours(self, *args, **kwargs): + """ + Enable/disable the filled contour option. + """ + return PyMenu(self.service, "/results/graphics/expert/set/contours/filled_contours").execute(*args, **kwargs) + def global_range(self, *args, **kwargs): + """ + Enable/disable the global range for contours option. + """ + return PyMenu(self.service, "/results/graphics/expert/set/contours/global_range").execute(*args, **kwargs) + def line_contours(self, *args, **kwargs): + """ + Enable/disable the filled contour option. + """ + return PyMenu(self.service, "/results/graphics/expert/set/contours/line_contours").execute(*args, **kwargs) + def log_scale(self, *args, **kwargs): + """ + Enable/disable the use of a log scale. + """ + return PyMenu(self.service, "/results/graphics/expert/set/contours/log_scale").execute(*args, **kwargs) + def n_contour(self, *args, **kwargs): + """ + Set the number of contour levels. + """ + return PyMenu(self.service, "/results/graphics/expert/set/contours/n_contour").execute(*args, **kwargs) + def node_values(self, *args, **kwargs): + """ + Enable/disable the plot of node values. + """ + return PyMenu(self.service, "/results/graphics/expert/set/contours/node_values").execute(*args, **kwargs) + def render_mesh(self, *args, **kwargs): + """ + Determine whether or not to render the mesh on top of contours, vectors, etc. + """ + return PyMenu(self.service, "/results/graphics/expert/set/contours/render_mesh").execute(*args, **kwargs) + def coloring(self, *args, **kwargs): + """ + Select coloring option. + """ + return PyMenu(self.service, "/results/graphics/expert/set/contours/coloring").execute(*args, **kwargs) + + class picture(TUIMenu): """ - Set GPGPU AMG solver options. + Enter the hardcopy/save-picture options menu. """ - return PyMenu(self.service, "/solution/controls/advanced/amg_options/amg_gpgpu_options").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + self.color_mode = self.__class__.color_mode(path + [("color_mode", None)], service) + self.driver = self.__class__.driver(path + [("driver", None)], service) + super().__init__(path, service) + def invert_background(self, *args, **kwargs): + """ + Use a white background when the picture is saved. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/invert_background").execute(*args, **kwargs) + def landscape(self, *args, **kwargs): + """ + Plot hardcopies in landscape or portrait orientation. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/landscape").execute(*args, **kwargs) + def preview(self, *args, **kwargs): + """ + Display a preview image of a hardcopy. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/preview").execute(*args, **kwargs) + def x_resolution(self, *args, **kwargs): + """ + Set the width of raster-formatted images in pixels (0 implies current window size). + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/x_resolution").execute(*args, **kwargs) + def y_resolution(self, *args, **kwargs): + """ + Set the height of raster-formatted images in pixels (0 implies current window size). + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/y_resolution").execute(*args, **kwargs) + def dpi(self, *args, **kwargs): + """ + Set the DPI for EPS and Postscript files, specifies the resolution in dots per inch (DPI) instead of setting the width and height. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/dpi").execute(*args, **kwargs) + def use_window_resolution(self, *args, **kwargs): + """ + Use the currently active window's resolution for hardcopy (ignores the x-resolution and y-resolution in this case). + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/use_window_resolution").execute(*args, **kwargs) + def set_standard_resolution(self, *args, **kwargs): + """ + Select from pre-defined resolution list. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/set_standard_resolution").execute(*args, **kwargs) + def jpeg_hardcopy_quality(self, *args, **kwargs): + """ + To set jpeg hardcopy quality. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/jpeg_hardcopy_quality").execute(*args, **kwargs) + + class color_mode(TUIMenu): + """ + Enter the hardcopy color mode menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Plot hardcopies in color. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/color_mode/color").execute(*args, **kwargs) + def gray_scale(self, *args, **kwargs): + """ + Convert color to grayscale for hardcopy. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/color_mode/gray_scale").execute(*args, **kwargs) + def mono_chrome(self, *args, **kwargs): + """ + Convert color to monochrome (black and white) for hardcopy. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/color_mode/mono_chrome").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Display the current hardcopy color mode. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/color_mode/list").execute(*args, **kwargs) - class fast_transient_settings(metaclass=PyMenuMeta): - """ - Enter the fast transient settings menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def rk2(self, *args, **kwargs): - """ - Enable the use of a two-stage Runge-Kutta scheme for time integration. - """ - return PyMenu(self.service, "/solution/controls/advanced/fast_transient_settings/rk2").execute(*args, **kwargs) + class driver(TUIMenu): + """ + Enter the set hardcopy driver menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.post_format = self.__class__.post_format(path + [("post_format", None)], service) + super().__init__(path, service) + def dump_window(self, *args, **kwargs): + """ + Set the command used to dump the graphics window to a file. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/dump_window").execute(*args, **kwargs) + def eps(self, *args, **kwargs): + """ + Produce encapsulated PostScript (EPS) output for hardcopies. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/eps").execute(*args, **kwargs) + def jpeg(self, *args, **kwargs): + """ + Produce JPEG output for hardcopies. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/jpeg").execute(*args, **kwargs) + def post_script(self, *args, **kwargs): + """ + Produce PostScript output for hardcopies. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/post_script").execute(*args, **kwargs) + def ppm(self, *args, **kwargs): + """ + Produce PPM output for hardcopies. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/ppm").execute(*args, **kwargs) + def tiff(self, *args, **kwargs): + """ + Use TIFF output for hardcopies. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/tiff").execute(*args, **kwargs) + def png(self, *args, **kwargs): + """ + Use PNG output for hardcopies. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/png").execute(*args, **kwargs) + def hsf(self, *args, **kwargs): + """ + Use HSF output for hardcopies. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/hsf").execute(*args, **kwargs) + def avz(self, *args, **kwargs): + """ + Use AVZ output for hardcopies. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/avz").execute(*args, **kwargs) + def glb(self, *args, **kwargs): + """ + Use GLB output for hardcopies. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/glb").execute(*args, **kwargs) + def vrml(self, *args, **kwargs): + """ + Use VRML output for hardcopies. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/vrml").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + List the current hardcopy driver. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/list").execute(*args, **kwargs) + def options(self, *args, **kwargs): + """ + Set the hardcopy options. Available options are: + \\n "no gamma correction", disables gamma correction of colors, + \\n "physical size = (width,height)", where width and height + are the actual measurements of the printable area of the page + in centimeters. + \\n "subscreen = (left,right,bottom,top)", where left,right, + bottom, and top are numbers in [-1,1] describing a subwindow on + the page in which to place the hardcopy. + + \\n The options may be combined by separating them with commas. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/options").execute(*args, **kwargs) - class contact_solution_controls(metaclass=PyMenuMeta): - """ - Solver controls for contact marks method. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.parameters = self.__class__.parameters(path + [("parameters", None)], service) - self.spatial = self.__class__.spatial(path + [("spatial", None)], service) - self.transient = self.__class__.transient(path + [("transient", None)], service) - self.amg = self.__class__.amg(path + [("amg", None)], service) - self.models = self.__class__.models(path + [("models", None)], service) - self.methods = self.__class__.methods(path + [("methods", None)], service) - self.miscellaneous = self.__class__.miscellaneous(path + [("miscellaneous", None)], service) - def solution_stabilization(self, *args, **kwargs): - """ - Automatic solver settings adjustment for solution stabilization during contact process. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/solution_stabilization").execute(*args, **kwargs) - def set_settings_to_default(self, *args, **kwargs): - """ - Set contact solution stabilization to default. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/set_settings_to_default").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Specify verbosity level for contact solution controls. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/verbosity").execute(*args, **kwargs) + class post_format(TUIMenu): + """ + Enter the PostScript driver format menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def fast_raster(self, *args, **kwargs): + """ + Use the new raster format. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/post_format/fast_raster").execute(*args, **kwargs) + def raster(self, *args, **kwargs): + """ + Use the original raster format. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/post_format/raster").execute(*args, **kwargs) + def rle_raster(self, *args, **kwargs): + """ + Use the run-length encoded raster format. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/post_format/rle_raster").execute(*args, **kwargs) + def vector(self, *args, **kwargs): + """ + Use vector format. + """ + return PyMenu(self.service, "/results/graphics/expert/set/picture/driver/post_format/vector").execute(*args, **kwargs) - class parameters(metaclass=PyMenuMeta): - """ - Parameters used in stabilization strategy. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def iterations(self, *args, **kwargs): - """ - Specify additional iterations to accomodate contact solution stabilization. + class lights(TUIMenu): """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/parameters/iterations").execute(*args, **kwargs) - def solution_stabilization_persistence(self, *args, **kwargs): - """ - Persistence of the solution stabilization based on events [0-contact based, 1-always on]. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/parameters/solution_stabilization_persistence").execute(*args, **kwargs) - def persistence_fixed_time_steps(self, *args, **kwargs): - """ - Specify fixed time-steps for solution stabilization persistence after trigger. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/parameters/persistence_fixed_time_steps").execute(*args, **kwargs) - def persistence_fixed_duration(self, *args, **kwargs): - """ - Specify fixed time for solution stabilization persistence after trigger. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/parameters/persistence_fixed_duration").execute(*args, **kwargs) - def extrapolation_method(self, *args, **kwargs): - """ - Solution extrapolation method for cells changing status from contact to non-contact [0-none, 1-local extrapolation]. + Enter the lights menu. """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/parameters/extrapolation_method").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + self.lighting_interpolation = self.__class__.lighting_interpolation(path + [("lighting_interpolation", None)], service) + super().__init__(path, service) + def lights_on(self, *args, **kwargs): + """ + Turn all active lighting on/off. + """ + return PyMenu(self.service, "/results/graphics/expert/set/lights/lights_on").execute(*args, **kwargs) + def set_ambient_color(self, *args, **kwargs): + """ + Set the ambient light color for the scene. + """ + return PyMenu(self.service, "/results/graphics/expert/set/lights/set_ambient_color").execute(*args, **kwargs) + def set_light(self, *args, **kwargs): + """ + Add or modify a directional, colored light. + """ + return PyMenu(self.service, "/results/graphics/expert/set/lights/set_light").execute(*args, **kwargs) + def headlight_on(self, *args, **kwargs): + """ + Turn the light that moves with the camera on or off. + """ + return PyMenu(self.service, "/results/graphics/expert/set/lights/headlight_on").execute(*args, **kwargs) - class spatial(metaclass=PyMenuMeta): - """ - Spatial discretization control options. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def first_to_second_order_blending(self, *args, **kwargs): - """ - Set factor to control first order to second order blending. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/spatial/first_to_second_order_blending").execute(*args, **kwargs) - def first_to_second_order_blending_list(self, *args, **kwargs): - """ - List set factor to control first order to second order blending. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/spatial/first_to_second_order_blending_list").execute(*args, **kwargs) - def scheme(self, *args, **kwargs): - """ - Set advection scheme for contact event stability. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/spatial/scheme").execute(*args, **kwargs) - def flow_skew_diffusion_exclude(self, *args, **kwargs): - """ - Exclude skew diffusion discretization contribution for momentum. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/spatial/flow_skew_diffusion_exclude").execute(*args, **kwargs) - def scalars_skew_diffusion_exclude(self, *args, **kwargs): - """ - Exclude skew diffusion discretization contribution for scalars. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/spatial/scalars_skew_diffusion_exclude").execute(*args, **kwargs) - def rhie_chow_flux_specify(self, *args, **kwargs): - """ - Allow specification of the the rhie-chow flux method. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/spatial/rhie_chow_flux_specify").execute(*args, **kwargs) - def rhie_chow_method(self, *args, **kwargs): - """ - Enter the rhie-chow flux method. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/spatial/rhie_chow_method").execute(*args, **kwargs) + class lighting_interpolation(TUIMenu): + """ + Set lighting interpolation method. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def automatic(self, *args, **kwargs): + """ + Choose Automatic to automatically select the best lighting method for a given graphics object. + """ + return PyMenu(self.service, "/results/graphics/expert/set/lights/lighting_interpolation/automatic").execute(*args, **kwargs) + def flat(self, *args, **kwargs): + """ + Use flat shading for meshes and polygons. + """ + return PyMenu(self.service, "/results/graphics/expert/set/lights/lighting_interpolation/flat").execute(*args, **kwargs) + def gouraud(self, *args, **kwargs): + """ + Use Gouraud shading to calculate the color at each vertex of a polygon and interpolate it in the interior. + """ + return PyMenu(self.service, "/results/graphics/expert/set/lights/lighting_interpolation/gouraud").execute(*args, **kwargs) + def phong(self, *args, **kwargs): + """ + Use Phong shading to interpolate the normals for each pixel of a polygon and compute a color at every pixel. + """ + return PyMenu(self.service, "/results/graphics/expert/set/lights/lighting_interpolation/phong").execute(*args, **kwargs) - class transient(metaclass=PyMenuMeta): - """ - Transient discretization control options . - """ - def __init__(self, path, service): - self.path = path - self.service = service - def transient_parameters_specify(self, *args, **kwargs): - """ - Allow transient parameter specification. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/transient/transient_parameters_specify").execute(*args, **kwargs) - def transient_scheme(self, *args, **kwargs): - """ - Specify temporal scheme to be used. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/transient/transient_scheme").execute(*args, **kwargs) - def time_scale_modification_method(self, *args, **kwargs): - """ - Enter time scale modification method. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/transient/time_scale_modification_method").execute(*args, **kwargs) - def time_scale_modification_factor(self, *args, **kwargs): + class particle_tracks(TUIMenu): """ - Specify time-scale modification factor. + Enter the particle-tracks menu to set parameters for display of particle tracks. """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/transient/time_scale_modification_factor").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + self.sphere_settings = self.__class__.sphere_settings(path + [("sphere_settings", None)], service) + self.vector_settings = self.__class__.vector_settings(path + [("vector_settings", None)], service) + self.filter_settings = self.__class__.filter_settings(path + [("filter_settings", None)], service) + super().__init__(path, service) + def display(self, *args, **kwargs): + """ + Determine whether particle tracks will be displayed or only tracked. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/display").execute(*args, **kwargs) + def history_filename(self, *args, **kwargs): + """ + Specify the name of the particle history file. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/history_filename").execute(*args, **kwargs) + def report_to(self, *args, **kwargs): + """ + Specify the destination for the report (console, file, none). + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/report_to").execute(*args, **kwargs) + def report_type(self, *args, **kwargs): + """ + Set the report type for particle tracks. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/report_type").execute(*args, **kwargs) + def report_variables(self, *args, **kwargs): + """ + Set the report variables. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/report_variables").execute(*args, **kwargs) + def report_default_variables(self, *args, **kwargs): + """ + Set the report variables to default. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/report_default_variables").execute(*args, **kwargs) + def track_single_particle_stream(self, *args, **kwargs): + """ + Specify the stream ID to be tracked. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/track_single_particle_stream").execute(*args, **kwargs) + def arrow_scale(self, *args, **kwargs): + """ + Set the scale factor for arrows drawn on particle tracks. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/arrow_scale").execute(*args, **kwargs) + def arrow_space(self, *args, **kwargs): + """ + Set the spacing factor for arrows drawn on particle tracks. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/arrow_space").execute(*args, **kwargs) + def coarsen_factor(self, *args, **kwargs): + """ + Set the particle tracks coarsening factor. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/coarsen_factor").execute(*args, **kwargs) + def line_width(self, *args, **kwargs): + """ + Set the width for particle track. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/line_width").execute(*args, **kwargs) + def marker_size(self, *args, **kwargs): + """ + Set the marker size for particle drawing. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/marker_size").execute(*args, **kwargs) + def radius(self, *args, **kwargs): + """ + Set the radius for particle track (ribbons/cylinder only) cross-section. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/radius").execute(*args, **kwargs) + def style(self, *args, **kwargs): + """ + Set the display style for particle track (line/ribbon/cylinder/sphere). + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/style").execute(*args, **kwargs) + def twist_factor(self, *args, **kwargs): + """ + Set the scale factor for twisting (ribbons only). + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/twist_factor").execute(*args, **kwargs) + def sphere_attrib(self, *args, **kwargs): + """ + Specify size and number of slices to be used in drawing spheres. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_attrib").execute(*args, **kwargs) + def particle_skip(self, *args, **kwargs): + """ + Specify how many particle tracks should be displayed. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/particle_skip").execute(*args, **kwargs) - class amg(metaclass=PyMenuMeta): - """ - AMG control options. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enforce_laplace_coarsening(self, *args, **kwargs): - """ - Enforce the use of laplace coarsening in AMG. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/amg/enforce_laplace_coarsening").execute(*args, **kwargs) - def increase_pre_sweeps(self, *args, **kwargs): - """ - Allow increase in AMG pre-sweep. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/amg/increase_pre_sweeps").execute(*args, **kwargs) - def pre_sweeps(self, *args, **kwargs): - """ - Specify the number of AMG pre-sweeps. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/amg/pre_sweeps").execute(*args, **kwargs) - def specify_coarsening_rate(self, *args, **kwargs): - """ - Modify AMG coarsening rate. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/amg/specify_coarsening_rate").execute(*args, **kwargs) - def coarsen_rate(self, *args, **kwargs): - """ - Specify AMG coarsening rate. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/amg/coarsen_rate").execute(*args, **kwargs) + class sphere_settings(TUIMenu): + """ + Provide sphere specific input. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def vary_diameter(self, *args, **kwargs): + """ + Specify whether the spheres can vary with another variable. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_settings/vary_diameter").execute(*args, **kwargs) + def diameter(self, *args, **kwargs): + """ + Diameter of the spheres when vary-diameter? is disabled. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_settings/diameter").execute(*args, **kwargs) + def auto_range(self, *args, **kwargs): + """ + Specify whether displayed spheres should include auto range of variable to size spheres. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_settings/auto_range").execute(*args, **kwargs) + def minimum(self, *args, **kwargs): + """ + Set the minimum value of the sphere to be displayed. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_settings/minimum").execute(*args, **kwargs) + def maximum(self, *args, **kwargs): + """ + Set the maximum value of the sphere to be displayed. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_settings/maximum").execute(*args, **kwargs) + def smooth_parameter(self, *args, **kwargs): + """ + Specify number of slices to be used in drawing spheres. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_settings/smooth_parameter").execute(*args, **kwargs) + def scale_factor(self, *args, **kwargs): + """ + Specify a scale factor to enlarge/reduce the size of spheres. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_settings/scale_factor").execute(*args, **kwargs) + def size_variable(self, *args, **kwargs): + """ + Select a particle variable to size the spheres. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/sphere_settings/size_variable").execute(*args, **kwargs) + + class vector_settings(TUIMenu): + """ + Set vector specific input. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def style(self, *args, **kwargs): + """ + Enable and set the display style for particle vectors (none/vector/centered-vector/centered-cylinder). + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/style").execute(*args, **kwargs) + def vector_length(self, *args, **kwargs): + """ + Specify the length of constant vectors. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/vector_length").execute(*args, **kwargs) + def vector_length_variable(self, *args, **kwargs): + """ + Select a particle variable to specify the length of vectors. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/vector_length_variable").execute(*args, **kwargs) + def scale_factor(self, *args, **kwargs): + """ + Specify a scale factor to enlarge/reduce the length of vectors. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/scale_factor").execute(*args, **kwargs) + def length_variable(self, *args, **kwargs): + """ + Specify whether the displayed vectors have length varying with another variable. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/length_variable").execute(*args, **kwargs) + def length_to_head_ratio(self, *args, **kwargs): + """ + Specify ratio of length to head for vectors and length to diameter for cylinders. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/length_to_head_ratio").execute(*args, **kwargs) + def constant_color(self, *args, **kwargs): + """ + Specify a constant color for the vectors. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/constant_color").execute(*args, **kwargs) + def color_variable(self, *args, **kwargs): + """ + Specify whether the vectors should be colored by variable specified in /display/particle-track/particle-track (if false use a constant color). + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/color_variable").execute(*args, **kwargs) + def vector_variable(self, *args, **kwargs): + """ + Select a particle vector function to specify vector direction. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/vector_settings/vector_variable").execute(*args, **kwargs) - class models(metaclass=PyMenuMeta): - """ - Model control options. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def model_ramping(self, *args, **kwargs): - """ - Activate model ramping for solver stability and accuracy. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/models/model_ramping").execute(*args, **kwargs) - def ramp_flow(self, *args, **kwargs): - """ - Ramp flow for solver stability and accuracy. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/models/ramp_flow").execute(*args, **kwargs) - def ramp_turbulence(self, *args, **kwargs): - """ - Ramp turbulence for solver stability and accuracy. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/models/ramp_turbulence").execute(*args, **kwargs) - def ramp_scalars(self, *args, **kwargs): - """ - Ramp all scalar transport equations for solver stability and accuracy. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/models/ramp_scalars").execute(*args, **kwargs) + class filter_settings(TUIMenu): + """ + Set filter for particle display. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable_filtering(self, *args, **kwargs): + """ + Specify whether particle display is filtered. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/filter_settings/enable_filtering").execute(*args, **kwargs) + def inside(self, *args, **kwargs): + """ + Specify whether filter variable needs to be inside min/max to be displayed (else outside min/max). + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/filter_settings/inside").execute(*args, **kwargs) + def filter_variable(self, *args, **kwargs): + """ + Select a variable used for filtering of particles. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/filter_settings/filter_variable").execute(*args, **kwargs) + def minimum(self, *args, **kwargs): + """ + Specify the lower bound for the filter variable. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/filter_settings/minimum").execute(*args, **kwargs) + def maximum(self, *args, **kwargs): + """ + Specify the upper bound for the filter variable. + """ + return PyMenu(self.service, "/results/graphics/expert/set/particle_tracks/filter_settings/maximum").execute(*args, **kwargs) - class methods(metaclass=PyMenuMeta): - """ - Methods control options. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def pressure_velocity_coupling_controls(self, *args, **kwargs): - """ - Enable pressure-velocity coupling method change for solver stability and accuracy. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/methods/pressure_velocity_coupling_controls").execute(*args, **kwargs) - def pressure_velocity_coupling_method(self, *args, **kwargs): - """ - Specify pressure-velocity coupling method change for solver stability and accuracy. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/methods/pressure_velocity_coupling_method").execute(*args, **kwargs) - def gradient_controls(self, *args, **kwargs): - """ - Modify gradient method for solver stability and accuracy. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/methods/gradient_controls").execute(*args, **kwargs) - def specify_gradient_method(self, *args, **kwargs): + class path_lines(TUIMenu): """ - Specify gradient method for solver stability and accuracy. + Enter the path-lines menu to set parameters for the display of pathlines. """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/methods/specify_gradient_method").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def arrow_scale(self, *args, **kwargs): + """ + Set the scale factor for arrows drawn on pathlines. + """ + return PyMenu(self.service, "/results/graphics/expert/set/path_lines/arrow_scale").execute(*args, **kwargs) + def arrow_space(self, *args, **kwargs): + """ + Set the spacing factor for arrows drawn on pathlines. + """ + return PyMenu(self.service, "/results/graphics/expert/set/path_lines/arrow_space").execute(*args, **kwargs) + def display_steps(self, *args, **kwargs): + """ + Set the display stepping for pathlines. + """ + return PyMenu(self.service, "/results/graphics/expert/set/path_lines/display_steps").execute(*args, **kwargs) + def error_control(self, *args, **kwargs): + """ + Set error control during pathline computation. + """ + return PyMenu(self.service, "/results/graphics/expert/set/path_lines/error_control").execute(*args, **kwargs) + def line_width(self, *args, **kwargs): + """ + Set the width for pathlines. + """ + return PyMenu(self.service, "/results/graphics/expert/set/path_lines/line_width").execute(*args, **kwargs) + def marker_size(self, *args, **kwargs): + """ + Set the marker size for particle drawing. + """ + return PyMenu(self.service, "/results/graphics/expert/set/path_lines/marker_size").execute(*args, **kwargs) + def maximum_steps(self, *args, **kwargs): + """ + Set the maximum number of steps to take for pathlines. + """ + return PyMenu(self.service, "/results/graphics/expert/set/path_lines/maximum_steps").execute(*args, **kwargs) + def maximum_error(self, *args, **kwargs): + """ + Set the maximum error allowed while computing the pathlines. + """ + return PyMenu(self.service, "/results/graphics/expert/set/path_lines/maximum_error").execute(*args, **kwargs) + def radius(self, *args, **kwargs): + """ + Set the radius for pathline (ribbons/cylinder only) cross-section. + """ + return PyMenu(self.service, "/results/graphics/expert/set/path_lines/radius").execute(*args, **kwargs) + def relative_pathlines(self, *args, **kwargs): + """ + Enable/disable the tracking of pathlines in a relative coordinate system. + """ + return PyMenu(self.service, "/results/graphics/expert/set/path_lines/relative_pathlines").execute(*args, **kwargs) + def style(self, *args, **kwargs): + """ + Set display style for pathlines (line/ribbon/cylinder). + """ + return PyMenu(self.service, "/results/graphics/expert/set/path_lines/style").execute(*args, **kwargs) + def twist_factor(self, *args, **kwargs): + """ + Set the scale factor for twisting (ribbons only). + """ + return PyMenu(self.service, "/results/graphics/expert/set/path_lines/twist_factor").execute(*args, **kwargs) + def step_size(self, *args, **kwargs): + """ + Set the step length between particle positions for path-lines. + """ + return PyMenu(self.service, "/results/graphics/expert/set/path_lines/step_size").execute(*args, **kwargs) + def reverse(self, *args, **kwargs): + """ + Enable/disable the direction of path tracking. + """ + return PyMenu(self.service, "/results/graphics/expert/set/path_lines/reverse").execute(*args, **kwargs) + def sphere_attrib(self, *args, **kwargs): + """ + Specify size and no. of slices to be used in drawing sphere for sphere-style. + """ + return PyMenu(self.service, "/results/graphics/expert/set/path_lines/sphere_attrib").execute(*args, **kwargs) + def track_in_phase(self, *args, **kwargs): + """ + Assign phase to display pathlines in. + """ + return PyMenu(self.service, "/results/graphics/expert/set/path_lines/track_in_phase").execute(*args, **kwargs) - class miscellaneous(metaclass=PyMenuMeta): - """ - Miscellaneous. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def compute_statistics(self, *args, **kwargs): - """ - Compute solution statistics for contact updates. - """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/miscellaneous/compute_statistics").execute(*args, **kwargs) - def statistics_level(self, *args, **kwargs): + class rendering_options(TUIMenu): """ - Solution statistics level for contact updates. + Enter the rendering options menu. """ - return PyMenu(self.service, "/solution/controls/contact_solution_controls/miscellaneous/statistics_level").execute(*args, **kwargs) - - class query(metaclass=PyMenuMeta): - """ - Enter controls query menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.acoustics_wave_equation_controls = self.__class__.acoustics_wave_equation_controls(path + [("acoustics_wave_equation_controls", None)], service) - self.advanced = self.__class__.advanced(path + [("advanced", None)], service) - def courant_number(self, *args, **kwargs): - """ - Get the fine mesh Courant number (time step factor). - """ - return PyMenu(self.service, "/solution/controls/query/courant_number").execute(*args, **kwargs) - def equations(self, *args, **kwargs): - """ - Enter the equations menu. - """ - return PyMenu(self.service, "/solution/controls/query/equations").execute(*args, **kwargs) - def limits(self, *args, **kwargs): - """ - Get solver limits for the values of various solution variables. - """ - return PyMenu(self.service, "/solution/controls/query/limits").execute(*args, **kwargs) - def p_v_controls(self, *args, **kwargs): - """ - Get P-V-Controls. - """ - return PyMenu(self.service, "/solution/controls/query/p_v_controls").execute(*args, **kwargs) - def relaxation_factor(self, *args, **kwargs): - """ - Enter the relaxation-factor menu. - """ - return PyMenu(self.service, "/solution/controls/query/relaxation_factor").execute(*args, **kwargs) - def under_relaxation(self, *args, **kwargs): - """ - Enter under relaxation menu. - """ - return PyMenu(self.service, "/solution/controls/query/under_relaxation").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def auto_spin(self, *args, **kwargs): + """ + Enable/disable mouse view rotations to continue to spin the display after the button is released. + """ + return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/auto_spin").execute(*args, **kwargs) + def device_info(self, *args, **kwargs): + """ + List information for the graphics device. + """ + return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/device_info").execute(*args, **kwargs) + def double_buffering(self, *args, **kwargs): + """ + Enable/disable double-buffering. + """ + return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/double_buffering").execute(*args, **kwargs) + def driver(self, *args, **kwargs): + """ + Change the current graphics driver. + """ + return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/driver").execute(*args, **kwargs) + def hidden_surfaces(self, *args, **kwargs): + """ + Enable/disable hidden surface removal. + """ + return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/hidden_surfaces").execute(*args, **kwargs) + def hidden_surface_method(self, *args, **kwargs): + """ + Specify the method to perform hidden line and hidden surface rendering. + """ + return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/hidden_surface_method").execute(*args, **kwargs) + def outer_face_cull(self, *args, **kwargs): + """ + Enable/disable discarding outer faces during display. + """ + return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/outer_face_cull").execute(*args, **kwargs) + def surface_edge_visibility(self, *args, **kwargs): + """ + Set edge visibility flags for surfaces. + """ + return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/surface_edge_visibility").execute(*args, **kwargs) + def animation_option(self, *args, **kwargs): + """ + Using Wireframe / All option during animation. + """ + return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/animation_option").execute(*args, **kwargs) + def color_map_alignment(self, *args, **kwargs): + """ + Set the color bar alignment. + """ + return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/color_map_alignment").execute(*args, **kwargs) + def help_text_color(self, *args, **kwargs): + """ + Set the color of screen help text. + """ + return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/help_text_color").execute(*args, **kwargs) + def face_displacement(self, *args, **kwargs): + """ + Set face displacement value in Z-buffer units along the Camera Z-axis. + """ + return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/face_displacement").execute(*args, **kwargs) + def set_rendering_options(self, *args, **kwargs): + """ + Set the rendering options. + """ + return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/set_rendering_options").execute(*args, **kwargs) + def show_colormap(self, *args, **kwargs): + """ + Enable/Disable colormap. + """ + return PyMenu(self.service, "/results/graphics/expert/set/rendering_options/show_colormap").execute(*args, **kwargs) - class acoustics_wave_equation_controls(metaclass=PyMenuMeta): - """ - Enter menu for acoustics wave equation solver controls. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.expert = self.__class__.expert(path + [("expert", None)], service) - def relative_convergence_criterion(self, *args, **kwargs): - """ - Specify convergence tolerance for the timestep iterations - as the target residual reduction factor. + class titles(TUIMenu): """ - return PyMenu(self.service, "/solution/controls/query/acoustics_wave_equation_controls/relative_convergence_criterion").execute(*args, **kwargs) - def max_iterations_per_timestep(self, *args, **kwargs): - """ - Specify maximum number of iterations per timestep. + Set problem title. """ - return PyMenu(self.service, "/solution/controls/query/acoustics_wave_equation_controls/max_iterations_per_timestep").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def left_top(self, *args, **kwargs): + """ + Set the title text for left top in title segment. + """ + return PyMenu(self.service, "/results/graphics/expert/set/titles/left_top").execute(*args, **kwargs) + def left_bottom(self, *args, **kwargs): + """ + Set the title text for left bottom in title segment. + """ + return PyMenu(self.service, "/results/graphics/expert/set/titles/left_bottom").execute(*args, **kwargs) + def right_top(self, *args, **kwargs): + """ + Set the title text for right top in title segment. + """ + return PyMenu(self.service, "/results/graphics/expert/set/titles/right_top").execute(*args, **kwargs) + def right_middle(self, *args, **kwargs): + """ + Set the title text for right middle in title segment. + """ + return PyMenu(self.service, "/results/graphics/expert/set/titles/right_middle").execute(*args, **kwargs) + def right_bottom(self, *args, **kwargs): + """ + Set the title text for right bottom in title segment. + """ + return PyMenu(self.service, "/results/graphics/expert/set/titles/right_bottom").execute(*args, **kwargs) - class expert(metaclass=PyMenuMeta): + class velocity_vectors(TUIMenu): """ - Enter menu for expert controls. + Enter the menu to set parameters for display of velocity vectors. """ def __init__(self, path, service): self.path = path self.service = service - def under_relaxation_factor(self, *args, **kwargs): + super().__init__(path, service) + def auto_scale(self, *args, **kwargs): """ - Specify under-relaxation factor to be used in - the diagonal matrix elements of implicit solver. + Enable/disable auto-scale of all vectors so that vector overlap is minimal. """ - return PyMenu(self.service, "/solution/controls/query/acoustics_wave_equation_controls/expert/under_relaxation_factor").execute(*args, **kwargs) - def explicit_relaxation_factor(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/auto_scale").execute(*args, **kwargs) + def color(self, *args, **kwargs): """ - Specify explicit relaxation factor to be applied to - the solution correction when updating solution in the timestep iterations. + Set the color used for all vectors. Set color to the null string to use the color map. """ - return PyMenu(self.service, "/solution/controls/query/acoustics_wave_equation_controls/expert/explicit_relaxation_factor").execute(*args, **kwargs) + return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/color").execute(*args, **kwargs) + def component_x(self, *args, **kwargs): + """ + Enable/disable use of x-component of vectors. + """ + return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/component_x").execute(*args, **kwargs) + def component_y(self, *args, **kwargs): + """ + Enable/disable use of y-component of vectors. + """ + return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/component_y").execute(*args, **kwargs) + def component_z(self, *args, **kwargs): + """ + Enable/disable use of z-component of vectors. + """ + return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/component_z").execute(*args, **kwargs) + def constant_length(self, *args, **kwargs): + """ + Enable/disable setting all vectors to have the same length. + """ + return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/constant_length").execute(*args, **kwargs) + def color_levels(self, *args, **kwargs): + """ + Set the number of colors used from the color map. + """ + return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/color_levels").execute(*args, **kwargs) + def global_range(self, *args, **kwargs): + """ + Enable/disable the global range for vectors option. + """ + return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/global_range").execute(*args, **kwargs) + def in_plane(self, *args, **kwargs): + """ + Toggle the display of in-plane velocity vectors. + """ + return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/in_plane").execute(*args, **kwargs) + def log_scale(self, *args, **kwargs): + """ + Enable/disable the use of a log scale. + """ + return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/log_scale").execute(*args, **kwargs) + def node_values(self, *args, **kwargs): + """ + Enable/disable plotting node values. Cell values will be plotted if "no". + """ + return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/node_values").execute(*args, **kwargs) + def relative(self, *args, **kwargs): + """ + Enable/disable the display of relative velocity vectors. + """ + return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/relative").execute(*args, **kwargs) + def render_mesh(self, *args, **kwargs): + """ + Enable/disable rendering the mseh on top of contours, vectors, etc. + """ + return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/render_mesh").execute(*args, **kwargs) + def scale(self, *args, **kwargs): + """ + Set the value by which the vector length will be scaled. + """ + return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/scale").execute(*args, **kwargs) + def scale_head(self, *args, **kwargs): + """ + Set the value by which the vector head will be scaled. + """ + return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/scale_head").execute(*args, **kwargs) + def style(self, *args, **kwargs): + """ + Set the style with which the vectors will be drawn. + """ + return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/style").execute(*args, **kwargs) + def surfaces(self, *args, **kwargs): + """ + Set surfaces on which vectors are drawn. + """ + return PyMenu(self.service, "/results/graphics/expert/set/velocity_vectors/surfaces").execute(*args, **kwargs) - class advanced(metaclass=PyMenuMeta): - """ - Controls advanced options. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.amg_options = self.__class__.amg_options(path + [("amg_options", None)], service) - def correction_tolerance(self, *args, **kwargs): - """ - Enter the correction tolerance menu. - """ - return PyMenu(self.service, "/solution/controls/query/advanced/correction_tolerance").execute(*args, **kwargs) - def multi_grid_amg(self, *args, **kwargs): - """ - Get the parameters that govern the algebraic multigrid procedure. + class windows(TUIMenu): """ - return PyMenu(self.service, "/solution/controls/query/advanced/multi_grid_amg").execute(*args, **kwargs) - def multi_grid_controls(self, *args, **kwargs): - """ - Enter the multi-grid-controls menu. - """ - return PyMenu(self.service, "/solution/controls/query/advanced/multi_grid_controls").execute(*args, **kwargs) - def multi_grid_fas(self, *args, **kwargs): - """ - Get the coefficients that govern the FAS multigrid procedure. - """ - return PyMenu(self.service, "/solution/controls/query/advanced/multi_grid_fas").execute(*args, **kwargs) - def multi_stage(self, *args, **kwargs): - """ - Set the multiple-stage time stepping scheme coefficients. - """ - return PyMenu(self.service, "/solution/controls/query/advanced/multi_stage").execute(*args, **kwargs) - def relaxation_method(self, *args, **kwargs): - """ - Set the solver relaxation method. + Enter the window options menu. """ - return PyMenu(self.service, "/solution/controls/query/advanced/relaxation_method").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + self.axes = self.__class__.axes(path + [("axes", None)], service) + self.main = self.__class__.main(path + [("main", None)], service) + self.scale = self.__class__.scale(path + [("scale", None)], service) + self.text = self.__class__.text(path + [("text", None)], service) + self.video = self.__class__.video(path + [("video", None)], service) + self.xy = self.__class__.xy(path + [("xy", None)], service) + super().__init__(path, service) + def aspect_ratio(self, *args, **kwargs): + """ + Set the aspect ratio of the active window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/aspect_ratio").execute(*args, **kwargs) + def logo(self, *args, **kwargs): + """ + Enable/disable visibility of the logo in graphics window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/logo").execute(*args, **kwargs) + def ruler(self, *args, **kwargs): + """ + Enable/disable ruler visibility. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/ruler").execute(*args, **kwargs) + def logo_color(self, *args, **kwargs): + """ + Set logo color to white/black. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/logo_color").execute(*args, **kwargs) + + class axes(TUIMenu): + """ + Enter the axes window options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def border(self, *args, **kwargs): + """ + Enable/disable drawing of a border around the axes window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/axes/border").execute(*args, **kwargs) + def bottom(self, *args, **kwargs): + """ + Set the bottom boundary of the axes window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/axes/bottom").execute(*args, **kwargs) + def clear(self, *args, **kwargs): + """ + Set the transparency of the axes window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/axes/clear").execute(*args, **kwargs) + def right(self, *args, **kwargs): + """ + Set the right boundary of the axes window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/axes/right").execute(*args, **kwargs) + def visible(self, *args, **kwargs): + """ + Enable/disable axes visibility. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/axes/visible").execute(*args, **kwargs) - class amg_options(metaclass=PyMenuMeta): - """ - Enter AMG options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def laplace_coarsening(self, *args, **kwargs): + class main(TUIMenu): """ - Get AMG laplace coarsening options. + Enter the main view window options menu. """ - return PyMenu(self.service, "/solution/controls/query/advanced/amg_options/laplace_coarsening").execute(*args, **kwargs) - def conservative_amg_coarsening(self, *args, **kwargs): + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def border(self, *args, **kwargs): + """ + Enable/disable drawing of borders around the main viewing window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/main/border").execute(*args, **kwargs) + def bottom(self, *args, **kwargs): + """ + Set the bottom boundary of the main viewing window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/main/bottom").execute(*args, **kwargs) + def left(self, *args, **kwargs): + """ + Set the left boundary of the main viewing window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/main/left").execute(*args, **kwargs) + def right(self, *args, **kwargs): + """ + Set the right boundary of the main viewing window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/main/right").execute(*args, **kwargs) + def top(self, *args, **kwargs): + """ + Set the top boundary of the main viewing window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/main/top").execute(*args, **kwargs) + def visible(self, *args, **kwargs): + """ + Enable/disable visibility of the main viewing window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/main/visible").execute(*args, **kwargs) + + class scale(TUIMenu): """ - Use conservative AMG coarsening?. + Enter the color scale window options menu. """ - return PyMenu(self.service, "/solution/controls/query/advanced/amg_options/conservative_amg_coarsening").execute(*args, **kwargs) - def aggressive_amg_coarsening(self, *args, **kwargs): + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def border(self, *args, **kwargs): + """ + Enable/disable drawing of borders around the color scale window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/border").execute(*args, **kwargs) + def bottom(self, *args, **kwargs): + """ + Set the bottom boundary of the color scale window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/bottom").execute(*args, **kwargs) + def clear(self, *args, **kwargs): + """ + Set the transparency of the scale window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/clear").execute(*args, **kwargs) + def format(self, *args, **kwargs): + """ + Set the number format of the color scale window (e.g. %0.2e). + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/format").execute(*args, **kwargs) + def font_size(self, *args, **kwargs): + """ + Set the font size of the color scale window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/font_size").execute(*args, **kwargs) + def left(self, *args, **kwargs): + """ + Set the left boundary of the color scale window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/left").execute(*args, **kwargs) + def margin(self, *args, **kwargs): + """ + Set the margin of the color scale window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/margin").execute(*args, **kwargs) + def right(self, *args, **kwargs): + """ + Set the right boundary of the color scale window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/right").execute(*args, **kwargs) + def top(self, *args, **kwargs): + """ + Set the top boundary of the color scale window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/top").execute(*args, **kwargs) + def visible(self, *args, **kwargs): + """ + Enable/disable visibility of the color scale window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/visible").execute(*args, **kwargs) + def alignment(self, *args, **kwargs): + """ + Set colormap to bottom/left/top/right. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/scale/alignment").execute(*args, **kwargs) + + class text(TUIMenu): """ - Use aggressive AMG coarsening. + Enter the text window options menu. """ - return PyMenu(self.service, "/solution/controls/query/advanced/amg_options/aggressive_amg_coarsening").execute(*args, **kwargs) - def amg_gpgpu_options(self, *args, **kwargs): + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def application(self, *args, **kwargs): + """ + Enable/disable the application name in the picture. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/text/application").execute(*args, **kwargs) + def border(self, *args, **kwargs): + """ + Enable/disable drawing of borders around the text window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/text/border").execute(*args, **kwargs) + def bottom(self, *args, **kwargs): + """ + Set the bottom boundary of the text window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/text/bottom").execute(*args, **kwargs) + def clear(self, *args, **kwargs): + """ + Enable/disable text window transparency. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/text/clear").execute(*args, **kwargs) + def company(self, *args, **kwargs): + """ + Enable/disable the company name in the picture. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/text/company").execute(*args, **kwargs) + def date(self, *args, **kwargs): + """ + Enable/disable the date in the picture. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/text/date").execute(*args, **kwargs) + def left(self, *args, **kwargs): + """ + Set the left boundary of the text window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/text/left").execute(*args, **kwargs) + def right(self, *args, **kwargs): + """ + Set the right boundary of the text window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/text/right").execute(*args, **kwargs) + def top(self, *args, **kwargs): + """ + Set the top boundary of the text window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/text/top").execute(*args, **kwargs) + def visible(self, *args, **kwargs): + """ + Enable/disable text window transparency. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/text/visible").execute(*args, **kwargs) + + class video(TUIMenu): """ - Amg gpu options. + Enter the video window options menu. """ - return PyMenu(self.service, "/solution/controls/query/advanced/amg_options/amg_gpgpu_options").execute(*args, **kwargs) - - class expert(metaclass=PyMenuMeta): - """ - Enter expert options for solution. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.divergence_prevention = self.__class__.divergence_prevention(path + [("divergence_prevention", None)], service) - self.high_speed_numerics = self.__class__.high_speed_numerics(path + [("high_speed_numerics", None)], service) - self.poor_mesh_numerics = self.__class__.poor_mesh_numerics(path + [("poor_mesh_numerics", None)], service) - self.previous_defaults = self.__class__.previous_defaults(path + [("previous_defaults", None)], service) - self.non_reflecting_boundary_treatment = self.__class__.non_reflecting_boundary_treatment(path + [("non_reflecting_boundary_treatment", None)], service) - self.open_channel_wave_options = self.__class__.open_channel_wave_options(path + [("open_channel_wave_options", None)], service) - self.secondary_gradient_limiting = self.__class__.secondary_gradient_limiting(path + [("secondary_gradient_limiting", None)], service) - def alternate_wall_temp_formulation(self, *args, **kwargs): - """ - Alternate formulation for wall temperatures?. - """ - return PyMenu(self.service, "/solution/expert/alternate_wall_temp_formulation").execute(*args, **kwargs) - def bc_pressure_extrapolations(self, *args, **kwargs): - """ - Setting pressure extrapolations schemes on boundaries. - """ - return PyMenu(self.service, "/solution/expert/bc_pressure_extrapolations").execute(*args, **kwargs) - def bcd_boundedness(self, *args, **kwargs): - """ - BCD scheme boundedness strength, constant or expression (0 to 1). - """ - return PyMenu(self.service, "/solution/expert/bcd_boundedness").execute(*args, **kwargs) - def bcd_weights_freeze(self, *args, **kwargs): - """ - At each timestep, freeze BCD scheme weights after specified iteration - in order to improve timestep convergence. - """ - return PyMenu(self.service, "/solution/expert/bcd_weights_freeze").execute(*args, **kwargs) - def correction_form(self, *args, **kwargs): - """ - Discretize momentum equations in correction form for the pressure-based solver. - """ - return PyMenu(self.service, "/solution/expert/correction_form").execute(*args, **kwargs) - def disable_reconstruction(self, *args, **kwargs): - """ - Enable/Disable reconstruction. When disabled, accuracy will be first-order. - """ - return PyMenu(self.service, "/solution/expert/disable_reconstruction").execute(*args, **kwargs) - def energy_numerical_noise_filter(self, *args, **kwargs): - """ - The energy equation numerical noise filter can be enabled to eliminate non-physical numerical noise in the energy field. - The numerical noise can appear in solution fields where large variations in specific heat or combustion with phase change are present. - Using the energy equation numerical noise filter increases robustness, but may make the solution slightly more diffusive. - """ - return PyMenu(self.service, "/solution/expert/energy_numerical_noise_filter").execute(*args, **kwargs) - def explicit_under_relaxation_value(self, *args, **kwargs): - """ - Explicit under-relaxation value. - """ - return PyMenu(self.service, "/solution/expert/explicit_under_relaxation_value").execute(*args, **kwargs) - def equation_ordering(self, *args, **kwargs): - """ - Set the equation order. - """ - return PyMenu(self.service, "/solution/expert/equation_ordering").execute(*args, **kwargs) - def flow_warnings(self, *args, **kwargs): - """ - Control the display of warning diagnostics for boundaries with reversed flow, etc. - """ - return PyMenu(self.service, "/solution/expert/flow_warnings").execute(*args, **kwargs) - def limiter_warnings(self, *args, **kwargs): - """ - Control the display of limiter warning diagnostics. - """ - return PyMenu(self.service, "/solution/expert/limiter_warnings").execute(*args, **kwargs) - def linearized_mass_transfer_udf(self, *args, **kwargs): - """ - Use linearized mass transfer UDFs?. - """ - return PyMenu(self.service, "/solution/expert/linearized_mass_transfer_udf").execute(*args, **kwargs) - def lock_solid_temperature(self, *args, **kwargs): - """ - Lock the temperature for all solid and shell cell zones in the domain. - """ - return PyMenu(self.service, "/solution/expert/lock_solid_temperature").execute(*args, **kwargs) - def material_property_warnings(self, *args, **kwargs): - """ - Control the display of material property warning diagnostics: - 0 - off (no messages) - 1 - messages per material - 2 - messages per material and per property. - """ - return PyMenu(self.service, "/solution/expert/material_property_warnings").execute(*args, **kwargs) - def mp_mfluid_aniso_drag(self, *args, **kwargs): - """ - Set anisotropic drag parameters for Eulerian multiphase. - """ - return PyMenu(self.service, "/solution/expert/mp_mfluid_aniso_drag").execute(*args, **kwargs) - def mp_reference_density(self, *args, **kwargs): - """ - Set reference density option for Eulerian multiphase. - """ - return PyMenu(self.service, "/solution/expert/mp_reference_density").execute(*args, **kwargs) - def numerical_beach_controls(self, *args, **kwargs): - """ - Set damping function in flow direction. - """ - return PyMenu(self.service, "/solution/expert/numerical_beach_controls").execute(*args, **kwargs) - def open_channel_controls(self, *args, **kwargs): - """ - - Set additional open channel controls. - """ - return PyMenu(self.service, "/solution/expert/open_channel_controls").execute(*args, **kwargs) - def retain_cell_residuals(self, *args, **kwargs): - """ - Retain cell residuals for postprocessing?. - """ - return PyMenu(self.service, "/solution/expert/retain_cell_residuals").execute(*args, **kwargs) - def retain_temporary_solver_mem(self, *args, **kwargs): - """ - Retain temporary solver memory?. - """ - return PyMenu(self.service, "/solution/expert/retain_temporary_solver_mem").execute(*args, **kwargs) - def set_all_species_together(self, *args, **kwargs): - """ - Set all species discretizations and URFs together. - """ - return PyMenu(self.service, "/solution/expert/set_all_species_together").execute(*args, **kwargs) - def show_all_discretization_schemes(self, *args, **kwargs): - """ - Allow selection of all applicable discretization schemes?. - """ - return PyMenu(self.service, "/solution/expert/show_all_discretization_schemes").execute(*args, **kwargs) - def singhal_et_al_cavitation_model(self, *args, **kwargs): - """ - Use Singhal-et-al cavitation model?. - """ - return PyMenu(self.service, "/solution/expert/singhal_et_al_cavitation_model").execute(*args, **kwargs) - def surface_tension(self, *args, **kwargs): - """ - Set surface-tension calculation options. - """ - return PyMenu(self.service, "/solution/expert/surface_tension").execute(*args, **kwargs) - def surface_tension_expert(self, *args, **kwargs): - """ - Set surface-tension expert options. - """ - return PyMenu(self.service, "/solution/expert/surface_tension_expert").execute(*args, **kwargs) - def vof_explicit_controls(self, *args, **kwargs): - """ - Set Explicit VOF controls. - """ - return PyMenu(self.service, "/solution/expert/vof_explicit_controls").execute(*args, **kwargs) - - class divergence_prevention(metaclass=PyMenuMeta): - """ - Enter the divergence prevention menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable(self, *args, **kwargs): - """ - Enable divergence prevention. - """ - return PyMenu(self.service, "/solution/expert/divergence_prevention/enable").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def background(self, *args, **kwargs): + """ + Set the background color in the video picture. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/video/background").execute(*args, **kwargs) + def color_filter(self, *args, **kwargs): + """ + Set the color filter options for the picture. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/video/color_filter").execute(*args, **kwargs) + def foreground(self, *args, **kwargs): + """ + Set the foreground color in the video picture. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/video/foreground").execute(*args, **kwargs) + def on(self, *args, **kwargs): + """ + Enable/disable video picture settings. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/video/on").execute(*args, **kwargs) + def pixel_size(self, *args, **kwargs): + """ + Set the window size in pixels. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/video/pixel_size").execute(*args, **kwargs) - class high_speed_numerics(metaclass=PyMenuMeta): - """ - Enter high-speed-numerics menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable(self, *args, **kwargs): - """ - Enable/disable high-speed-numerics. - """ - return PyMenu(self.service, "/solution/expert/high_speed_numerics/enable").execute(*args, **kwargs) - def expert(self, *args, **kwargs): - """ - Expert high-speed-numerics. - """ - return PyMenu(self.service, "/solution/expert/high_speed_numerics/expert").execute(*args, **kwargs) - def visualize_pressure_discontinuity_sensor(self, *args, **kwargs): - """ - Enable/disable pressure-discontinuity-sensor visualization. - """ - return PyMenu(self.service, "/solution/expert/high_speed_numerics/visualize_pressure_discontinuity_sensor").execute(*args, **kwargs) + class xy(TUIMenu): + """ + Enter the X-Y plot window options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def border(self, *args, **kwargs): + """ + Enable/disable drawing of a border around the X-Y plotter window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/xy/border").execute(*args, **kwargs) + def bottom(self, *args, **kwargs): + """ + Set the bottom boundary of the X-Y plotter window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/xy/bottom").execute(*args, **kwargs) + def left(self, *args, **kwargs): + """ + Set the left boundary of the X-Y plotter window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/xy/left").execute(*args, **kwargs) + def right(self, *args, **kwargs): + """ + Set the right boundary of the X-Y plotter window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/xy/right").execute(*args, **kwargs) + def top(self, *args, **kwargs): + """ + Set the top boundary of the X-Y plotter window. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/xy/top").execute(*args, **kwargs) + def visible(self, *args, **kwargs): + """ + Enable/disable X-Y plotter window visibility. + """ + return PyMenu(self.service, "/results/graphics/expert/set/windows/xy/visible").execute(*args, **kwargs) - class poor_mesh_numerics(metaclass=PyMenuMeta): + class lights(TUIMenu): """ - Enter Poor Mesh Numerics Menu. + Enter the lights menu. """ def __init__(self, path, service): self.path = path self.service = service - self.solution_based_pmn = self.__class__.solution_based_pmn(path + [("solution_based_pmn", None)], service) - def enable(self, *args, **kwargs): - """ - Solution correction on meshes of poor quality. - """ - return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/enable").execute(*args, **kwargs) - def cell_quality_based(self, *args, **kwargs): - """ - Enable/disable poor mesh numerics on cells with low quality. - """ - return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/cell_quality_based").execute(*args, **kwargs) - def set_quality_threshold(self, *args, **kwargs): - """ - Set quality threshold. - """ - return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/set_quality_threshold").execute(*args, **kwargs) - def solution_and_quality_based(self, *args, **kwargs): - """ - Enable/disable poor mesh numerics based on solution and cell quality. - """ - return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/solution_and_quality_based").execute(*args, **kwargs) - def gradient_quality_based(self, *args, **kwargs): - """ - Enable/disable poor mesh numerics based on cell gradient quality. - """ - return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/gradient_quality_based").execute(*args, **kwargs) - def orthogonality_enhancing_cell_centroids(self, *args, **kwargs): - """ - Relocate select cell centroids, to improve orthogonality metrics and solution stability. - """ - return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/orthogonality_enhancing_cell_centroids").execute(*args, **kwargs) - def user_defined_on_register(self, *args, **kwargs): + self.lighting_interpolation = self.__class__.lighting_interpolation(path + [("lighting_interpolation", None)], service) + super().__init__(path, service) + def lights_on(self, *args, **kwargs): """ - Include cells in register in poor mesh numerics. + Turn all active lighting on/off. """ - return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/user_defined_on_register").execute(*args, **kwargs) - def reset_poor_elements(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/lights/lights_on").execute(*args, **kwargs) + def set_ambient_color(self, *args, **kwargs): """ - Reset marking of poor cell elements. + Set the ambient light color for the scene. """ - return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/reset_poor_elements").execute(*args, **kwargs) - def print_poor_elements_count(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/lights/set_ambient_color").execute(*args, **kwargs) + def set_light(self, *args, **kwargs): """ - Print poor cells count. + Add or modify a directional, colored light. """ - return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/print_poor_elements_count").execute(*args, **kwargs) - def enhanced_pmn(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/lights/set_light").execute(*args, **kwargs) + def headlight_on(self, *args, **kwargs): """ - This option is available with the density-based solver. When enabled, it will apply quality-based poor-mesh-numerics order=1 on any cells with a quality-measure below 0.2. In addition, their CFL number is limited to 1.0. + Turn the light that moves with the camera on or off. """ - return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/enhanced_pmn").execute(*args, **kwargs) + return PyMenu(self.service, "/results/graphics/lights/headlight_on").execute(*args, **kwargs) - class solution_based_pmn(metaclass=PyMenuMeta): + class lighting_interpolation(TUIMenu): """ - Solution based poor-mesh numerics menu. + Set lighting interpolation method. """ def __init__(self, path, service): self.path = path self.service = service - def enable(self, *args, **kwargs): - """ - Enable solution based treatment. - """ - return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/solution_based_pmn/enable").execute(*args, **kwargs) - def mark_primary_solution_limits(self, *args, **kwargs): + super().__init__(path, service) + def automatic(self, *args, **kwargs): """ - Mark cells violating solution limits. + Choose Automatic to automatically select the best lighting method for a given graphics object. """ - return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/solution_based_pmn/mark_primary_solution_limits").execute(*args, **kwargs) - def mark_velocity_limit(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/lights/lighting_interpolation/automatic").execute(*args, **kwargs) + def flat(self, *args, **kwargs): """ - Mark cells exceeding velocity limit. + Use flat shading for meshes and polygons. """ - return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/solution_based_pmn/mark_velocity_limit").execute(*args, **kwargs) - def mark_cfl_limit(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/lights/lighting_interpolation/flat").execute(*args, **kwargs) + def gouraud(self, *args, **kwargs): """ - Mark cells exceeding cfl limit. + Use Gouraud shading to calculate the color at each vertex of a polygon and interpolate it in the interior. """ - return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/solution_based_pmn/mark_cfl_limit").execute(*args, **kwargs) - def mark_cfl_jump(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/lights/lighting_interpolation/gouraud").execute(*args, **kwargs) + def phong(self, *args, **kwargs): """ - Mark cells exceeding cfl jump in neighborhood. + Use Phong shading to interpolate the normals for each pixel of a polygon and compute a color at every pixel. """ - return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/solution_based_pmn/mark_cfl_jump").execute(*args, **kwargs) + return PyMenu(self.service, "/results/graphics/lights/lighting_interpolation/phong").execute(*args, **kwargs) - class previous_defaults(metaclass=PyMenuMeta): + class objects(TUIMenu): """ - Enter previous defaults menu. + Enter to add, edit, delete or display graphics objects. """ def __init__(self, path, service): self.path = path self.service = service - def undo_r19_point_0_default_changes(self, *args, **kwargs): + super().__init__(path, service) + def create(self, *args, **kwargs): """ - Undo default changes introduced in R19.0. + Create new graphics object. """ - return PyMenu(self.service, "/solution/expert/previous_defaults/undo_r19_point_0_default_changes").execute(*args, **kwargs) - def undo_2019r1_default_changes(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/objects/create").execute(*args, **kwargs) + def edit(self, *args, **kwargs): """ - Undo default changes introduced in 2019R1. + Edit graphics object. """ - return PyMenu(self.service, "/solution/expert/previous_defaults/undo_2019r1_default_changes").execute(*args, **kwargs) - def undo_2019r3_default_changes(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/objects/edit").execute(*args, **kwargs) + def copy(self, *args, **kwargs): """ - Undo default changes introduced in 2019R3. + Copy graphics object. """ - return PyMenu(self.service, "/solution/expert/previous_defaults/undo_2019r3_default_changes").execute(*args, **kwargs) - def undo_2021r1_default_changes(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/objects/copy").execute(*args, **kwargs) + def delete(self, *args, **kwargs): """ - Undo default changes introduced in 2021R1. + Delete graphics object. """ - return PyMenu(self.service, "/solution/expert/previous_defaults/undo_2021r1_default_changes").execute(*args, **kwargs) - def undo_2021r2_default_changes(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/objects/delete").execute(*args, **kwargs) + def display(self, *args, **kwargs): """ - Undo default changes introduced in 2021R2. + Display graphics object. """ - return PyMenu(self.service, "/solution/expert/previous_defaults/undo_2021r2_default_changes").execute(*args, **kwargs) - def undo_2022r1_default_changes(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/objects/display").execute(*args, **kwargs) + def add_to_graphics(self, *args, **kwargs): """ - Undo default changes introduced in 2022R1. + Add graphics object to existing graphics. """ - return PyMenu(self.service, "/solution/expert/previous_defaults/undo_2022r1_default_changes").execute(*args, **kwargs) + return PyMenu(self.service, "/results/graphics/objects/add_to_graphics").execute(*args, **kwargs) - class non_reflecting_boundary_treatment(metaclass=PyMenuMeta): + class rendering_options(TUIMenu): """ - Enter non reflecting boundary treatment using minimal pressure reflection approach menu. + Enter the rendering options menu. """ def __init__(self, path, service): self.path = path self.service = service - def pressure_inlet(self, *args, **kwargs): + super().__init__(path, service) + def auto_spin(self, *args, **kwargs): """ - Enabling the use of minimal pressure reflection treatment. This treatment will minimize pressure wave reflections from the boundaries on which this option is active, but not necessarily fully eliminating them. The reflections would be of an acceptable limit in order to not contaminate the solution, the simulation will gain from the robustness of the new algorithm compared to traditional non-reflecting boundary condition treatment. + Enable/disable mouse view rotations to continue to spin the display after the button is released. """ - return PyMenu(self.service, "/solution/expert/non_reflecting_boundary_treatment/pressure_inlet").execute(*args, **kwargs) - def pressure_outlet(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/rendering_options/auto_spin").execute(*args, **kwargs) + def device_info(self, *args, **kwargs): """ - Enabling the use of minimal pressure reflection treatment. This treatment will minimize pressure wave reflections from the boundaries on which this option is active, but not necessarily fully eliminating them. The reflections would be of an acceptable limit in order to not contaminate the solution, the simulation will gain from the robustness of the new algorithm compared to traditional non-reflecting boundary condition treatment. + List information for the graphics device. """ - return PyMenu(self.service, "/solution/expert/non_reflecting_boundary_treatment/pressure_outlet").execute(*args, **kwargs) - def velocity_inlet(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/rendering_options/device_info").execute(*args, **kwargs) + def double_buffering(self, *args, **kwargs): """ - Enabling the use of minimal pressure reflection treatment. This treatment will minimize pressure wave reflections from the boundaries on which this option is active, but not necessarily fully eliminating them. The reflections would be of an acceptable limit in order to not contaminate the solution, the simulation will gain from the robustness of the new algorithm compared to traditional non-reflecting boundary condition treatment. + Enable/disable double-buffering. """ - return PyMenu(self.service, "/solution/expert/non_reflecting_boundary_treatment/velocity_inlet").execute(*args, **kwargs) - - class open_channel_wave_options(metaclass=PyMenuMeta): - """ - Enter the open-channel-wave-options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def set_verbosity(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/rendering_options/double_buffering").execute(*args, **kwargs) + def driver(self, *args, **kwargs): """ - Set open channel wave verbosity. + Change the current graphics driver. """ - return PyMenu(self.service, "/solution/expert/open_channel_wave_options/set_verbosity").execute(*args, **kwargs) - def stokes_wave_variants(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/rendering_options/driver").execute(*args, **kwargs) + def hidden_surfaces(self, *args, **kwargs): """ - Set stokes wave theory variants. + Enable/disable hidden surface removal. """ - return PyMenu(self.service, "/solution/expert/open_channel_wave_options/stokes_wave_variants").execute(*args, **kwargs) - def set_buffer_layer_ht(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/rendering_options/hidden_surfaces").execute(*args, **kwargs) + def hidden_surface_method(self, *args, **kwargs): """ - Set bufer layer height between phases for segregated velocity inputs. + Specify the method to perform hidden line and hidden surface rendering. """ - return PyMenu(self.service, "/solution/expert/open_channel_wave_options/set_buffer_layer_ht").execute(*args, **kwargs) + return PyMenu(self.service, "/results/graphics/rendering_options/hidden_surface_method").execute(*args, **kwargs) + def outer_face_cull(self, *args, **kwargs): + """ + Enable/disable discarding outer faces during display. + """ + return PyMenu(self.service, "/results/graphics/rendering_options/outer_face_cull").execute(*args, **kwargs) + def surface_edge_visibility(self, *args, **kwargs): + """ + Set edge visibility flags for surfaces. + """ + return PyMenu(self.service, "/results/graphics/rendering_options/surface_edge_visibility").execute(*args, **kwargs) + def animation_option(self, *args, **kwargs): + """ + Using Wireframe / All option during animation. + """ + return PyMenu(self.service, "/results/graphics/rendering_options/animation_option").execute(*args, **kwargs) + def color_map_alignment(self, *args, **kwargs): + """ + Set the color bar alignment. + """ + return PyMenu(self.service, "/results/graphics/rendering_options/color_map_alignment").execute(*args, **kwargs) + def help_text_color(self, *args, **kwargs): + """ + Set the color of screen help text. + """ + return PyMenu(self.service, "/results/graphics/rendering_options/help_text_color").execute(*args, **kwargs) + def face_displacement(self, *args, **kwargs): + """ + Set face displacement value in Z-buffer units along the Camera Z-axis. + """ + return PyMenu(self.service, "/results/graphics/rendering_options/face_displacement").execute(*args, **kwargs) + def set_rendering_options(self, *args, **kwargs): + """ + Set the rendering options. + """ + return PyMenu(self.service, "/results/graphics/rendering_options/set_rendering_options").execute(*args, **kwargs) + def show_colormap(self, *args, **kwargs): + """ + Enable/Disable colormap. + """ + return PyMenu(self.service, "/results/graphics/rendering_options/show_colormap").execute(*args, **kwargs) - class secondary_gradient_limiting(metaclass=PyMenuMeta): + class update_scene(TUIMenu): """ - Enter the Secondary Gradient Limiting Menu. + Enter the scene options menu. """ def __init__(self, path, service): self.path = path self.service = service - def energy(self, *args, **kwargs): + super().__init__(path, service) + def select_geometry(self, *args, **kwargs): """ - Enable/disable secondary gradient limiting at coupled walls for energy equation. + Select geometry to be updated. """ - return PyMenu(self.service, "/solution/expert/secondary_gradient_limiting/energy").execute(*args, **kwargs) - def uds(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/update_scene/select_geometry").execute(*args, **kwargs) + def overlays(self, *args, **kwargs): """ - Enable/disable secondary gradient limiting at coupled walls for user-defined scalars. + Enable/disable the overlays option. """ - return PyMenu(self.service, "/solution/expert/secondary_gradient_limiting/uds").execute(*args, **kwargs) - def mesh_quality_limits(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics/update_scene/overlays").execute(*args, **kwargs) + def draw_frame(self, *args, **kwargs): """ - Specify minimum and maximum mesh quality limits. + Enable/disable drawing of the bounding frame. """ - return PyMenu(self.service, "/solution/expert/secondary_gradient_limiting/mesh_quality_limits").execute(*args, **kwargs) + return PyMenu(self.service, "/results/graphics/update_scene/draw_frame").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Delete selected geometries. + """ + return PyMenu(self.service, "/results/graphics/update_scene/delete").execute(*args, **kwargs) + def display(self, *args, **kwargs): + """ + Display selected geometries. + """ + return PyMenu(self.service, "/results/graphics/update_scene/display").execute(*args, **kwargs) + def transform(self, *args, **kwargs): + """ + Apply transformation matrix on selected geometries. + """ + return PyMenu(self.service, "/results/graphics/update_scene/transform").execute(*args, **kwargs) + def pathline(self, *args, **kwargs): + """ + Change pathline attributes. + """ + return PyMenu(self.service, "/results/graphics/update_scene/pathline").execute(*args, **kwargs) + def iso_sweep(self, *args, **kwargs): + """ + Change iso-sweep values. + """ + return PyMenu(self.service, "/results/graphics/update_scene/iso_sweep").execute(*args, **kwargs) + def time(self, *args, **kwargs): + """ + Change time-step value. + """ + return PyMenu(self.service, "/results/graphics/update_scene/time").execute(*args, **kwargs) + def set_frame(self, *args, **kwargs): + """ + Change frame options. + """ + return PyMenu(self.service, "/results/graphics/update_scene/set_frame").execute(*args, **kwargs) - class initialize(metaclass=PyMenuMeta): + class plot(TUIMenu): """ - Enter the flow initialization menu. + Enter the XY plot menu. """ def __init__(self, path, service): self.path = path self.service = service - self.compute_defaults = self.__class__.compute_defaults(path + [("compute_defaults", None)], service) - self.mp_localized_turb_init = self.__class__.mp_localized_turb_init(path + [("mp_localized_turb_init", None)], service) - self.vof_patch_smooth_options = self.__class__.vof_patch_smooth_options(path + [("vof_patch_smooth_options", None)], service) - self.set_fmg_options = self.__class__.set_fmg_options(path + [("set_fmg_options", None)], service) - self.set_hyb_initialization = self.__class__.set_hyb_initialization(path + [("set_hyb_initialization", None)], service) - def open_channel_auto_init(self, *args, **kwargs): + self.ansys_sound_analysis = self.__class__.ansys_sound_analysis(path + [("ansys_sound_analysis", None)], service) + self.cumulative_plot = self.__class__.cumulative_plot(path + [("cumulative_plot", None)], service) + self.flamelet_curves = self.__class__.flamelet_curves(path + [("flamelet_curves", None)], service) + super().__init__(path, service) + def circum_avg_axial(self, *args, **kwargs): """ - Open channel automatic initialization. + Compute iso-axial band surfaces and plot data vs axial coordinate on them. """ - return PyMenu(self.service, "/solution/initialize/open_channel_auto_init").execute(*args, **kwargs) - def levelset_auto_init(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/circum_avg_axial").execute(*args, **kwargs) + def circum_avg_radial(self, *args, **kwargs): """ - Levelset function automatic initialization. + Compute iso-radial band surfaces and plot data vs radius on them. """ - return PyMenu(self.service, "/solution/initialize/levelset_auto_init").execute(*args, **kwargs) - def dpm_reset(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/circum_avg_radial").execute(*args, **kwargs) + def change_fft_ref_pressure(self, *args, **kwargs): """ - Reset discrete phase source terms to zero. + Change acoustic reference pressure. """ - return PyMenu(self.service, "/solution/initialize/dpm_reset").execute(*args, **kwargs) - def lwf_initialization(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/change_fft_ref_pressure").execute(*args, **kwargs) + def fft(self, *args, **kwargs): """ - Delete wall film particles and initialize wall film variables to zero. + Plot FFT of file data. """ - return PyMenu(self.service, "/solution/initialize/lwf_initialization").execute(*args, **kwargs) - def initialize_flow(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/fft").execute(*args, **kwargs) + def fft_set(self, *args, **kwargs): """ - Initialize the flow field with the current default values. + Enter the menu to set histogram plot parameters. """ - return PyMenu(self.service, "/solution/initialize/initialize_flow").execute(*args, **kwargs) - def init_acoustics_options(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/fft_set").execute(*args, **kwargs) + def file(self, *args, **kwargs): """ - Specify number of timesteps for ramping of sources - and initialize acoustics model variables. - During ramping the sound sources are multiplied by a factor smoothly growing from 0 to 1. + Plot data from file. """ - return PyMenu(self.service, "/solution/initialize/init_acoustics_options").execute(*args, **kwargs) - def hyb_initialization(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/file").execute(*args, **kwargs) + def datasources(self, *args, **kwargs): """ - Initialize using the hybrid initialization method. + Enter the menu to set data sources. """ - return PyMenu(self.service, "/solution/initialize/hyb_initialization").execute(*args, **kwargs) - def init_flow_statistics(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/datasources").execute(*args, **kwargs) + def display_profile_data(self, *args, **kwargs): """ - Initialize statistics. + Plot profile data. """ - return PyMenu(self.service, "/solution/initialize/init_flow_statistics").execute(*args, **kwargs) - def patch(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/display_profile_data").execute(*args, **kwargs) + def file_list(self, *args, **kwargs): """ - Patch a value for a flow variable in the domain. + Plot data from multiple files. """ - return PyMenu(self.service, "/solution/initialize/patch").execute(*args, **kwargs) - def show_time_sampled(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/file_list").execute(*args, **kwargs) + def file_set(self, *args, **kwargs): """ - Display the amount of simulated time covered by the data sampled for unsteady statistics. + Enter the menu to set file plot parameters. """ - return PyMenu(self.service, "/solution/initialize/show_time_sampled").execute(*args, **kwargs) - def show_iterations_sampled(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/file_set").execute(*args, **kwargs) + def histogram(self, *args, **kwargs): """ - Display the amount of simulated iterations covered by the data sampled for steady statistics. + Plot a histogram of a specified scalar quantity. """ - return PyMenu(self.service, "/solution/initialize/show_iterations_sampled").execute(*args, **kwargs) - def init_turb_vel_fluctuations(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/histogram").execute(*args, **kwargs) + def histogram_set(self, *args, **kwargs): """ - Initialize turbulent velocity fluctuations. + Enter the menu to set histogram plot parameters. """ - return PyMenu(self.service, "/solution/initialize/init_turb_vel_fluctuations").execute(*args, **kwargs) - def fmg_initialization(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/histogram_set").execute(*args, **kwargs) + def plot(self, *args, **kwargs): """ - Initialize using the full-multigrid initialization (FMG). + Plot solution on surfaces. """ - return PyMenu(self.service, "/solution/initialize/fmg_initialization").execute(*args, **kwargs) - def repair_wall_distance(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/plot").execute(*args, **kwargs) + def plot_direction(self, *args, **kwargs): """ - Correct wall distance at very high aspect ratio hexahedral/polyhedral cells. + Set plot direction for xy plot. """ - return PyMenu(self.service, "/solution/initialize/repair_wall_distance").execute(*args, **kwargs) - def set_defaults(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/plot_direction").execute(*args, **kwargs) + def residuals(self, *args, **kwargs): """ - Enter the set defaults menu. + Plot equation residual history. """ - return PyMenu(self.service, "/solution/initialize/set_defaults").execute(*args, **kwargs) - def set_fmg_initialization(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/residuals").execute(*args, **kwargs) + def residuals_set(self, *args, **kwargs): """ - Enter the set full-multigrid for initialization menu. + Enter the menu to set residual plot parameters. """ - return PyMenu(self.service, "/solution/initialize/set_fmg_initialization").execute(*args, **kwargs) - def list_defaults(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/residuals_set").execute(*args, **kwargs) + def solution(self, *args, **kwargs): """ - List default values. + Plot solution on surfaces and/or zones. """ - return PyMenu(self.service, "/solution/initialize/list_defaults").execute(*args, **kwargs) - def reference_frame(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/solution").execute(*args, **kwargs) + def solution_set(self, *args, **kwargs): """ - Set reference frame absolute or relative. + Enter the menu to set solution plot parameters. """ - return PyMenu(self.service, "/solution/initialize/reference_frame").execute(*args, **kwargs) + return PyMenu(self.service, "/results/plot/solution_set").execute(*args, **kwargs) + def set_boundary_val_off(self, *args, **kwargs): + """ + Set boundary value off when node values off for XY/Solution Plot. + + Note: This setting is valid for current Fluent session only. + """ + return PyMenu(self.service, "/results/plot/set_boundary_val_off").execute(*args, **kwargs) + def label_alignment(self, *args, **kwargs): + """ + Set the alignment of xy plot label to horizontal or axis aligned. + """ + return PyMenu(self.service, "/results/plot/label_alignment").execute(*args, **kwargs) - class compute_defaults(metaclass=PyMenuMeta): + class ansys_sound_analysis(TUIMenu): """ - Enter the compute defaults menu. + Ansys Sound analysis and specification. """ def __init__(self, path, service): self.path = path self.service = service - def axis(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/axis").execute(*args, **kwargs) - def degassing(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/degassing").execute(*args, **kwargs) - def dummy_entry(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/dummy_entry").execute(*args, **kwargs) - def all_zones(self, *args, **kwargs): - """ - Initialize the flow field with the default values. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/all_zones").execute(*args, **kwargs) - def exhaust_fan(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/exhaust_fan").execute(*args, **kwargs) - def fan(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/fan").execute(*args, **kwargs) - def fluid(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/fluid").execute(*args, **kwargs) - def geometry(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/geometry").execute(*args, **kwargs) - def inlet_vent(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/inlet_vent").execute(*args, **kwargs) - def intake_fan(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/intake_fan").execute(*args, **kwargs) - def interface(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/interface").execute(*args, **kwargs) - def interior(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/interior").execute(*args, **kwargs) - def mass_flow_inlet(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/mass_flow_inlet").execute(*args, **kwargs) - def mass_flow_outlet(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/mass_flow_outlet").execute(*args, **kwargs) - def network(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/network").execute(*args, **kwargs) - def network_end(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/network_end").execute(*args, **kwargs) - def outflow(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/outflow").execute(*args, **kwargs) - def outlet_vent(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/outlet_vent").execute(*args, **kwargs) - def overset(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/overset").execute(*args, **kwargs) - def periodic(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/periodic").execute(*args, **kwargs) - def porous_jump(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/porous_jump").execute(*args, **kwargs) - def pressure_far_field(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/pressure_far_field").execute(*args, **kwargs) - def pressure_inlet(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/pressure_inlet").execute(*args, **kwargs) - def pressure_outlet(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/pressure_outlet").execute(*args, **kwargs) - def radiator(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/radiator").execute(*args, **kwargs) - def rans_les_interface(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/rans_les_interface").execute(*args, **kwargs) - def recirculation_inlet(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/recirculation_inlet").execute(*args, **kwargs) - def recirculation_outlet(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/recirculation_outlet").execute(*args, **kwargs) - def shadow(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/shadow").execute(*args, **kwargs) - def solid(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/solid").execute(*args, **kwargs) - def symmetry(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/symmetry").execute(*args, **kwargs) - def velocity_inlet(self, *args, **kwargs): + super().__init__(path, service) + def write_files(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Write Ansys Sound out files. """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/velocity_inlet").execute(*args, **kwargs) - def wall(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/ansys_sound_analysis/write_files").execute(*args, **kwargs) + def print_indicators(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Print Ansys Sound indicators. """ - return PyMenu(self.service, "/solution/initialize/compute_defaults/wall").execute(*args, **kwargs) + return PyMenu(self.service, "/results/plot/ansys_sound_analysis/print_indicators").execute(*args, **kwargs) - class mp_localized_turb_init(metaclass=PyMenuMeta): + class cumulative_plot(TUIMenu): """ - Localized initialization of turbulent flow variables for VOF/Mixture multiphase flow models. + Plot Cumulative Force and Moments. """ def __init__(self, path, service): self.path = path self.service = service - def enable(self, *args, **kwargs): + super().__init__(path, service) + def add(self, *args, **kwargs): """ - Localized initialization of turbulent flow variables for VOF/Mixture multiphase flow models. + Add a new object. + """ + return PyMenu(self.service, "/results/plot/cumulative_plot/add").execute(*args, **kwargs) + def axes(self, *args, **kwargs): + """ + Set axes options of an object. + """ + return PyMenu(self.service, "/results/plot/cumulative_plot/axes").execute(*args, **kwargs) + def curves(self, *args, **kwargs): + """ + Set curves options of an object. + """ + return PyMenu(self.service, "/results/plot/cumulative_plot/curves").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edit an object. """ - return PyMenu(self.service, "/solution/initialize/mp_localized_turb_init/enable").execute(*args, **kwargs) - def turb_init_parameters(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/cumulative_plot/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): """ - Turbulent flow parameters for localized initialization. + Delete an object. """ - return PyMenu(self.service, "/solution/initialize/mp_localized_turb_init/turb_init_parameters").execute(*args, **kwargs) - - class vof_patch_smooth_options(metaclass=PyMenuMeta): - """ - Enter the vof patch/smooth options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def set_options(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/cumulative_plot/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): """ - Patch and smoothing options for volume fraction. + List objects. """ - return PyMenu(self.service, "/solution/initialize/vof_patch_smooth_options/set_options").execute(*args, **kwargs) - def execute_smoothing(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/cumulative_plot/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): """ - Execute volumetric smoothing for volume fraction. + List properties of an object. """ - return PyMenu(self.service, "/solution/initialize/vof_patch_smooth_options/execute_smoothing").execute(*args, **kwargs) - - class set_fmg_options(metaclass=PyMenuMeta): - """ - Enter the full-multigrid option menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def viscous_terms(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/cumulative_plot/list_properties").execute(*args, **kwargs) + def plot(self, *args, **kwargs): """ - Enable/disable viscous terms during FMG initialization. + Plot the Cumulative Forces/Moments. """ - return PyMenu(self.service, "/solution/initialize/set_fmg_options/viscous_terms").execute(*args, **kwargs) - def species_reactions(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/cumulative_plot/plot").execute(*args, **kwargs) + def print(self, *args, **kwargs): """ - Enable/disable species volumetric reactions during FMG initialization. + Print the Cumulative Forces/Moments. """ - return PyMenu(self.service, "/solution/initialize/set_fmg_options/species_reactions").execute(*args, **kwargs) - def set_turbulent_viscosity_ratio(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/cumulative_plot/print").execute(*args, **kwargs) + def write(self, *args, **kwargs): """ - Set turbulent viscosity ratio used during FMG initialization. + Write the Cumulative Forces/Moments. """ - return PyMenu(self.service, "/solution/initialize/set_fmg_options/set_turbulent_viscosity_ratio").execute(*args, **kwargs) + return PyMenu(self.service, "/results/plot/cumulative_plot/write").execute(*args, **kwargs) - class set_hyb_initialization(metaclass=PyMenuMeta): + class flamelet_curves(TUIMenu): """ - Enter the settings for hybrid initialization method. + Plot flamelet curves. """ def __init__(self, path, service): self.path = path self.service = service - def general_settings(self, *args, **kwargs): - """ - Enter the general settings menu. - """ - return PyMenu(self.service, "/solution/initialize/set_hyb_initialization/general_settings").execute(*args, **kwargs) - def turbulent_settings(self, *args, **kwargs): + super().__init__(path, service) + def write_to_file(self, *args, **kwargs): """ - Enter the turbulent settings menu. + Write curve to a file instead of plot. """ - return PyMenu(self.service, "/solution/initialize/set_hyb_initialization/turbulent_settings").execute(*args, **kwargs) - def species_settings(self, *args, **kwargs): + return PyMenu(self.service, "/results/plot/flamelet_curves/write_to_file").execute(*args, **kwargs) + def plot_curves(self, *args, **kwargs): """ - Enter the species settings menu. + Plot of a property. """ - return PyMenu(self.service, "/solution/initialize/set_hyb_initialization/species_settings").execute(*args, **kwargs) + return PyMenu(self.service, "/results/plot/flamelet_curves/plot_curves").execute(*args, **kwargs) - class methods(metaclass=PyMenuMeta): + class report(TUIMenu): """ - Enter the methods menu. + Enter the report menu. """ def __init__(self, path, service): self.path = path self.service = service - self.expert = self.__class__.expert(path + [("expert", None)], service) - self.high_order_term_relaxation = self.__class__.high_order_term_relaxation(path + [("high_order_term_relaxation", None)], service) - self.multiphase_numerics = self.__class__.multiphase_numerics(path + [("multiphase_numerics", None)], service) - self.nita_expert_controls = self.__class__.nita_expert_controls(path + [("nita_expert_controls", None)], service) - self.overset = self.__class__.overset(path + [("overset", None)], service) - self.pseudo_time_method = self.__class__.pseudo_time_method(path + [("pseudo_time_method", None)], service) - self.query = self.__class__.query(path + [("query", None)], service) - self.warped_face_gradient_correction = self.__class__.warped_face_gradient_correction(path + [("warped_face_gradient_correction", None)], service) - def accelerated_non_iterative_time_marching(self, *args, **kwargs): - """ - Enable/disable accelerated non-iterative time marching. - """ - return PyMenu(self.service, "/solution/methods/accelerated_non_iterative_time_marching").execute(*args, **kwargs) - def convergence_acceleration_for_stretched_meshes(self, *args, **kwargs): - """ - Enable convergence acceleration for stretched meshes to improve the convergence of the implicit density based solver on meshes with high cell stretching. - """ - return PyMenu(self.service, "/solution/methods/convergence_acceleration_for_stretched_meshes").execute(*args, **kwargs) - def discretization_scheme(self, *args, **kwargs): + self.dpm_histogram = self.__class__.dpm_histogram(path + [("dpm_histogram", None)], service) + self.fluxes = self.__class__.fluxes(path + [("fluxes", None)], service) + self.forces = self.__class__.forces(path + [("forces", None)], service) + self.reference_values = self.__class__.reference_values(path + [("reference_values", None)], service) + self.surface_integrals = self.__class__.surface_integrals(path + [("surface_integrals", None)], service) + self.volume_integrals = self.__class__.volume_integrals(path + [("volume_integrals", None)], service) + self.modified_setting = self.__class__.modified_setting(path + [("modified_setting", None)], service) + self.population_balance = self.__class__.population_balance(path + [("population_balance", None)], service) + self.heat_exchanger = self.__class__.heat_exchanger(path + [("heat_exchanger", None)], service) + self.system = self.__class__.system(path + [("system", None)], service) + self.simulation_reports = self.__class__.simulation_reports(path + [("simulation_reports", None)], service) + super().__init__(path, service) + def aero_optical_distortions(self, *args, **kwargs): """ - Enter the discretization-scheme menu. + Optics report menu. """ - return PyMenu(self.service, "/solution/methods/discretization_scheme").execute(*args, **kwargs) - def flux_type(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/aero_optical_distortions").execute(*args, **kwargs) + def dpm_summary(self, *args, **kwargs): """ - Enter the flux type. + Print discrete phase summary report of particle fates. """ - return PyMenu(self.service, "/solution/methods/flux_type").execute(*args, **kwargs) - def frozen_flux(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/dpm_summary").execute(*args, **kwargs) + def dpm_extended_summary(self, *args, **kwargs): """ - Enable/disable frozen flux formulation for transient flows. + Print extended discrete phase summary report of particle fates, with options. """ - return PyMenu(self.service, "/solution/methods/frozen_flux").execute(*args, **kwargs) - def gradient_scheme(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/dpm_extended_summary").execute(*args, **kwargs) + def dpm_zone_summaries_per_injection(self, *args, **kwargs): """ - Set gradient options. + Enable per-injection zone DPM summaries. """ - return PyMenu(self.service, "/solution/methods/gradient_scheme").execute(*args, **kwargs) - def nb_gradient_boundary_option(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/dpm_zone_summaries_per_injection").execute(*args, **kwargs) + def dpm_sample(self, *args, **kwargs): """ - Set ggnb options. + Sample trajectories at boundaries and lines/planes. """ - return PyMenu(self.service, "/solution/methods/nb_gradient_boundary_option").execute(*args, **kwargs) - def noniterative_time_advance(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/dpm_sample").execute(*args, **kwargs) + def dpm_sample_output_udf(self, *args, **kwargs): """ - Enable/disable the noniterative time advancement scheme. + Set the DPM sampling output UDF. """ - return PyMenu(self.service, "/solution/methods/noniterative_time_advance").execute(*args, **kwargs) - def p_v_coupling(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/dpm_sample_output_udf").execute(*args, **kwargs) + def dpm_sample_sort_file(self, *args, **kwargs): """ - Select the pressure velocity coupling scheme. + Enable writing of sorted DPM sample files. """ - return PyMenu(self.service, "/solution/methods/p_v_coupling").execute(*args, **kwargs) - def phase_based_vof_discretization(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/dpm_sample_sort_file").execute(*args, **kwargs) + def particle_summary(self, *args, **kwargs): """ - Set phase based slope limiter for VOF compressive scheme. + Print summary report for all current particles. """ - return PyMenu(self.service, "/solution/methods/phase_based_vof_discretization").execute(*args, **kwargs) - def reduced_rank_extrapolation(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/particle_summary").execute(*args, **kwargs) + def path_line_summary(self, *args, **kwargs): """ - Enable Reduced Rank Extrapolation method to accelerate solution time. + Print path-line-summary report. """ - return PyMenu(self.service, "/solution/methods/reduced_rank_extrapolation").execute(*args, **kwargs) - def reduced_rank_extrapolation_options(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/path_line_summary").execute(*args, **kwargs) + def print_histogram(self, *args, **kwargs): """ - Reduced Rank Extrapolation options. + Print a histogram of a scalar quantity. """ - return PyMenu(self.service, "/solution/methods/reduced_rank_extrapolation_options").execute(*args, **kwargs) - def residual_smoothing(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/print_histogram").execute(*args, **kwargs) + def write_histogram(self, *args, **kwargs): """ - Set residual smoothing factor and number of iterations. + Write a histogram of a scalar quantity to a file. """ - return PyMenu(self.service, "/solution/methods/residual_smoothing").execute(*args, **kwargs) - def set_solution_methods_to_default(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/write_histogram").execute(*args, **kwargs) + def projected_surface_area(self, *args, **kwargs): """ - Set solution methods to default values. + Print total area of the projection of a group of surfaces to a plane. """ - return PyMenu(self.service, "/solution/methods/set_solution_methods_to_default").execute(*args, **kwargs) - def unsteady_1st_order(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/projected_surface_area").execute(*args, **kwargs) + def species_mass_flow(self, *args, **kwargs): """ - Enable/disable first-order unsteady solution model. + Print list of species mass flow rates at boundaries. """ - return PyMenu(self.service, "/solution/methods/unsteady_1st_order").execute(*args, **kwargs) - def unsteady_2nd_order(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/species_mass_flow").execute(*args, **kwargs) + def element_mass_flow(self, *args, **kwargs): """ - Enable/disable the second-order unsteady solution model. + Print list of element mass flow rates at boundaries. """ - return PyMenu(self.service, "/solution/methods/unsteady_2nd_order").execute(*args, **kwargs) - def unsteady_2nd_order_bounded(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/element_mass_flow").execute(*args, **kwargs) + def summary(self, *args, **kwargs): """ - Enable/disable bounded second-order unsteady formulation. + Print report summary. """ - return PyMenu(self.service, "/solution/methods/unsteady_2nd_order_bounded").execute(*args, **kwargs) - def unsteady_global_time(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/summary").execute(*args, **kwargs) + def uds_flow(self, *args, **kwargs): """ - Enable/disable the unsteady global-time-step solution model. + Print list of UDS flow rate at boundaries. """ - return PyMenu(self.service, "/solution/methods/unsteady_global_time").execute(*args, **kwargs) - def vof_numerics(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/uds_flow").execute(*args, **kwargs) + def mphase_summary(self, *args, **kwargs): """ - Set VOF numeric options. + Multiphase Summary and Recommendations. """ - return PyMenu(self.service, "/solution/methods/vof_numerics").execute(*args, **kwargs) + return PyMenu(self.service, "/results/report/mphase_summary").execute(*args, **kwargs) - class expert(metaclass=PyMenuMeta): + class dpm_histogram(TUIMenu): """ - Enter expert menu. + Enter the DPM histogram menu. """ def __init__(self, path, service): self.path = path self.service = service - def reactions(self, *args, **kwargs): + self.set = self.__class__.set(path + [("set", None)], service) + self.setup_reduction = self.__class__.setup_reduction(path + [("setup_reduction", None)], service) + super().__init__(path, service) + def compute_sample(self, *args, **kwargs): """ - Enable/disable the species reaction sources and set relaxation factor. + Compute minimum/maximum of a sample variable. """ - return PyMenu(self.service, "/solution/methods/expert/reactions").execute(*args, **kwargs) - def numerics(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/dpm_histogram/compute_sample").execute(*args, **kwargs) + def delete_sample(self, *args, **kwargs): """ - Set numeric options. + Delete a sample from loaded sample list. """ - return PyMenu(self.service, "/solution/methods/expert/numerics").execute(*args, **kwargs) - - class high_order_term_relaxation(metaclass=PyMenuMeta): - """ - Enter High Order Relaxation Menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.options = self.__class__.options(path + [("options", None)], service) - def enable(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/dpm_histogram/delete_sample").execute(*args, **kwargs) + def list_samples(self, *args, **kwargs): """ - Enable/Disable High Order Term Relaxation. + Show all samples in loaded sample list. """ - return PyMenu(self.service, "/solution/methods/high_order_term_relaxation/enable").execute(*args, **kwargs) + return PyMenu(self.service, "/results/report/dpm_histogram/list_samples").execute(*args, **kwargs) + def plot_sample(self, *args, **kwargs): + """ + Plot a histogram of a loaded sample. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/plot_sample").execute(*args, **kwargs) + def read_sample(self, *args, **kwargs): + """ + Read a sample file and add it to the sample list. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/read_sample").execute(*args, **kwargs) + def write_sample(self, *args, **kwargs): + """ + Write a histogram of a loaded sample into a file. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/write_sample").execute(*args, **kwargs) + def pick_sample_to_reduce(self, *args, **kwargs): + """ + Pick a sample for which to first set-up and then perform the data reduction. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/pick_sample_to_reduce").execute(*args, **kwargs) + def reduce_picked_sample(self, *args, **kwargs): + """ + Reduce a sample after first picking it and setting up all data-reduction options and parameters. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/reduce_picked_sample").execute(*args, **kwargs) - class options(metaclass=PyMenuMeta): + class set(TUIMenu): """ - High Order Term Relaxation Options. + Enter the settings menu for the histogram. """ def __init__(self, path, service): self.path = path self.service = service - self.variables = self.__class__.variables(path + [("variables", None)], service) - def relaxation_factor(self, *args, **kwargs): + super().__init__(path, service) + def auto_range(self, *args, **kwargs): """ - Sets relaxation factor. + Automatically compute range of sampling variable for histogram plots. """ - return PyMenu(self.service, "/solution/methods/high_order_term_relaxation/options/relaxation_factor").execute(*args, **kwargs) - def expert(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/dpm_histogram/set/auto_range").execute(*args, **kwargs) + def correlation(self, *args, **kwargs): """ - Enter high order relaxation option with respect to diffusion gradient. + Compute correlation of sampling variable with other variable. """ - return PyMenu(self.service, "/solution/methods/high_order_term_relaxation/options/expert").execute(*args, **kwargs) + return PyMenu(self.service, "/results/report/dpm_histogram/set/correlation").execute(*args, **kwargs) + def cumulation_curve(self, *args, **kwargs): + """ + Compute a cumulative curve for sampling variable or correlation variable when correlation? was specified. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/set/cumulation_curve").execute(*args, **kwargs) + def diameter_statistics(self, *args, **kwargs): + """ + Compute Rosin Rammler parameters, Sauter and other mean diameters. + Requires specification of diameter as sampling variable. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/set/diameter_statistics").execute(*args, **kwargs) + def histogram_mode(self, *args, **kwargs): + """ + Use bars for histogram plot or xy-style. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/set/histogram_mode").execute(*args, **kwargs) + def minimum(self, *args, **kwargs): + """ + Specify mimimum value of x-axis variable for histogram plots. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/set/minimum").execute(*args, **kwargs) + def maximum(self, *args, **kwargs): + """ + Specify maximum value of x-axis variable for histogram plots. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/set/maximum").execute(*args, **kwargs) + def number_of_bins(self, *args, **kwargs): + """ + Specify the number of bins. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/set/number_of_bins").execute(*args, **kwargs) + def percentage(self, *args, **kwargs): + """ + Use percentages of bins to be computed. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/set/percentage").execute(*args, **kwargs) + def variable_power_3(self, *args, **kwargs): + """ + Use the cubic of the cumulation variable during computation of the cumulative curve. + When the particle mass was not sampled, the diameter can be used instead. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/set/variable_power_3").execute(*args, **kwargs) + def logarithmic(self, *args, **kwargs): + """ + Use logarithmic scaling on the abscissa (variable axis)? -- Will not work unless all values are positive. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/set/logarithmic").execute(*args, **kwargs) + def weighting(self, *args, **kwargs): + """ + Use weighting with additional variable when sorting data into samples. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/set/weighting").execute(*args, **kwargs) - class variables(metaclass=PyMenuMeta): + class setup_reduction(TUIMenu): + """ + Set up the sample data reduction by specifying all relevant options and setting parameters as desired. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def use_weighting(self, *args, **kwargs): """ - Select Variables. + Specify whether to use any weighting in the averaging that is done in each bin in the data reduction. """ - def __init__(self, path, service): - self.path = path - self.service = service - def select(self, *args, **kwargs): - """ - Select variables for high order term relaxation. - """ - return PyMenu(self.service, "/solution/methods/high_order_term_relaxation/options/variables/select").execute(*args, **kwargs) + return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/use_weighting").execute(*args, **kwargs) + def weighting_variable(self, *args, **kwargs): + """ + Choose the weighting variable for the averaging in each bin in the data reduction. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/weighting_variable").execute(*args, **kwargs) + def make_steady_from_unsteady_file(self, *args, **kwargs): + """ + Specify whether the unsteady sample is to be reduced into a steady-state injection file. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/make_steady_from_unsteady_file").execute(*args, **kwargs) + def reset_min_and_max(self, *args, **kwargs): + """ + Reset the min and max values of the range to be considered for a specific variable in the data reduction. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/reset_min_and_max").execute(*args, **kwargs) + def minimum(self, *args, **kwargs): + """ + Set the minimum value of the range to be considered for a specific variable in the data reduction. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/minimum").execute(*args, **kwargs) + def maximum(self, *args, **kwargs): + """ + Set the maximum value of the range to be considered for a specific variable in the data reduction. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/maximum").execute(*args, **kwargs) + def logarithmic(self, *args, **kwargs): + """ + Switch on or off logarithmic scaling to be used for a specific variable in the data reduction. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/logarithmic").execute(*args, **kwargs) + def number_of_bins(self, *args, **kwargs): + """ + Set the number of bins to be used for a specific variable in the data reduction. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/number_of_bins").execute(*args, **kwargs) + def all_variables_number_of_bins(self, *args, **kwargs): + """ + Set the number of bins to be used for ALL variables in the data reduction. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/all_variables_number_of_bins").execute(*args, **kwargs) + def list_settings(self, *args, **kwargs): + """ + List all user inputs for the sample picked for data reduction. + """ + return PyMenu(self.service, "/results/report/dpm_histogram/setup_reduction/list_settings").execute(*args, **kwargs) - class multiphase_numerics(metaclass=PyMenuMeta): + class fluxes(TUIMenu): """ - Enter the multiphase numerics options menu. + Flux report menu. """ def __init__(self, path, service): self.path = path self.service = service - self.porous_media = self.__class__.porous_media(path + [("porous_media", None)], service) - self.compressible_flow = self.__class__.compressible_flow(path + [("compressible_flow", None)], service) - self.boiling_parameters = self.__class__.boiling_parameters(path + [("boiling_parameters", None)], service) - self.viscous_flow = self.__class__.viscous_flow(path + [("viscous_flow", None)], service) - self.heat_mass_transfer = self.__class__.heat_mass_transfer(path + [("heat_mass_transfer", None)], service) - self.advanced_stability_controls = self.__class__.advanced_stability_controls(path + [("advanced_stability_controls", None)], service) - self.default_controls = self.__class__.default_controls(path + [("default_controls", None)], service) - self.face_pressure_controls = self.__class__.face_pressure_controls(path + [("face_pressure_controls", None)], service) - self.solution_stabilization = self.__class__.solution_stabilization(path + [("solution_stabilization", None)], service) + super().__init__(path, service) + def mass_flow(self, *args, **kwargs): + """ + Print mass flow rate at inlets and outlets. + """ + return PyMenu(self.service, "/results/report/fluxes/mass_flow").execute(*args, **kwargs) + def heat_transfer(self, *args, **kwargs): + """ + Print heat transfer rate at boundaries. + """ + return PyMenu(self.service, "/results/report/fluxes/heat_transfer").execute(*args, **kwargs) + def heat_transfer_sensible(self, *args, **kwargs): + """ + Print sensible heat transfer rate at boundaries. + """ + return PyMenu(self.service, "/results/report/fluxes/heat_transfer_sensible").execute(*args, **kwargs) + def rad_heat_trans(self, *args, **kwargs): + """ + Print radiation heat transfer rate at boundaries. + """ + return PyMenu(self.service, "/results/report/fluxes/rad_heat_trans").execute(*args, **kwargs) + def film_mass_flow(self, *args, **kwargs): + """ + Print film mass flow rate at boundaries. + """ + return PyMenu(self.service, "/results/report/fluxes/film_mass_flow").execute(*args, **kwargs) + def film_heat_transfer(self, *args, **kwargs): + """ + Print film heat transfer rate at boundaries. + """ + return PyMenu(self.service, "/results/report/fluxes/film_heat_transfer").execute(*args, **kwargs) + def pressure_work(self, *args, **kwargs): + """ + Print pressure work rate at moving boundaries. + """ + return PyMenu(self.service, "/results/report/fluxes/pressure_work").execute(*args, **kwargs) + def viscous_work(self, *args, **kwargs): + """ + Print viscous work rate at boundaries. + """ + return PyMenu(self.service, "/results/report/fluxes/viscous_work").execute(*args, **kwargs) + + class forces(TUIMenu): + """ + Force report menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def wall_forces(self, *args, **kwargs): + """ + Print integrated pressure and viscous forces on wall zones. + """ + return PyMenu(self.service, "/results/report/forces/wall_forces").execute(*args, **kwargs) + def wall_moments(self, *args, **kwargs): + """ + Print integrated pressure and viscous moments on wall zones. + """ + return PyMenu(self.service, "/results/report/forces/wall_moments").execute(*args, **kwargs) + def pressure_center(self, *args, **kwargs): + """ + Print center of pressure on wall zones. + """ + return PyMenu(self.service, "/results/report/forces/pressure_center").execute(*args, **kwargs) - class porous_media(metaclass=PyMenuMeta): + class reference_values(TUIMenu): + """ + Reference value menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.compute = self.__class__.compute(path + [("compute", None)], service) + super().__init__(path, service) + def area(self, *args, **kwargs): + """ + Set reference area for normalization. + """ + return PyMenu(self.service, "/results/report/reference_values/area").execute(*args, **kwargs) + def depth(self, *args, **kwargs): + """ + Set reference depth for volume calculation. + """ + return PyMenu(self.service, "/results/report/reference_values/depth").execute(*args, **kwargs) + def density(self, *args, **kwargs): + """ + Set reference density for normalization. + """ + return PyMenu(self.service, "/results/report/reference_values/density").execute(*args, **kwargs) + def enthalpy(self, *args, **kwargs): + """ + Set reference enthalpy for enthalpy damping and normalization. + """ + return PyMenu(self.service, "/results/report/reference_values/enthalpy").execute(*args, **kwargs) + def length(self, *args, **kwargs): + """ + Set reference length for normalization. + """ + return PyMenu(self.service, "/results/report/reference_values/length").execute(*args, **kwargs) + def pressure(self, *args, **kwargs): + """ + Set reference pressure for normalization. + """ + return PyMenu(self.service, "/results/report/reference_values/pressure").execute(*args, **kwargs) + def temperature(self, *args, **kwargs): + """ + Set reference temperature for normalization. + """ + return PyMenu(self.service, "/results/report/reference_values/temperature").execute(*args, **kwargs) + def yplus(self, *args, **kwargs): + """ + Set reference yplus for normalization. + """ + return PyMenu(self.service, "/results/report/reference_values/yplus").execute(*args, **kwargs) + def velocity(self, *args, **kwargs): + """ + Set reference velocity for normalization. """ - Multiphase relative permeability numerics menu. + return PyMenu(self.service, "/results/report/reference_values/velocity").execute(*args, **kwargs) + def viscosity(self, *args, **kwargs): """ - def __init__(self, path, service): - self.path = path - self.service = service - def relative_permeability(self, *args, **kwargs): - """ - Multiphase relative permeability fix option. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/porous_media/relative_permeability").execute(*args, **kwargs) + Set reference viscosity for normalization. + """ + return PyMenu(self.service, "/results/report/reference_values/viscosity").execute(*args, **kwargs) + def zone(self, *args, **kwargs): + """ + Set reference zone. + """ + return PyMenu(self.service, "/results/report/reference_values/zone").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + List current reference values. + """ + return PyMenu(self.service, "/results/report/reference_values/list").execute(*args, **kwargs) - class compressible_flow(metaclass=PyMenuMeta): + class compute(TUIMenu): """ - Multiphase compressible numerics options menu. + Enter the compute menu. """ def __init__(self, path, service): self.path = path self.service = service - def enhanced_numerics(self, *args, **kwargs): + super().__init__(path, service) + def axis(self, *args, **kwargs): """ - Multiphase enhanced compressible flow numerics options. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/compressible_flow/enhanced_numerics").execute(*args, **kwargs) - def alternate_bc_formulation(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/reference_values/compute/axis").execute(*args, **kwargs) + def degassing(self, *args, **kwargs): """ - Multiphase compressible flow BC alternate method. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/compressible_flow/alternate_bc_formulation").execute(*args, **kwargs) - - class boiling_parameters(metaclass=PyMenuMeta): - """ - Multiphase boiling parameters menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def thin_film(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/reference_values/compute/degassing").execute(*args, **kwargs) + def dummy_entry(self, *args, **kwargs): """ - Multiphase boiling thin film effects. + . """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/boiling_parameters/thin_film").execute(*args, **kwargs) - def liquid_vof_factor(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/reference_values/compute/dummy_entry").execute(*args, **kwargs) + def exhaust_fan(self, *args, **kwargs): """ - Multiphase boiling liquid volume fraction effects. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/boiling_parameters/liquid_vof_factor").execute(*args, **kwargs) - - class viscous_flow(metaclass=PyMenuMeta): - """ - Multiphase viscous flow numerics options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def viscosity_averaging(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/reference_values/compute/exhaust_fan").execute(*args, **kwargs) + def fan(self, *args, **kwargs): """ - Multiphase options for viscosity averaging. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/viscous_flow/viscosity_averaging").execute(*args, **kwargs) - def turb_visc_based_damping(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/reference_values/compute/fan").execute(*args, **kwargs) + def fluid(self, *args, **kwargs): """ - Turbulence viscosity based damping controls. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/viscous_flow/turb_visc_based_damping").execute(*args, **kwargs) - def interfacial_artificial_viscosity(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/reference_values/compute/fluid").execute(*args, **kwargs) + def geometry(self, *args, **kwargs): """ - Interfacial artifical viscosity controls. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/viscous_flow/interfacial_artificial_viscosity").execute(*args, **kwargs) - - class heat_mass_transfer(metaclass=PyMenuMeta): - """ - Multiphase interphase heat and mass transfer numerics options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) - self.evaporation_condensation = self.__class__.evaporation_condensation(path + [("evaporation_condensation", None)], service) - self.boiling = self.__class__.boiling(path + [("boiling", None)], service) - self.area_density = self.__class__.area_density(path + [("area_density", None)], service) - def alternative_energy_treatment(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/reference_values/compute/geometry").execute(*args, **kwargs) + def inlet_vent(self, *args, **kwargs): """ - Alternative treatment of latent heat source due to mass transfer. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/alternative_energy_treatment").execute(*args, **kwargs) - - class cavitation(metaclass=PyMenuMeta): + return PyMenu(self.service, "/results/report/reference_values/compute/inlet_vent").execute(*args, **kwargs) + def intake_fan(self, *args, **kwargs): """ - Cavitation numerics options menu. + Compute reference values from a zone of this type. """ - def __init__(self, path, service): - self.path = path - self.service = service - def schnerr_evap_coeff(self, *args, **kwargs): - """ - Evaporation coefficient for Schnerr-Sauer model. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/cavitation/schnerr_evap_coeff").execute(*args, **kwargs) - def schnerr_cond_coeff(self, *args, **kwargs): - """ - Condensation coefficient for Schnerr-Sauer model. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/cavitation/schnerr_cond_coeff").execute(*args, **kwargs) - def max_vapor_pressure_ratio(self, *args, **kwargs): - """ - Maximum limit on vapor pressure after turbulence and thermal correction. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/cavitation/max_vapor_pressure_ratio").execute(*args, **kwargs) - def min_vapor_pressure(self, *args, **kwargs): - """ - Minimum vapor pressure limit for cavitation model. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/cavitation/min_vapor_pressure").execute(*args, **kwargs) - def display_clipped_pressure(self, *args, **kwargs): - """ - Clipped pressure is just used for the properties evaluation. Mass Transfer Rate uses unclipped pressure. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/cavitation/display_clipped_pressure").execute(*args, **kwargs) - def turbulent_diffusion(self, *args, **kwargs): - """ - Enable/disable turbulent diffusion treatment between phases participating in cavitation. - This treatment is generally recommended for better solution stability. - However, in case of numerical difficulties, it can be disabled. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/cavitation/turbulent_diffusion").execute(*args, **kwargs) - - class evaporation_condensation(metaclass=PyMenuMeta): + return PyMenu(self.service, "/results/report/reference_values/compute/intake_fan").execute(*args, **kwargs) + def interface(self, *args, **kwargs): """ - Evaporation-condensation advanced options menu. + Compute reference values from a zone of this type. """ - def __init__(self, path, service): - self.path = path - self.service = service - def vof_from_min_limit(self, *args, **kwargs): - """ - Minimum volume fraction below which mass transfer rate is set to zero. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/evaporation_condensation/vof_from_min_limit").execute(*args, **kwargs) - def vof_from_max_limit(self, *args, **kwargs): - """ - Maximum volume fraction above which mass transfer rate is set to zero. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/evaporation_condensation/vof_from_max_limit").execute(*args, **kwargs) - def vof_to_min_limit(self, *args, **kwargs): - """ - Minimum volume fraction below which mass transfer rate is set to zero. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/evaporation_condensation/vof_to_min_limit").execute(*args, **kwargs) - def vof_to_max_limit(self, *args, **kwargs): - """ - Maximum volume fraction above which mass transfer rate is set to zero. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/evaporation_condensation/vof_to_max_limit").execute(*args, **kwargs) - def ia_norm_min_limit(self, *args, **kwargs): - """ - Minimum normalized area density below which mass transfer rate is set to zero. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/evaporation_condensation/ia_norm_min_limit").execute(*args, **kwargs) - def max_rel_humidity(self, *args, **kwargs): - """ - Maximum value of relative humidity to limit condensation rate. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/evaporation_condensation/max_rel_humidity").execute(*args, **kwargs) - - class boiling(metaclass=PyMenuMeta): + return PyMenu(self.service, "/results/report/reference_values/compute/interface").execute(*args, **kwargs) + def interior(self, *args, **kwargs): """ - Boiling advanced options menu. + Compute reference values from a zone of this type. """ - def __init__(self, path, service): - self.path = path - self.service = service - def heat_flux_relaxation_factor(self, *args, **kwargs): - """ - Under-relaxation factor for boiling heat flux. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/boiling/heat_flux_relaxation_factor").execute(*args, **kwargs) - def show_expert_options(self, *args, **kwargs): - """ - Exposes expert options of min/max superheat along with wetting fraction controls. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/boiling/show_expert_options").execute(*args, **kwargs) - def two_resistance_boiling_framework(self, *args, **kwargs): - """ - Allow generalized two-resistance framework for boiling model. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/boiling/two_resistance_boiling_framework").execute(*args, **kwargs) - - class area_density(metaclass=PyMenuMeta): + return PyMenu(self.service, "/results/report/reference_values/compute/interior").execute(*args, **kwargs) + def mass_flow_inlet(self, *args, **kwargs): """ - Interfacial area density menu. + Compute reference values from a zone of this type. """ - def __init__(self, path, service): - self.path = path - self.service = service - def vof_min_seeding(self, *args, **kwargs): - """ - Minimum vof seeding for non-zero area density in heat and mass transfer. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/area_density/vof_min_seeding").execute(*args, **kwargs) - def ia_grad_sym(self, *args, **kwargs): - """ - Interfacial area density gradient-symmetric mechanism. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/area_density/ia_grad_sym").execute(*args, **kwargs) - - class advanced_stability_controls(metaclass=PyMenuMeta): - """ - Stability controls for multiphase flow. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.pseudo_time = self.__class__.pseudo_time(path + [("pseudo_time", None)], service) - self.p_v_coupling = self.__class__.p_v_coupling(path + [("p_v_coupling", None)], service) - self.hybrid_nita = self.__class__.hybrid_nita(path + [("hybrid_nita", None)], service) - self.equation_order = self.__class__.equation_order(path + [("equation_order", None)], service) - self.anti_diffusion = self.__class__.anti_diffusion(path + [("anti_diffusion", None)], service) - - class pseudo_time(metaclass=PyMenuMeta): + return PyMenu(self.service, "/results/report/reference_values/compute/mass_flow_inlet").execute(*args, **kwargs) + def mass_flow_outlet(self, *args, **kwargs): """ - Pseudo-Time stability controls for multiphase flow. + Compute reference values from a zone of this type. """ - def __init__(self, path, service): - self.path = path - self.service = service - self.auto_dt_advanced_controls = self.__class__.auto_dt_advanced_controls(path + [("auto_dt_advanced_controls", None)], service) - def smoothed_density_stabilization_method(self, *args, **kwargs): - """ - Set smoothed density stabilization method. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/pseudo_time/smoothed_density_stabilization_method").execute(*args, **kwargs) - def false_time_step_linearization(self, *args, **kwargs): - """ - Set false time-step linearization for added stability. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/pseudo_time/false_time_step_linearization").execute(*args, **kwargs) - - class auto_dt_advanced_controls(metaclass=PyMenuMeta): - """ - Set automatic time-stepping controls for better solution stability. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable(self, *args, **kwargs): - """ - Enable advanced automatic time stepping for better stability. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/enable").execute(*args, **kwargs) - def dt_init_limit(self, *args, **kwargs): - """ - Set maximum value for pseudo time step size during first iteration. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/dt_init_limit").execute(*args, **kwargs) - def dt_max(self, *args, **kwargs): - """ - Set maximum value for pseudo time step size. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/dt_max").execute(*args, **kwargs) - def dt_factor_min(self, *args, **kwargs): - """ - Set minimum limit for reduction in pseudo time step size. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/dt_factor_min").execute(*args, **kwargs) - def dt_factor_max(self, *args, **kwargs): - """ - Set maximum limit for increase in pseudo time step size. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/dt_factor_max").execute(*args, **kwargs) - def max_velocity_ratio(self, *args, **kwargs): - """ - Set velocity ratio to freeze the time step size for better solution stability. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/max_velocity_ratio").execute(*args, **kwargs) - - class p_v_coupling(metaclass=PyMenuMeta): + return PyMenu(self.service, "/results/report/reference_values/compute/mass_flow_outlet").execute(*args, **kwargs) + def network(self, *args, **kwargs): """ - Pressure velocity coupling controls for multiphase flow. + Compute reference values from a zone of this type. """ - def __init__(self, path, service): - self.path = path - self.service = service - self.coupled_vof = self.__class__.coupled_vof(path + [("coupled_vof", None)], service) - self.rhie_chow_flux = self.__class__.rhie_chow_flux(path + [("rhie_chow_flux", None)], service) - self.skewness_correction = self.__class__.skewness_correction(path + [("skewness_correction", None)], service) - - class coupled_vof(metaclass=PyMenuMeta): - """ - Set Coupled VOF stability controls. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def buoyancy_force_linearization(self, *args, **kwargs): - """ - Set buoynacy force linerization options in coupled vof. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/p_v_coupling/coupled_vof/buoyancy_force_linearization").execute(*args, **kwargs) - - class rhie_chow_flux(metaclass=PyMenuMeta): - """ - Set Rhie-Chow related stability controls. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def low_order_rhie_chow(self, *args, **kwargs): - """ - Use low order velocity interpolation in flux calculation. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/p_v_coupling/rhie_chow_flux/low_order_rhie_chow").execute(*args, **kwargs) - - class skewness_correction(metaclass=PyMenuMeta): - """ - Skewness correction related stabiity controls for multiphase flow. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def limit_pressure_correction_gradient(self, *args, **kwargs): - """ - Use limited pressure correction gradient in skewness corrections for better stability. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/p_v_coupling/skewness_correction/limit_pressure_correction_gradient").execute(*args, **kwargs) - - class hybrid_nita(metaclass=PyMenuMeta): + return PyMenu(self.service, "/results/report/reference_values/compute/network").execute(*args, **kwargs) + def network_end(self, *args, **kwargs): """ - Hybrid NITA stability controls for multiphase flow. + Compute reference values from a zone of this type. """ - def __init__(self, path, service): - self.path = path - self.service = service - self.instability_detector = self.__class__.instability_detector(path + [("instability_detector", None)], service) - def outer_iterations(self, *args, **kwargs): - """ - Set number of outer iterations in hybrid nita. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/hybrid_nita/outer_iterations").execute(*args, **kwargs) - def initial_outer_iterations(self, *args, **kwargs): - """ - Set hybrid nita start-up controls. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/hybrid_nita/initial_outer_iterations").execute(*args, **kwargs) - - class instability_detector(metaclass=PyMenuMeta): - """ - Set Hybrid NITA instability detector controls. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable_instability_detector(self, *args, **kwargs): - """ - Enable instability detector for better stability. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/enable_instability_detector").execute(*args, **kwargs) - def set_cfl_limit(self, *args, **kwargs): - """ - Set Courant Number limit for detection of unstable event. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/set_cfl_limit").execute(*args, **kwargs) - def set_cfl_type(self, *args, **kwargs): - """ - Set Courant Number type for detection of unstable event. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/set_cfl_type").execute(*args, **kwargs) - def set_velocity_limit(self, *args, **kwargs): - """ - Set velocity limit for detection of unstable event. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/set_velocity_limit").execute(*args, **kwargs) - def unstable_event_outer_iterations(self, *args, **kwargs): - """ - Set number of outer iterations for unstable event. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/unstable_event_outer_iterations").execute(*args, **kwargs) - - class equation_order(metaclass=PyMenuMeta): + return PyMenu(self.service, "/results/report/reference_values/compute/network_end").execute(*args, **kwargs) + def outflow(self, *args, **kwargs): """ - Equation Order Menu for Homogeneous Multiphase Flow Models. + Compute reference values from a zone of this type. """ - def __init__(self, path, service): - self.path = path - self.service = service - def solve_flow_last(self, *args, **kwargs): - """ - Solve flow equation at the end of iteration as an alternative. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/equation_order/solve_flow_last").execute(*args, **kwargs) - def solve_exp_vof_at_end(self, *args, **kwargs): - """ - Solve Explicit VOF at the end of time-step as an alternative. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/equation_order/solve_exp_vof_at_end").execute(*args, **kwargs) - - class anti_diffusion(metaclass=PyMenuMeta): + return PyMenu(self.service, "/results/report/reference_values/compute/outflow").execute(*args, **kwargs) + def outlet_vent(self, *args, **kwargs): """ - Anti Diffusion Menu for VOF/Multi-Fluid VOF Models. + Compute reference values from a zone of this type. """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable_dynamic_strength(self, *args, **kwargs): - """ - Enable dynamic strength to reduce compression in the tangential direction to the interface. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/anti_diffusion/enable_dynamic_strength").execute(*args, **kwargs) - def set_dynamic_strength_exponent(self, *args, **kwargs): - """ - Set cosine exponent in dynamic strength treatment. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/anti_diffusion/set_dynamic_strength_exponent").execute(*args, **kwargs) - def set_maximum_dynamic_strength(self, *args, **kwargs): - """ - Set maximum value of dynamic anti-diffusion strength. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/anti_diffusion/set_maximum_dynamic_strength").execute(*args, **kwargs) - - class default_controls(metaclass=PyMenuMeta): - """ - Multiphase default controls menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def recommended_defaults_for_existing_cases(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/reference_values/compute/outlet_vent").execute(*args, **kwargs) + def overset(self, *args, **kwargs): """ - Activate multiphase defaults for loaded case. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/default_controls/recommended_defaults_for_existing_cases").execute(*args, **kwargs) - def revert_to_pre_r20_point_1_default_settings(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/reference_values/compute/overset").execute(*args, **kwargs) + def periodic(self, *args, **kwargs): """ - Revert to pre-R20.1 multiphase flow default settings. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/default_controls/revert_to_pre_r20_point_1_default_settings").execute(*args, **kwargs) - - class face_pressure_controls(metaclass=PyMenuMeta): - """ - Enter the face pressure expert controls menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def face_pressure_options(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/reference_values/compute/periodic").execute(*args, **kwargs) + def porous_jump(self, *args, **kwargs): """ - Set face pressure options. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/face_pressure_controls/face_pressure_options").execute(*args, **kwargs) - - class solution_stabilization(metaclass=PyMenuMeta): - """ - VOF solution stabilization menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.additional_stabilization_controls = self.__class__.additional_stabilization_controls(path + [("additional_stabilization_controls", None)], service) - self.velocity_limiting_treatment = self.__class__.velocity_limiting_treatment(path + [("velocity_limiting_treatment", None)], service) - def execute_settings_optimization(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/reference_values/compute/porous_jump").execute(*args, **kwargs) + def pressure_far_field(self, *args, **kwargs): """ - Execute optimized settings for VOF. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/execute_settings_optimization").execute(*args, **kwargs) - def execute_advanced_stabilization(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/reference_values/compute/pressure_far_field").execute(*args, **kwargs) + def pressure_inlet(self, *args, **kwargs): """ - Execute advanced stabilization for VOF. + Compute reference values from a zone of this type. """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/execute_advanced_stabilization").execute(*args, **kwargs) - def execute_additional_stability_controls(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/reference_values/compute/pressure_inlet").execute(*args, **kwargs) + def pressure_outlet(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/results/report/reference_values/compute/pressure_outlet").execute(*args, **kwargs) + def radiator(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/results/report/reference_values/compute/radiator").execute(*args, **kwargs) + def rans_les_interface(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/results/report/reference_values/compute/rans_les_interface").execute(*args, **kwargs) + def recirculation_inlet(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/results/report/reference_values/compute/recirculation_inlet").execute(*args, **kwargs) + def recirculation_outlet(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/results/report/reference_values/compute/recirculation_outlet").execute(*args, **kwargs) + def shadow(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/results/report/reference_values/compute/shadow").execute(*args, **kwargs) + def solid(self, *args, **kwargs): + """ + Compute reference values from a zone of this type. """ - Execute additional stability controls for VOF. + return PyMenu(self.service, "/results/report/reference_values/compute/solid").execute(*args, **kwargs) + def symmetry(self, *args, **kwargs): """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/execute_additional_stability_controls").execute(*args, **kwargs) - - class additional_stabilization_controls(metaclass=PyMenuMeta): + Compute reference values from a zone of this type. """ - Additional advanced stability controls for VOF. + return PyMenu(self.service, "/results/report/reference_values/compute/symmetry").execute(*args, **kwargs) + def velocity_inlet(self, *args, **kwargs): """ - def __init__(self, path, service): - self.path = path - self.service = service - def blended_compressive_scheme(self, *args, **kwargs): - """ - Blended Compressive discretization scheme for VOF. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/additional_stabilization_controls/blended_compressive_scheme").execute(*args, **kwargs) - def pseudo_time_stabilization(self, *args, **kwargs): - """ - Pseudo-Time Momentum stabilization and False Time Step Linearization methods for VOF. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/additional_stabilization_controls/pseudo_time_stabilization").execute(*args, **kwargs) - - class velocity_limiting_treatment(metaclass=PyMenuMeta): + Compute reference values from a zone of this type. """ - Velocity limiting related stabiity controls for VOF. + return PyMenu(self.service, "/results/report/reference_values/compute/velocity_inlet").execute(*args, **kwargs) + def wall(self, *args, **kwargs): """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable_velocity_limiting(self, *args, **kwargs): - """ - Enable velocity limiting treatment. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/enable_velocity_limiting").execute(*args, **kwargs) - def set_velocity_and_vof_cutoffs(self, *args, **kwargs): - """ - Set phase based velocity limiting controls. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/set_velocity_and_vof_cutoffs").execute(*args, **kwargs) - def set_damping_strengths(self, *args, **kwargs): - """ - Set phase based damping strength. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/set_damping_strengths").execute(*args, **kwargs) - def set_velocity_cutoff(self, *args, **kwargs): - """ - Enter max velocity magnitude. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/set_velocity_cutoff").execute(*args, **kwargs) - def set_damping_strength(self, *args, **kwargs): - """ - Enter damping strength. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/set_damping_strength").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Enable verbosity to print number of velocity limited cells during iterations. - """ - return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/verbosity").execute(*args, **kwargs) + Compute reference values from a zone of this type. + """ + return PyMenu(self.service, "/results/report/reference_values/compute/wall").execute(*args, **kwargs) - class nita_expert_controls(metaclass=PyMenuMeta): + class surface_integrals(TUIMenu): """ - Enter the nita expert controls menu. + Surface Integral menu. """ def __init__(self, path, service): self.path = path self.service = service - def set_verbosity(self, *args, **kwargs): + super().__init__(path, service) + def area(self, *args, **kwargs): """ - Set nita verbosity option. + Print total area of surfaces. """ - return PyMenu(self.service, "/solution/methods/nita_expert_controls/set_verbosity").execute(*args, **kwargs) - def skewness_neighbor_coupling(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/surface_integrals/area").execute(*args, **kwargs) + def area_weighted_avg(self, *args, **kwargs): """ - Set skewness neighbor coupling for nita. + Print area-weighted average of scalar on surfaces. """ - return PyMenu(self.service, "/solution/methods/nita_expert_controls/skewness_neighbor_coupling").execute(*args, **kwargs) - def hybrid_nita_settings(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/surface_integrals/area_weighted_avg").execute(*args, **kwargs) + def facet_avg(self, *args, **kwargs): """ - Select a hybrid NITA settings option for faster performance and better robustness. + Print average of scalar at facet centroids of the surfaces. """ - return PyMenu(self.service, "/solution/methods/nita_expert_controls/hybrid_nita_settings").execute(*args, **kwargs) - - class overset(metaclass=PyMenuMeta): - """ - Enter overset solver options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.expert = self.__class__.expert(path + [("expert", None)], service) - def high_order_pressure(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/surface_integrals/facet_avg").execute(*args, **kwargs) + def facet_max(self, *args, **kwargs): """ - High order pressure extrapolation at overset interface. + Print maximum of scalar at facet centroids of the surfaces. """ - return PyMenu(self.service, "/solution/methods/overset/high_order_pressure").execute(*args, **kwargs) - def interpolation_method(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/surface_integrals/facet_max").execute(*args, **kwargs) + def facet_min(self, *args, **kwargs): """ - Choose the interpolation method for overset interface(s). + Print minimum of scalar at facet centroids of the surfaces. """ - return PyMenu(self.service, "/solution/methods/overset/interpolation_method").execute(*args, **kwargs) - def orphan_cell_treatment(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/surface_integrals/facet_min").execute(*args, **kwargs) + def flow_rate(self, *args, **kwargs): """ - Enable solver to run with orphans present. + Print flow rate of scalar through surfaces. """ - return PyMenu(self.service, "/solution/methods/overset/orphan_cell_treatment").execute(*args, **kwargs) - - class expert(metaclass=PyMenuMeta): + return PyMenu(self.service, "/results/report/surface_integrals/flow_rate").execute(*args, **kwargs) + def integral(self, *args, **kwargs): """ - Enter overset expert solver options menu. + Print integral of scalar over surfaces. """ - def __init__(self, path, service): - self.path = path - self.service = service - def mass_flux_correction_method(self, *args, **kwargs): - """ - Enter mass flux correction option at overset interfaces. - """ - return PyMenu(self.service, "/solution/methods/overset/expert/mass_flux_correction_method").execute(*args, **kwargs) - def hybrid_mode_selection(self, *args, **kwargs): - """ - Mode for hybrid interpolation. - """ - return PyMenu(self.service, "/solution/methods/overset/expert/hybrid_mode_selection").execute(*args, **kwargs) - - class pseudo_time_method(metaclass=PyMenuMeta): - """ - Enter the pseudo time method menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def formulation(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/surface_integrals/integral").execute(*args, **kwargs) + def mass_flow_rate(self, *args, **kwargs): """ - Select the pseudo time step size formulation for the pseudo time method. + Print mass flow rate through surfaces. """ - return PyMenu(self.service, "/solution/methods/pseudo_time_method/formulation").execute(*args, **kwargs) - def local_time_step_settings(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/surface_integrals/mass_flow_rate").execute(*args, **kwargs) + def mass_weighted_avg(self, *args, **kwargs): """ - Adjust the settings for the local time step formulation. + Print mass-average of scalar over surfaces. """ - return PyMenu(self.service, "/solution/methods/pseudo_time_method/local_time_step_settings").execute(*args, **kwargs) - def global_time_step_settings(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/surface_integrals/mass_weighted_avg").execute(*args, **kwargs) + def standard_deviation(self, *args, **kwargs): """ - Adjust the settings for the global time step formulation. + Print standard deviation of scalar. """ - return PyMenu(self.service, "/solution/methods/pseudo_time_method/global_time_step_settings").execute(*args, **kwargs) - def advanced_options(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/surface_integrals/standard_deviation").execute(*args, **kwargs) + def sum(self, *args, **kwargs): """ - Enter the advanced options menu to define pseudo time settings for equations. + Print sum of scalar at facet centroids of the surfaces. """ - return PyMenu(self.service, "/solution/methods/pseudo_time_method/advanced_options").execute(*args, **kwargs) - def relaxation_factors(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/surface_integrals/sum").execute(*args, **kwargs) + def uniformity_index_area_weighted(self, *args, **kwargs): """ - Enter the relaxation factors menu to set the pseudo time explicit relaxation factors for equations. + Print uniformity index of scalar over surfaces. """ - return PyMenu(self.service, "/solution/methods/pseudo_time_method/relaxation_factors").execute(*args, **kwargs) - def relaxation_method(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/surface_integrals/uniformity_index_area_weighted").execute(*args, **kwargs) + def uniformity_index_mass_weighted(self, *args, **kwargs): """ - Select relaxation definition for pseudo time method. + Print uniformity index of scalar over surfaces. """ - return PyMenu(self.service, "/solution/methods/pseudo_time_method/relaxation_method").execute(*args, **kwargs) - def relaxation_bounds(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/surface_integrals/uniformity_index_mass_weighted").execute(*args, **kwargs) + def vector_based_flux(self, *args, **kwargs): """ - Select relaxation bounding scheme for pseudo time method. + Print custom vector based flux. """ - return PyMenu(self.service, "/solution/methods/pseudo_time_method/relaxation_bounds").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/surface_integrals/vector_based_flux").execute(*args, **kwargs) + def vector_flux(self, *args, **kwargs): """ - Set the verbosity for the pseudo time method. + Print custom vector flux. """ - return PyMenu(self.service, "/solution/methods/pseudo_time_method/verbosity").execute(*args, **kwargs) - - class query(metaclass=PyMenuMeta): - """ - Enter methods query menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def discretization_scheme(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/surface_integrals/vector_flux").execute(*args, **kwargs) + def vector_weighted_average(self, *args, **kwargs): """ - Enter the discretization-scheme menu. + Print custom vector weighted average. """ - return PyMenu(self.service, "/solution/methods/query/discretization_scheme").execute(*args, **kwargs) - def p_v_coupling(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/surface_integrals/vector_weighted_average").execute(*args, **kwargs) + def vertex_avg(self, *args, **kwargs): """ - Get the pressure velocity coupling scheme. + Print average of scalar at vertices of the surfaces. """ - return PyMenu(self.service, "/solution/methods/query/p_v_coupling").execute(*args, **kwargs) - - class warped_face_gradient_correction(metaclass=PyMenuMeta): - """ - Enter warped-face-gradient-correction menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/surface_integrals/vertex_avg").execute(*args, **kwargs) + def vertex_max(self, *args, **kwargs): """ - Enable Warped-Face Gradient Correction. + Print maximkum of scalar at vertices of the surfaces. """ - return PyMenu(self.service, "/solution/methods/warped_face_gradient_correction/enable").execute(*args, **kwargs) - def turbulence_options(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/surface_integrals/vertex_max").execute(*args, **kwargs) + def vertex_min(self, *args, **kwargs): """ - Set turbulence Warped Face Gradient Correction. + Print minimum of scalar at vertices of the surfaces. """ - return PyMenu(self.service, "/solution/methods/warped_face_gradient_correction/turbulence_options").execute(*args, **kwargs) - - class monitors(metaclass=PyMenuMeta): - """ - Enter the monitors menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self._ = self.__class__._(path + [("_", None)], service) - self.__ = self.__class__.__(path + [("__", None)], service) - self.report_files = self.__class__.report_files(path + [("report_files", None)], service) - self.report_plots = self.__class__.report_plots(path + [("report_plots", None)], service) - self.residual = self.__class__.residual(path + [("residual", None)], service) - def convergence_conditions(self, *args, **kwargs): - """ - Manage convergence report. - """ - return PyMenu(self.service, "/solution/monitors/convergence_conditions").execute(*args, **kwargs) - def set_average_over(self, *args, **kwargs): - """ - Set the average over input for monitors. - """ - return PyMenu(self.service, "/solution/monitors/set_average_over").execute(*args, **kwargs) + return PyMenu(self.service, "/results/report/surface_integrals/vertex_min").execute(*args, **kwargs) + def volume_flow_rate(self, *args, **kwargs): + """ + Print volume flow rate through surfaces. + """ + return PyMenu(self.service, "/results/report/surface_integrals/volume_flow_rate").execute(*args, **kwargs) - class _(metaclass=PyMenuMeta): + class volume_integrals(TUIMenu): """ - Enter the convergence menu to add surface, volume, drag, lift and moment monitors to convergence criteria. + Volume Integral menu. """ def __init__(self, path, service): self.path = path self.service = service - def add_edit(self, *args, **kwargs): - """ - Add or edit convergence criterion for surface, volume, drag, lift and moment monitors. - """ - return PyMenu(self.service, "/solution/monitors/_/add_edit").execute(*args, **kwargs) - def frequency(self, *args, **kwargs): - """ - To set how often convergence checks are done with respect to iterations or time steps. - """ - return PyMenu(self.service, "/solution/monitors/_/frequency").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - List defined convergence criteria for monitors. - """ - return PyMenu(self.service, "/solution/monitors/_/list").execute(*args, **kwargs) - def condition(self, *args, **kwargs): + super().__init__(path, service) + def mass(self, *args, **kwargs): """ - Option to stop the calculations. All convergence conditions are met or any convergence condition is met. + Print total mass of specified cell zones. """ - return PyMenu(self.service, "/solution/monitors/_/condition").execute(*args, **kwargs) - def average_over_last_n_iterations_timesteps(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/volume_integrals/mass").execute(*args, **kwargs) + def mass_avg(self, *args, **kwargs): """ - Option to average over previous values for checking convergence. + Print mass-average of scalar over cell zones. """ - return PyMenu(self.service, "/solution/monitors/_/average_over_last_n_iterations_timesteps").execute(*args, **kwargs) - def delete(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/volume_integrals/mass_avg").execute(*args, **kwargs) + def mass_integral(self, *args, **kwargs): """ - Delete a monitor from convergence criteria. + Print mass-weighted integral of scalar over cell zones. """ - return PyMenu(self.service, "/solution/monitors/_/delete").execute(*args, **kwargs) - - class __(metaclass=PyMenuMeta): - """ - Enter the statistic monitors menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def monitors(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/volume_integrals/mass_integral").execute(*args, **kwargs) + def maximum(self, *args, **kwargs): """ - Choose which statistics to monitor as printed and/or plotted output. + Print maximum of scalar over all cell zones. """ - return PyMenu(self.service, "/solution/monitors/__/monitors").execute(*args, **kwargs) - def plot(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/volume_integrals/maximum").execute(*args, **kwargs) + def minimum(self, *args, **kwargs): """ - Enable/disable plotting of statistics during iteration. + Print minimum of scalar over all cell zones. """ - return PyMenu(self.service, "/solution/monitors/__/plot").execute(*args, **kwargs) - def print(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/volume_integrals/minimum").execute(*args, **kwargs) + def sum(self, *args, **kwargs): """ - Enable/disable printing of statistics during iteration. + Print sum of scalar over all cell zones. """ - return PyMenu(self.service, "/solution/monitors/__/print").execute(*args, **kwargs) - def write(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/volume_integrals/sum").execute(*args, **kwargs) + def twopisum(self, *args, **kwargs): """ - Enable/disable writing of statistics during iteration. + Print sum of scalar over all cell zones multiplied by 2\*Pi. """ - return PyMenu(self.service, "/solution/monitors/__/write").execute(*args, **kwargs) - def window(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/volume_integrals/twopisum").execute(*args, **kwargs) + def volume(self, *args, **kwargs): """ - Specify first window in which statistics will be plotted during iteration. - Multiple statistics are plotted in separate windows, beginning with this one. + Print total volume of specified cell zones. """ - return PyMenu(self.service, "/solution/monitors/__/window").execute(*args, **kwargs) - def file_basename(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/volume_integrals/volume").execute(*args, **kwargs) + def volume_avg(self, *args, **kwargs): """ - Specify the file basename and extension. The name of the individual monitor will be insterted automatically. + Print volume-weighted average of scalar over cell zones. """ - return PyMenu(self.service, "/solution/monitors/__/file_basename").execute(*args, **kwargs) - def x_axis(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/volume_integrals/volume_avg").execute(*args, **kwargs) + def volume_integral(self, *args, **kwargs): """ - Choose what quantity to use on the abscissa in the plot and in the data written to files. + Print integral of scalar over cell zones. """ - return PyMenu(self.service, "/solution/monitors/__/x_axis").execute(*args, **kwargs) + return PyMenu(self.service, "/results/report/volume_integrals/volume_integral").execute(*args, **kwargs) - class report_files(metaclass=PyMenuMeta): + class modified_setting(TUIMenu): """ - Manage report files. + Enter the menu for setting up the Modified Settings Summary table. """ def __init__(self, path, service): self.path = path self.service = service - def add(self, *args, **kwargs): - """ - Add a new object. - """ - return PyMenu(self.service, "/solution/monitors/report_files/add").execute(*args, **kwargs) - def clear_data(self, *args, **kwargs): - """ - Delete the report file from the system. - """ - return PyMenu(self.service, "/solution/monitors/report_files/clear_data").execute(*args, **kwargs) - def delete_all(self, *args, **kwargs): - """ - Delete all report file objects. - """ - return PyMenu(self.service, "/solution/monitors/report_files/delete_all").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edit an object. - """ - return PyMenu(self.service, "/solution/monitors/report_files/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Delete an object. - """ - return PyMenu(self.service, "/solution/monitors/report_files/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): + super().__init__(path, service) + def modified_setting(self, *args, **kwargs): """ - List objects. + Specify which settings will be checked for non-default status for generating the Modified Settings Summary table. """ - return PyMenu(self.service, "/solution/monitors/report_files/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/modified_setting/modified_setting").execute(*args, **kwargs) + def write_user_setting(self, *args, **kwargs): """ - List properties of an object. + Write the contents of the Modified Settings Summary table to a file. """ - return PyMenu(self.service, "/solution/monitors/report_files/list_properties").execute(*args, **kwargs) + return PyMenu(self.service, "/results/report/modified_setting/write_user_setting").execute(*args, **kwargs) - class report_plots(metaclass=PyMenuMeta): + class population_balance(TUIMenu): """ - Manage report plots. + Population Balance menu. """ def __init__(self, path, service): self.path = path self.service = service - def add(self, *args, **kwargs): - """ - Add a new object. - """ - return PyMenu(self.service, "/solution/monitors/report_plots/add").execute(*args, **kwargs) - def axes(self, *args, **kwargs): - """ - Set axes options of an object. - """ - return PyMenu(self.service, "/solution/monitors/report_plots/axes").execute(*args, **kwargs) - def clear_data(self, *args, **kwargs): - """ - Clear report plot data. - """ - return PyMenu(self.service, "/solution/monitors/report_plots/clear_data").execute(*args, **kwargs) - def curves(self, *args, **kwargs): + super().__init__(path, service) + def moments(self, *args, **kwargs): """ - Set curves options of an object. + Set moments for population balance. """ - return PyMenu(self.service, "/solution/monitors/report_plots/curves").execute(*args, **kwargs) - def delete_all(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/population_balance/moments").execute(*args, **kwargs) + def number_density(self, *args, **kwargs): """ - Delete all plot objects. + Set number density functions. """ - return PyMenu(self.service, "/solution/monitors/report_plots/delete_all").execute(*args, **kwargs) - def edit(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/population_balance/number_density").execute(*args, **kwargs) + + class heat_exchanger(TUIMenu): + """ + Enter the heat exchanger menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def computed_heat_rejection(self, *args, **kwargs): """ - Edit an object. + Print total heat rejection. """ - return PyMenu(self.service, "/solution/monitors/report_plots/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/heat_exchanger/computed_heat_rejection").execute(*args, **kwargs) + def inlet_temperature(self, *args, **kwargs): """ - Delete an object. + Print inlet temperature. """ - return PyMenu(self.service, "/solution/monitors/report_plots/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/heat_exchanger/inlet_temperature").execute(*args, **kwargs) + def outlet_temperature(self, *args, **kwargs): """ - List objects. + Print outlet temperature. """ - return PyMenu(self.service, "/solution/monitors/report_plots/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/heat_exchanger/outlet_temperature").execute(*args, **kwargs) + def mass_flow_rate(self, *args, **kwargs): """ - List properties of an object. + Print mass flow rate. """ - return PyMenu(self.service, "/solution/monitors/report_plots/list_properties").execute(*args, **kwargs) - def plot(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/heat_exchanger/mass_flow_rate").execute(*args, **kwargs) + def specific_heat(self, *args, **kwargs): """ - Plot. + Print fluid's specific heat. """ - return PyMenu(self.service, "/solution/monitors/report_plots/plot").execute(*args, **kwargs) + return PyMenu(self.service, "/results/report/heat_exchanger/specific_heat").execute(*args, **kwargs) - class residual(metaclass=PyMenuMeta): + class system(TUIMenu): """ - Enter the residual monitors menu. + Sytem menu. """ def __init__(self, path, service): self.path = path self.service = service - def check_convergence(self, *args, **kwargs): + super().__init__(path, service) + def proc_stats(self, *args, **kwargs): """ - Choose which currently-monitored residuals - should be checked for convergence. + Fluent process information. """ - return PyMenu(self.service, "/solution/monitors/residual/check_convergence").execute(*args, **kwargs) - def convergence_criteria(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/system/proc_stats").execute(*args, **kwargs) + def sys_stats(self, *args, **kwargs): """ - Set convergence criteria for residuals which are - currently being both monitored and checked. + System information. """ - return PyMenu(self.service, "/solution/monitors/residual/convergence_criteria").execute(*args, **kwargs) - def criterion_type(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/system/sys_stats").execute(*args, **kwargs) + def gpgpu_stats(self, *args, **kwargs): """ - Set convergence criterion type. + GPGPU information. """ - return PyMenu(self.service, "/solution/monitors/residual/criterion_type").execute(*args, **kwargs) - def monitor(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/system/gpgpu_stats").execute(*args, **kwargs) + def time_stats(self, *args, **kwargs): """ - Choose which residuals to monitor as printed and/or plotted output. + Time usage information. """ - return PyMenu(self.service, "/solution/monitors/residual/monitor").execute(*args, **kwargs) - def enhanced_continuity_residual(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/system/time_stats").execute(*args, **kwargs) + + class simulation_reports(TUIMenu): + """ + Enter the simulation reports menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def list_simulation_reports(self, *args, **kwargs): """ - Scale the continuity residuals locally based on the enhanced formulation. + List all report names. """ - return PyMenu(self.service, "/solution/monitors/residual/enhanced_continuity_residual").execute(*args, **kwargs) - def n_display(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/simulation_reports/list_simulation_reports").execute(*args, **kwargs) + def generate_simulation_report(self, *args, **kwargs): """ - Set the number of most recent residuals to display in plots. + Generate a new simulation report or regenerate an existing simulation report with the provided name. """ - return PyMenu(self.service, "/solution/monitors/residual/n_display").execute(*args, **kwargs) - def n_maximize_norms(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/simulation_reports/generate_simulation_report").execute(*args, **kwargs) + def view_simulation_report(self, *args, **kwargs): """ - Set the number of iterations through which normalization - factors will be maximized. + View a simulation report that has already been generated. In batch mode this will print the report's URL. """ - return PyMenu(self.service, "/solution/monitors/residual/n_maximize_norms").execute(*args, **kwargs) - def normalization_factors(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/simulation_reports/view_simulation_report").execute(*args, **kwargs) + def export_simulation_report_as_pdf(self, *args, **kwargs): """ - Set normalization factors for currently-monitored residuals. + Export the provided simulation report as a PDF file. """ - return PyMenu(self.service, "/solution/monitors/residual/normalization_factors").execute(*args, **kwargs) - def normalize(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/simulation_reports/export_simulation_report_as_pdf").execute(*args, **kwargs) + def export_simulation_report_as_html(self, *args, **kwargs): """ - Choose whether or not to normalize residuals in printed and plotted output. + Export the provided simulation report as HTML. """ - return PyMenu(self.service, "/solution/monitors/residual/normalize").execute(*args, **kwargs) - def n_save(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/simulation_reports/export_simulation_report_as_html").execute(*args, **kwargs) + def write_report_names_to_file(self, *args, **kwargs): """ - Set number of residuals to be saved with data. - History is automatically compacted when buffer becomes full. + Write the list of currently generated report names to a txt file. """ - return PyMenu(self.service, "/solution/monitors/residual/n_save").execute(*args, **kwargs) - def plot(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/simulation_reports/write_report_names_to_file").execute(*args, **kwargs) + def rename_simulation_report(self, *args, **kwargs): """ - Choose whether or not residuals will be plotted during iteration. + Rename a report which has already been generated. """ - return PyMenu(self.service, "/solution/monitors/residual/plot").execute(*args, **kwargs) - def print(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/simulation_reports/rename_simulation_report").execute(*args, **kwargs) + def duplicate_simulation_report(self, *args, **kwargs): """ - Choose whether or not residuals will be printed during iteration. + Duplicate a report and all of its settings to a new report. """ - return PyMenu(self.service, "/solution/monitors/residual/print").execute(*args, **kwargs) - def relative_conv_criteria(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/simulation_reports/duplicate_simulation_report").execute(*args, **kwargs) + def reset_report_to_defaults(self, *args, **kwargs): """ - Set relative convergence criteria for residuals which are - currently being both monitored and checked. + Reset all report settings to default for the provided simulation report. """ - return PyMenu(self.service, "/solution/monitors/residual/relative_conv_criteria").execute(*args, **kwargs) - def re_normalize(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/simulation_reports/reset_report_to_defaults").execute(*args, **kwargs) + def delete_simulation_report(self, *args, **kwargs): """ - Renormalize residuals by maximum values. + Delete the provided simulation report. """ - return PyMenu(self.service, "/solution/monitors/residual/re_normalize").execute(*args, **kwargs) - def reset(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/simulation_reports/delete_simulation_report").execute(*args, **kwargs) + def write_simulation_report_template_file(self, *args, **kwargs): """ - Delete the residual history and reset iteration counter to unity. + Write a JSON template file with this case's Simulation Report settings. """ - return PyMenu(self.service, "/solution/monitors/residual/reset").execute(*args, **kwargs) - def scale_by_coefficient(self, *args, **kwargs): + return PyMenu(self.service, "/results/report/simulation_reports/write_simulation_report_template_file").execute(*args, **kwargs) + def read_simulation_report_template_file(self, *args, **kwargs): """ - Enable/disable scaling of residuals by coefficient sum in printed and plotted output. + Read a JSON template file with existing Simulation Report settings. """ - return PyMenu(self.service, "/solution/monitors/residual/scale_by_coefficient").execute(*args, **kwargs) + return PyMenu(self.service, "/results/report/simulation_reports/read_simulation_report_template_file").execute(*args, **kwargs) - class report_definitions(metaclass=PyMenuMeta): + class surface(TUIMenu): """ - Manage report definitions. + Enter the data surface manipulation menu. """ def __init__(self, path, service): self.path = path self.service = service - def add(self, *args, **kwargs): + self.post_processing_volume = self.__class__.post_processing_volume(path + [("post_processing_volume", None)], service) + self.query = self.__class__.query(path + [("query", None)], service) + super().__init__(path, service) + def circle_slice(self, *args, **kwargs): """ - Add a new object. + Extract a circular slice. """ - return PyMenu(self.service, "/solution/report_definitions/add").execute(*args, **kwargs) - def compute(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/circle_slice").execute(*args, **kwargs) + def delete_surface(self, *args, **kwargs): """ - Computes selected report definition. + Remove a defined data surface. """ - return PyMenu(self.service, "/solution/report_definitions/compute").execute(*args, **kwargs) - def copy(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/delete_surface").execute(*args, **kwargs) + def group_surfaces(self, *args, **kwargs): """ - Makes a copy of selected report definition with new name. + Group a set of surfaces. """ - return PyMenu(self.service, "/solution/report_definitions/copy").execute(*args, **kwargs) - def delete_all(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/group_surfaces").execute(*args, **kwargs) + def ungroup_surface(self, *args, **kwargs): """ - Delete all report definition objects. + Ungroup the surface(if grouped). """ - return PyMenu(self.service, "/solution/report_definitions/delete_all").execute(*args, **kwargs) - def edit(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/ungroup_surface").execute(*args, **kwargs) + def iso_clip(self, *args, **kwargs): """ - Edit an object. + Clip a data surface (surface, curve, or point) between two iso-values. """ - return PyMenu(self.service, "/solution/report_definitions/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/iso_clip").execute(*args, **kwargs) + def iso_surface(self, *args, **kwargs): """ - Delete an object. + Extract an iso-surface (surface, curve, or point) from the curent data field. """ - return PyMenu(self.service, "/solution/report_definitions/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/iso_surface").execute(*args, **kwargs) + def expression_volume(self, *args, **kwargs): """ - List objects. + Create volume with boolean expression. """ - return PyMenu(self.service, "/solution/report_definitions/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/expression_volume").execute(*args, **kwargs) + def multiple_iso_surfaces(self, *args, **kwargs): """ - List properties of an object. + Create multiple iso-surfaces from the data field at specified spacing. """ - return PyMenu(self.service, "/solution/report_definitions/list_properties").execute(*args, **kwargs) - def rename(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/multiple_iso_surfaces").execute(*args, **kwargs) + def line_slice(self, *args, **kwargs): """ - Rename selected report definition with new name. + Extract a linear slice. """ - return PyMenu(self.service, "/solution/report_definitions/rename").execute(*args, **kwargs) - - class run_calculation(metaclass=PyMenuMeta): - """ - Enter run calculation menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.data_sampling_options = self.__class__.data_sampling_options(path + [("data_sampling_options", None)], service) - self.transient_controls = self.__class__.transient_controls(path + [("transient_controls", None)], service) - def adaptive_time_stepping(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/line_slice").execute(*args, **kwargs) + def line_surface(self, *args, **kwargs): """ - Set Error-based adaptive time-stepping parameters. + Define a "line" surface by specifying the two endpoint coordinates. """ - return PyMenu(self.service, "/solution/run_calculation/adaptive_time_stepping").execute(*args, **kwargs) - def cfl_based_adaptive_time_stepping(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/line_surface").execute(*args, **kwargs) + def list_surfaces(self, *args, **kwargs): """ - Set CFL-based adaptive time-stepping parameters. + List the number of facets in the defined surfaces. """ - return PyMenu(self.service, "/solution/run_calculation/cfl_based_adaptive_time_stepping").execute(*args, **kwargs) - def data_sampling(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/list_surfaces").execute(*args, **kwargs) + def mouse_line(self, *args, **kwargs): """ - Set iteration options. + Define a line surface using the mouse to select two points. """ - return PyMenu(self.service, "/solution/run_calculation/data_sampling").execute(*args, **kwargs) - def dual_time_iterate(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/mouse_line").execute(*args, **kwargs) + def mouse_plane(self, *args, **kwargs): """ - Perform unsteady iterations. + Define a plane surface using the mouse to select three points. """ - return PyMenu(self.service, "/solution/run_calculation/dual_time_iterate").execute(*args, **kwargs) - def iterate(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/mouse_plane").execute(*args, **kwargs) + def mouse_rake(self, *args, **kwargs): """ - Perform a specified number of iterations. + Define a "rake" surface using the mouse to select the end points. """ - return PyMenu(self.service, "/solution/run_calculation/iterate").execute(*args, **kwargs) - def max_corrections(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/mouse_rake").execute(*args, **kwargs) + def partition_surface(self, *args, **kwargs): """ - Enter the max-corrections menu. + Define a data surface on mesh faces on the partition boundary. """ - return PyMenu(self.service, "/solution/run_calculation/max_corrections").execute(*args, **kwargs) - def mesh_motion(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/partition_surface").execute(*args, **kwargs) + def plane(self, *args, **kwargs): """ - Perform mesh motion. + Create a plane given 3 points bounded by the domain. """ - return PyMenu(self.service, "/solution/run_calculation/mesh_motion").execute(*args, **kwargs) - def multistage_time_iterate(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/plane").execute(*args, **kwargs) + def plane_surface(self, *args, **kwargs): """ - Perform unsteady iterations. + Create a plane from a coordinate plane, point and normal, or three points. """ - return PyMenu(self.service, "/solution/run_calculation/multistage_time_iterate").execute(*args, **kwargs) - def number_of_iterations(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/plane_surface").execute(*args, **kwargs) + def multiple_plane_surfaces(self, *args, **kwargs): """ - Set number of iterations. + Create multiple plane surfaces at specified spacing. """ - return PyMenu(self.service, "/solution/run_calculation/number_of_iterations").execute(*args, **kwargs) - def reporting_interval(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/multiple_plane_surfaces").execute(*args, **kwargs) + def plane_slice(self, *args, **kwargs): """ - Set number of solver iterations before returning to scheme. + Extract a planar slice. """ - return PyMenu(self.service, "/solution/run_calculation/reporting_interval").execute(*args, **kwargs) - def residual_tolerance(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/plane_slice").execute(*args, **kwargs) + def point_array(self, *args, **kwargs): """ - Enter the residual tolerance menu. + Extract a rectangular array of data points. """ - return PyMenu(self.service, "/solution/run_calculation/residual_tolerance").execute(*args, **kwargs) - def residual_verbosity(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/point_array").execute(*args, **kwargs) + def point_surface(self, *args, **kwargs): """ - Set the residual report verbosity. + Define a "point" surface by specifying the coordinates. """ - return PyMenu(self.service, "/solution/run_calculation/residual_verbosity").execute(*args, **kwargs) - def second_order_time_options(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/point_surface").execute(*args, **kwargs) + def structural_point_surface(self, *args, **kwargs): """ - Set options for second-order time formulation. + Define a "structural point" surface by specifying the coordinates. """ - return PyMenu(self.service, "/solution/run_calculation/second_order_time_options").execute(*args, **kwargs) - def solution_steering(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/structural_point_surface").execute(*args, **kwargs) + def quadric_slice(self, *args, **kwargs): """ - Enable solution steering for density-based solver. + Extract a quadric slice. """ - return PyMenu(self.service, "/solution/run_calculation/solution_steering").execute(*args, **kwargs) - def set_solution_steering(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/quadric_slice").execute(*args, **kwargs) + def rake_surface(self, *args, **kwargs): """ - Set Solution Steering Parameters. + Define a "rake" surface by specifying the end points. """ - return PyMenu(self.service, "/solution/run_calculation/set_solution_steering").execute(*args, **kwargs) - def summary(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/rake_surface").execute(*args, **kwargs) + def rename_surface(self, *args, **kwargs): """ - Print report summary. + Rename a defined data surface. """ - return PyMenu(self.service, "/solution/run_calculation/summary").execute(*args, **kwargs) - def time_step(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/rename_surface").execute(*args, **kwargs) + def sphere_slice(self, *args, **kwargs): """ - Set the time step. + Extract a spherical slice. """ - return PyMenu(self.service, "/solution/run_calculation/time_step").execute(*args, **kwargs) - def update_physical_time(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/sphere_slice").execute(*args, **kwargs) + def ellipsoid_slice(self, *args, **kwargs): """ - Update the solution to the next physical time level. + Extract a ellipsoid slice. """ - return PyMenu(self.service, "/solution/run_calculation/update_physical_time").execute(*args, **kwargs) - def variable_time_stepping(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/ellipsoid_slice").execute(*args, **kwargs) + def cone_slice(self, *args, **kwargs): """ - Set Multiphase-Specific Adaptive time stepping parameters. + Extract a cone slice. """ - return PyMenu(self.service, "/solution/run_calculation/variable_time_stepping").execute(*args, **kwargs) + return PyMenu(self.service, "/results/surface/cone_slice").execute(*args, **kwargs) + def surface_cells(self, *args, **kwargs): + """ + Extract all cells intersected by a data surface. + """ + return PyMenu(self.service, "/results/surface/surface_cells").execute(*args, **kwargs) + def transform_surface(self, *args, **kwargs): + """ + Transform surface. + """ + return PyMenu(self.service, "/results/surface/transform_surface").execute(*args, **kwargs) + def create_imprint_surface(self, *args, **kwargs): + """ + Imprint surface. + """ + return PyMenu(self.service, "/results/surface/create_imprint_surface").execute(*args, **kwargs) + def zone_surface(self, *args, **kwargs): + """ + Define a data surface on a mesh zone. + """ + return PyMenu(self.service, "/results/surface/zone_surface").execute(*args, **kwargs) + def reset_zone_surfaces(self, *args, **kwargs): + """ + Reset case surface list. + """ + return PyMenu(self.service, "/results/surface/reset_zone_surfaces").execute(*args, **kwargs) + def multiple_zone_surfaces(self, *args, **kwargs): + """ + Create multiple data surfaces at a time. + """ + return PyMenu(self.service, "/results/surface/multiple_zone_surfaces").execute(*args, **kwargs) + def edit_surface(self, *args, **kwargs): + """ + Edit a defined data surface. + """ + return PyMenu(self.service, "/results/surface/edit_surface").execute(*args, **kwargs) - class data_sampling_options(metaclass=PyMenuMeta): + class post_processing_volume(TUIMenu): """ - Data sampling options for statistics. + Enter post-processing volume menu. """ def __init__(self, path, service): self.path = path self.service = service - def add_datasets(self, *args, **kwargs): - """ - Add a dataset. After providing the zones for a dataset, press [Enter] to move onto selecting quantities. Enter () to complete the quantity selection for this dataset. - """ - return PyMenu(self.service, "/solution/run_calculation/data_sampling_options/add_datasets").execute(*args, **kwargs) - def add_rtdft_datasets(self, *args, **kwargs): - """ - Add a dataset. After providing the zones for a dataset, press [Enter] to move onto selecting quantities. Enter () to complete the quantity selection for this dataset. - """ - return PyMenu(self.service, "/solution/run_calculation/data_sampling_options/add_rtdft_datasets").execute(*args, **kwargs) - def remove_dataset(self, *args, **kwargs): + super().__init__(path, service) + def create_from_file(self, *args, **kwargs): """ - Remove dataset. + Read post-processing mesh from file. """ - return PyMenu(self.service, "/solution/run_calculation/data_sampling_options/remove_dataset").execute(*args, **kwargs) - def list_datasets(self, *args, **kwargs): + return PyMenu(self.service, "/results/surface/post_processing_volume/create_from_file").execute(*args, **kwargs) + def create_octree(self, *args, **kwargs): """ - List dataset. + Create post-processing octree mesh based on current case. """ - return PyMenu(self.service, "/solution/run_calculation/data_sampling_options/list_datasets").execute(*args, **kwargs) + return PyMenu(self.service, "/results/surface/post_processing_volume/create_octree").execute(*args, **kwargs) - class transient_controls(metaclass=PyMenuMeta): + class query(TUIMenu): """ - Enter into the transient controls menu. + Enter surface query menu. """ def __init__(self, path, service): self.path = path self.service = service - self.multiphase_specific_time_constraints = self.__class__.multiphase_specific_time_constraints(path + [("multiphase_specific_time_constraints", None)], service) - def specified_time_step(self, *args, **kwargs): - """ - Use specified time step or courant number. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/specified_time_step").execute(*args, **kwargs) - def fixed_user_specified(self, *args, **kwargs): - """ - Enable user-specified fixed time stepping method. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/fixed_user_specified").execute(*args, **kwargs) - def fixed_periodic(self, *args, **kwargs): - """ - Set period- or frequency-based fixed time-stepping parameters. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/fixed_periodic").execute(*args, **kwargs) - def duration_specification_method(self, *args, **kwargs): - """ - Set Duration Specification Method: [0] Incremental Time Steps, [1] Total Time Steps, [2] Total Time, [3] Incremental Time. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/duration_specification_method").execute(*args, **kwargs) - def incremental_time(self, *args, **kwargs): - """ - Set Incremental Time. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/incremental_time").execute(*args, **kwargs) - def max_iterations_per_time_step(self, *args, **kwargs): - """ - Set Max Iterations/Time step. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/max_iterations_per_time_step").execute(*args, **kwargs) - def number_of_time_steps(self, *args, **kwargs): - """ - Set inceremtal number of Time steps. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/number_of_time_steps").execute(*args, **kwargs) - def total_number_of_time_steps(self, *args, **kwargs): - """ - Set total number of Time steps. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/total_number_of_time_steps").execute(*args, **kwargs) - def total_time(self, *args, **kwargs): - """ - Set Total Simulation Time. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/total_time").execute(*args, **kwargs) - def time_step_size(self, *args, **kwargs): - """ - Set the physical time step size. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/time_step_size").execute(*args, **kwargs) - def solution_status(self, *args, **kwargs): - """ - Activate the simulation status panel. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/solution_status").execute(*args, **kwargs) - def extrapolate_vars(self, *args, **kwargs): - """ - Applies a predictor algorithm for computing initial condition at time step n+1. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/extrapolate_vars").execute(*args, **kwargs) - def extrapolate_eqn_vars(self, *args, **kwargs): - """ - Enter the extrapolation menu. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/extrapolate_eqn_vars").execute(*args, **kwargs) - def max_flow_time(self, *args, **kwargs): - """ - Set maximum flow time. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/max_flow_time").execute(*args, **kwargs) - def cfl_based_time_stepping_advanced_options(self, *args, **kwargs): - """ - Set CFL-based adaptive time-stepping advanced parameters. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/cfl_based_time_stepping_advanced_options").execute(*args, **kwargs) - def cfl_based_time_stepping(self, *args, **kwargs): - """ - Set CFL-based adaptive time-stepping parameters. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/cfl_based_time_stepping").execute(*args, **kwargs) - def multiphase_specific_time_stepping(self, *args, **kwargs): - """ - Set Multiphase-specific adaptive time stepping parameters. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/multiphase_specific_time_stepping").execute(*args, **kwargs) - def udf_based_time_stepping(self, *args, **kwargs): - """ - Set the time-stepping parameters for user-defined time stepping method. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/udf_based_time_stepping").execute(*args, **kwargs) - def error_based_time_stepping(self, *args, **kwargs): - """ - Set Error-based adaptive time-stepping parameters. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/error_based_time_stepping").execute(*args, **kwargs) - def undo_timestep(self, *args, **kwargs): - """ - Undo the previous time step. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/undo_timestep").execute(*args, **kwargs) - def predict_next_time(self, *args, **kwargs): - """ - Applies a predictor algorithm for computing initial condition at time step n+1. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/predict_next_time").execute(*args, **kwargs) - def rotating_mesh_flow_predictor(self, *args, **kwargs): - """ - Improve prediction of flow field at time step n+1 for rotating mesh. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/rotating_mesh_flow_predictor").execute(*args, **kwargs) - def solid_time_step_size(self, *args, **kwargs): - """ - Specify a different time step size for solid zones. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/solid_time_step_size").execute(*args, **kwargs) - def time_step_size_for_acoustic_export(self, *args, **kwargs): + super().__init__(path, service) + def delete_query(self, *args, **kwargs): """ - Set number of time step size for acoustic export. + Delete saved query. """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/time_step_size_for_acoustic_export").execute(*args, **kwargs) - - class multiphase_specific_time_constraints(metaclass=PyMenuMeta): + return PyMenu(self.service, "/results/surface/query/delete_query").execute(*args, **kwargs) + def list_surfaces(self, *args, **kwargs): """ - Set Multiphase-specific time constraints. + List surfaces. """ - def __init__(self, path, service): - self.path = path - self.service = service - self.time_scale_options = self.__class__.time_scale_options(path + [("time_scale_options", None)], service) - def moving_mesh_cfl_constraint(self, *args, **kwargs): - """ - Enable time step size constraints based on moving mesh courant number. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/multiphase_specific_time_constraints/moving_mesh_cfl_constraint").execute(*args, **kwargs) - def physics_based_constraint(self, *args, **kwargs): - """ - Include physics driven time-step constraints. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/multiphase_specific_time_constraints/physics_based_constraint").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Set verbosity to print multiphase specific time scales. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/multiphase_specific_time_constraints/verbosity").execute(*args, **kwargs) - - class time_scale_options(metaclass=PyMenuMeta): - """ - Set physics based time scale options. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def viscous_scale(self, *args, **kwargs): - """ - Include viscous time scale. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/multiphase_specific_time_constraints/time_scale_options/viscous_scale").execute(*args, **kwargs) - def gravity_scale(self, *args, **kwargs): - """ - Include gravity based time scale. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/multiphase_specific_time_constraints/time_scale_options/gravity_scale").execute(*args, **kwargs) - def surface_tension_scale(self, *args, **kwargs): - """ - Include surface tension based time scale. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/multiphase_specific_time_constraints/time_scale_options/surface_tension_scale").execute(*args, **kwargs) - def acoustic_scale(self, *args, **kwargs): - """ - Include acoustic time scale. - """ - return PyMenu(self.service, "/solution/run_calculation/transient_controls/multiphase_specific_time_constraints/time_scale_options/acoustic_scale").execute(*args, **kwargs) - - class solve(metaclass=PyMenuMeta): - """ - Enter the solve menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.animate = self.__class__.animate(path + [("animate", None)], service) - self.initialize = self.__class__.initialize(path + [("initialize", None)], service) - self.monitors = self.__class__.monitors(path + [("monitors", None)], service) - self.report_files = self.__class__.report_files(path + [("report_files", None)], service) - self.report_definitions = self.__class__.report_definitions(path + [("report_definitions", None)], service) - self.report_plots = self.__class__.report_plots(path + [("report_plots", None)], service) - self.cell_registers = self.__class__.cell_registers(path + [("cell_registers", None)], service) - self.cell_register_operations = self.__class__.cell_register_operations(path + [("cell_register_operations", None)], service) - self.set = self.__class__.set(path + [("set", None)], service) - self.execute_commands = self.__class__.execute_commands(path + [("execute_commands", None)], service) - def patch(self, *args, **kwargs): - """ - Patches a value for a flow variable in the domain. You can either provide a numerical value, which you can enter directly, or you can enter an expression, which must be entered within quotation marks. - """ - return PyMenu(self.service, "/solve/patch").execute(*args, **kwargs) - def iterate(self, *args, **kwargs): - """ - Performs a specified number of iterations. This option is still available during transient simulations, since it can be used to add more iterations to the same time step after interrupting iterations within a time step. - """ - return PyMenu(self.service, "/solve/iterate").execute(*args, **kwargs) - def iterate_steady_2way_fsi(self, *args, **kwargs): - """ - Perform a specified number of steps. - """ - return PyMenu(self.service, "/solve/iterate_steady_2way_fsi").execute(*args, **kwargs) - def convergence_conditions(self, *args, **kwargs): - """ - Enters the convergence conditions menu. - """ - return PyMenu(self.service, "/solve/convergence_conditions").execute(*args, **kwargs) - def dpm_update(self, *args, **kwargs): - """ - Updates discrete phase source terms. - """ - return PyMenu(self.service, "/solve/dpm_update").execute(*args, **kwargs) - def dual_time_iterate(self, *args, **kwargs): - """ - Performs unsteady iterations for a specified number of time steps. - """ - return PyMenu(self.service, "/solve/dual_time_iterate").execute(*args, **kwargs) - def multistage_time_iterate(self, *args, **kwargs): - """ - Perform unsteady iterations. - """ - return PyMenu(self.service, "/solve/multistage_time_iterate").execute(*args, **kwargs) - def update_physical_time(self, *args, **kwargs): - """ - Advances the unsteady solution to the next physical time level. Using this command in conjunction with theiterate command allows you to manually advance the solution in time (rather than doing it automatically with the dual-time-iterate command). - """ - return PyMenu(self.service, "/solve/update_physical_time").execute(*args, **kwargs) - def mesh_motion(self, *args, **kwargs): - """ - Performs mesh motion. - """ - return PyMenu(self.service, "/solve/mesh_motion").execute(*args, **kwargs) + return PyMenu(self.service, "/results/surface/query/list_surfaces").execute(*args, **kwargs) + def named_surface_list(self, *args, **kwargs): + """ + Create named list of surfaces. + """ + return PyMenu(self.service, "/results/surface/query/named_surface_list").execute(*args, **kwargs) + def list_named_selection(self, *args, **kwargs): + """ + List named selection of surface type. + """ + return PyMenu(self.service, "/results/surface/query/list_named_selection").execute(*args, **kwargs) + def list_queries(self, *args, **kwargs): + """ + List all saved queries. + """ + return PyMenu(self.service, "/results/surface/query/list_queries").execute(*args, **kwargs) - class animate(metaclass=PyMenuMeta): + class graphics_window(TUIMenu): """ - Enters the animation menu. + Enter graphics window menu. """ def __init__(self, path, service): self.path = path self.service = service - self.define = self.__class__.define(path + [("define", None)], service) - self.playback = self.__class__.playback(path + [("playback", None)], service) - self.objects = self.__class__.objects(path + [("objects", None)], service) - self.pulse = self.__class__.pulse(path + [("pulse", None)], service) + self.embedded_windows = self.__class__.embedded_windows(path + [("embedded_windows", None)], service) + self.picture = self.__class__.picture(path + [("picture", None)], service) + self.windows = self.__class__.windows(path + [("windows", None)], service) + self.titles = self.__class__.titles(path + [("titles", None)], service) + self.views = self.__class__.views(path + [("views", None)], service) + self.display_states = self.__class__.display_states(path + [("display_states", None)], service) + self.view_sync = self.__class__.view_sync(path + [("view_sync", None)], service) + super().__init__(path, service) + def close_window(self, *args, **kwargs): + """ + Close a user graphics window. + """ + return PyMenu(self.service, "/results/graphics_window/close_window").execute(*args, **kwargs) + def close_window_by_name(self, *args, **kwargs): + """ + Close a reserved graphics window by its name. + """ + return PyMenu(self.service, "/results/graphics_window/close_window_by_name").execute(*args, **kwargs) + def open_window(self, *args, **kwargs): + """ + Open a user graphics window. + """ + return PyMenu(self.service, "/results/graphics_window/open_window").execute(*args, **kwargs) + def save_picture(self, *args, **kwargs): + """ + Generate a "hardcopy" of the active window. + """ + return PyMenu(self.service, "/results/graphics_window/save_picture").execute(*args, **kwargs) + def set_window(self, *args, **kwargs): + """ + Set a user graphics window to be the active window. + """ + return PyMenu(self.service, "/results/graphics_window/set_window").execute(*args, **kwargs) + def set_window_by_name(self, *args, **kwargs): + """ + Set a reserved graphics window to be the active window by its name. + """ + return PyMenu(self.service, "/results/graphics_window/set_window_by_name").execute(*args, **kwargs) + def update_layout(self, *args, **kwargs): + """ + Update the fluent layout. + """ + return PyMenu(self.service, "/results/graphics_window/update_layout").execute(*args, **kwargs) - class define(metaclass=PyMenuMeta): + class embedded_windows(TUIMenu): """ - Enters the animation definition menu. + Enter to embed, close, move-out embedded windows. """ def __init__(self, path, service): self.path = path self.service = service - def define_monitor(self, *args, **kwargs): + super().__init__(path, service) + def close(self, *args, **kwargs): """ - Defines new animation. + Close an embedded window. """ - return PyMenu(self.service, "/solve/animate/define/define_monitor").execute(*args, **kwargs) - def edit_monitor(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/embedded_windows/close").execute(*args, **kwargs) + def close_all(self, *args, **kwargs): """ - Changes animation monitor attributes. + Close all embedded windows for given parent window. """ - return PyMenu(self.service, "/solve/animate/define/edit_monitor").execute(*args, **kwargs) + return PyMenu(self.service, "/results/graphics_window/embedded_windows/close_all").execute(*args, **kwargs) + def embed_in(self, *args, **kwargs): + """ + Embed Window into another window. + """ + return PyMenu(self.service, "/results/graphics_window/embedded_windows/embed_in").execute(*args, **kwargs) + def move_out(self, *args, **kwargs): + """ + Move out an embedded window. + """ + return PyMenu(self.service, "/results/graphics_window/embedded_windows/move_out").execute(*args, **kwargs) + def move_out_all(self, *args, **kwargs): + """ + Move out all embedded windows for given parent window. + """ + return PyMenu(self.service, "/results/graphics_window/embedded_windows/move_out_all").execute(*args, **kwargs) - class playback(metaclass=PyMenuMeta): + class picture(TUIMenu): """ - Enters the animation playback menu. + Enter the hardcopy/save-picture options menu. """ def __init__(self, path, service): self.path = path self.service = service - self.video = self.__class__.video(path + [("video", None)], service) - def read(self, *args, **kwargs): + self.color_mode = self.__class__.color_mode(path + [("color_mode", None)], service) + self.driver = self.__class__.driver(path + [("driver", None)], service) + super().__init__(path, service) + def invert_background(self, *args, **kwargs): """ - Reads new animation from file or already defined animations. + Use a white background when the picture is saved. """ - return PyMenu(self.service, "/solve/animate/playback/read").execute(*args, **kwargs) - def play(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/picture/invert_background").execute(*args, **kwargs) + def landscape(self, *args, **kwargs): """ - Plays the selected animation. + Plot hardcopies in landscape or portrait orientation. """ - return PyMenu(self.service, "/solve/animate/playback/play").execute(*args, **kwargs) - def write(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/picture/landscape").execute(*args, **kwargs) + def preview(self, *args, **kwargs): """ - Writes animation sequence to the file. + Display a preview image of a hardcopy. """ - return PyMenu(self.service, "/solve/animate/playback/write").execute(*args, **kwargs) - def delete(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/picture/preview").execute(*args, **kwargs) + def x_resolution(self, *args, **kwargs): """ - Deletes animation sequence. + Set the width of raster-formatted images in pixels (0 implies current window size). """ - return PyMenu(self.service, "/solve/animate/playback/delete").execute(*args, **kwargs) - def stored_view(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/picture/x_resolution").execute(*args, **kwargs) + def y_resolution(self, *args, **kwargs): """ - Plays the 3D animation sequence using the view stored in the sequence. + Set the height of raster-formatted images in pixels (0 implies current window size). """ - return PyMenu(self.service, "/solve/animate/playback/stored_view").execute(*args, **kwargs) - def set_custom_frames(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/picture/y_resolution").execute(*args, **kwargs) + def dpi(self, *args, **kwargs): """ - Specify a custom start frame, increment, and end frame for video export. + Set the DPI for EPS and Postscript files, specifies the resolution in dots per inch (DPI) instead of setting the width and height. """ - return PyMenu(self.service, "/solve/animate/playback/set_custom_frames").execute(*args, **kwargs) + return PyMenu(self.service, "/results/graphics_window/picture/dpi").execute(*args, **kwargs) + def use_window_resolution(self, *args, **kwargs): + """ + Use the currently active window's resolution for hardcopy (ignores the x-resolution and y-resolution in this case). + """ + return PyMenu(self.service, "/results/graphics_window/picture/use_window_resolution").execute(*args, **kwargs) + def set_standard_resolution(self, *args, **kwargs): + """ + Select from pre-defined resolution list. + """ + return PyMenu(self.service, "/results/graphics_window/picture/set_standard_resolution").execute(*args, **kwargs) + def jpeg_hardcopy_quality(self, *args, **kwargs): + """ + To set jpeg hardcopy quality. + """ + return PyMenu(self.service, "/results/graphics_window/picture/jpeg_hardcopy_quality").execute(*args, **kwargs) - class video(metaclass=PyMenuMeta): + class color_mode(TUIMenu): """ - Enters the video menu. + Enter the hardcopy color mode menu. """ def __init__(self, path, service): self.path = path self.service = service - self.advance_quality = self.__class__.advance_quality(path + [("advance_quality", None)], service) - def fps(self, *args, **kwargs): + super().__init__(path, service) + def color(self, *args, **kwargs): """ - Sets the target frames per second (FPS) for the saved video file. + Plot hardcopies in color. """ - return PyMenu(self.service, "/solve/animate/playback/video/fps").execute(*args, **kwargs) - def format(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/picture/color_mode/color").execute(*args, **kwargs) + def gray_scale(self, *args, **kwargs): """ - Specifies what format the video file will be written in (MP4 | AVI | FLV | MOV | MPEG). + Convert color to grayscale for hardcopy. """ - return PyMenu(self.service, "/solve/animate/playback/video/format").execute(*args, **kwargs) - def quality(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/picture/color_mode/gray_scale").execute(*args, **kwargs) + def mono_chrome(self, *args, **kwargs): """ - Set quality for exporting video file. + Convert color to monochrome (black and white) for hardcopy. """ - return PyMenu(self.service, "/solve/animate/playback/video/quality").execute(*args, **kwargs) - def name(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/picture/color_mode/mono_chrome").execute(*args, **kwargs) + def list(self, *args, **kwargs): """ - Sets the name of the saved video file. + Display the current hardcopy color mode. """ - return PyMenu(self.service, "/solve/animate/playback/video/name").execute(*args, **kwargs) - def use_original_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/picture/color_mode/list").execute(*args, **kwargs) + + class driver(TUIMenu): + """ + Enter the set hardcopy driver menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.post_format = self.__class__.post_format(path + [("post_format", None)], service) + super().__init__(path, service) + def dump_window(self, *args, **kwargs): """ - Controls whether the resolution of the saved video file matches that of the images used to create it. + Set the command used to dump the graphics window to a file. """ - return PyMenu(self.service, "/solve/animate/playback/video/use_original_resolution").execute(*args, **kwargs) - def scale(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/picture/driver/dump_window").execute(*args, **kwargs) + def eps(self, *args, **kwargs): """ - Expands or collapses the resolution based on this scaling factor. + Produce encapsulated PostScript (EPS) output for hardcopies. """ - return PyMenu(self.service, "/solve/animate/playback/video/scale").execute(*args, **kwargs) - def set_standard_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/picture/driver/eps").execute(*args, **kwargs) + def jpeg(self, *args, **kwargs): """ - Select from pre-defined resolution list. + Produce JPEG output for hardcopies. """ - return PyMenu(self.service, "/solve/animate/playback/video/set_standard_resolution").execute(*args, **kwargs) - def width(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/picture/driver/jpeg").execute(*args, **kwargs) + def post_script(self, *args, **kwargs): """ - Set the width for exporting video file. + Produce PostScript output for hardcopies. """ - return PyMenu(self.service, "/solve/animate/playback/video/width").execute(*args, **kwargs) - def height(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/picture/driver/post_script").execute(*args, **kwargs) + def ppm(self, *args, **kwargs): """ - Set the height for exporting video file. + Produce PPM output for hardcopies. """ - return PyMenu(self.service, "/solve/animate/playback/video/height").execute(*args, **kwargs) + return PyMenu(self.service, "/results/graphics_window/picture/driver/ppm").execute(*args, **kwargs) + def tiff(self, *args, **kwargs): + """ + Use TIFF output for hardcopies. + """ + return PyMenu(self.service, "/results/graphics_window/picture/driver/tiff").execute(*args, **kwargs) + def png(self, *args, **kwargs): + """ + Use PNG output for hardcopies. + """ + return PyMenu(self.service, "/results/graphics_window/picture/driver/png").execute(*args, **kwargs) + def hsf(self, *args, **kwargs): + """ + Use HSF output for hardcopies. + """ + return PyMenu(self.service, "/results/graphics_window/picture/driver/hsf").execute(*args, **kwargs) + def avz(self, *args, **kwargs): + """ + Use AVZ output for hardcopies. + """ + return PyMenu(self.service, "/results/graphics_window/picture/driver/avz").execute(*args, **kwargs) + def glb(self, *args, **kwargs): + """ + Use GLB output for hardcopies. + """ + return PyMenu(self.service, "/results/graphics_window/picture/driver/glb").execute(*args, **kwargs) + def vrml(self, *args, **kwargs): + """ + Use VRML output for hardcopies. + """ + return PyMenu(self.service, "/results/graphics_window/picture/driver/vrml").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + List the current hardcopy driver. + """ + return PyMenu(self.service, "/results/graphics_window/picture/driver/list").execute(*args, **kwargs) + def options(self, *args, **kwargs): + """ + Set the hardcopy options. Available options are: + \\n "no gamma correction", disables gamma correction of colors, + \\n "physical size = (width,height)", where width and height + are the actual measurements of the printable area of the page + in centimeters. + \\n "subscreen = (left,right,bottom,top)", where left,right, + bottom, and top are numbers in [-1,1] describing a subwindow on + the page in which to place the hardcopy. + + \\n The options may be combined by separating them with commas. + """ + return PyMenu(self.service, "/results/graphics_window/picture/driver/options").execute(*args, **kwargs) - class advance_quality(metaclass=PyMenuMeta): + class post_format(TUIMenu): """ - Advance Quality setting. + Enter the PostScript driver format menu. """ def __init__(self, path, service): self.path = path self.service = service - def bitrate_scale(self, *args, **kwargs): - """ - Mp4 bitrate scale - Best-64000 High-32000 Medium-16000 Low-8000. - """ - return PyMenu(self.service, "/solve/animate/playback/video/advance_quality/bitrate_scale").execute(*args, **kwargs) - def enable_h264(self, *args, **kwargs): + super().__init__(path, service) + def fast_raster(self, *args, **kwargs): """ - H264 encoding flag. + Use the new raster format. """ - return PyMenu(self.service, "/solve/animate/playback/video/advance_quality/enable_h264").execute(*args, **kwargs) - def bitrate(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/picture/driver/post_format/fast_raster").execute(*args, **kwargs) + def raster(self, *args, **kwargs): """ - Set video bitrate(kbits/sec) for exporting video file. + Use the original raster format. """ - return PyMenu(self.service, "/solve/animate/playback/video/advance_quality/bitrate").execute(*args, **kwargs) - def compression_method(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/picture/driver/post_format/raster").execute(*args, **kwargs) + def rle_raster(self, *args, **kwargs): """ - Compression methode for Microsoft AVI movie. + Use the run-length encoded raster format. """ - return PyMenu(self.service, "/solve/animate/playback/video/advance_quality/compression_method").execute(*args, **kwargs) - def keyframe(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/picture/driver/post_format/rle_raster").execute(*args, **kwargs) + def vector(self, *args, **kwargs): """ - Set video keyframe rate for exporting video file. + Use vector format. """ - return PyMenu(self.service, "/solve/animate/playback/video/advance_quality/keyframe").execute(*args, **kwargs) + return PyMenu(self.service, "/results/graphics_window/picture/driver/post_format/vector").execute(*args, **kwargs) - class objects(metaclass=PyMenuMeta): + class windows(TUIMenu): """ - Enters the object manipulation menu. + Enter the window options menu. """ def __init__(self, path, service): self.path = path self.service = service - def create(self, *args, **kwargs): - """ - Creates new solution animation object. - """ - return PyMenu(self.service, "/solve/animate/objects/create").execute(*args, **kwargs) - def edit(self, *args, **kwargs): + self.axes = self.__class__.axes(path + [("axes", None)], service) + self.main = self.__class__.main(path + [("main", None)], service) + self.scale = self.__class__.scale(path + [("scale", None)], service) + self.text = self.__class__.text(path + [("text", None)], service) + self.video = self.__class__.video(path + [("video", None)], service) + self.xy = self.__class__.xy(path + [("xy", None)], service) + super().__init__(path, service) + def aspect_ratio(self, *args, **kwargs): """ - Edits solution animation object. + Set the aspect ratio of the active window. """ - return PyMenu(self.service, "/solve/animate/objects/edit").execute(*args, **kwargs) - def copy(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/windows/aspect_ratio").execute(*args, **kwargs) + def logo(self, *args, **kwargs): """ - Copies solution animation object. + Enable/disable visibility of the logo in graphics window. """ - return PyMenu(self.service, "/solve/animate/objects/copy").execute(*args, **kwargs) - def delete(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/windows/logo").execute(*args, **kwargs) + def ruler(self, *args, **kwargs): """ - Deletes solution animation object. + Enable/disable ruler visibility. """ - return PyMenu(self.service, "/solve/animate/objects/delete").execute(*args, **kwargs) - def clear_history(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/windows/ruler").execute(*args, **kwargs) + def logo_color(self, *args, **kwargs): """ - Clears solution animation object history. + Set logo color to white/black. """ - return PyMenu(self.service, "/solve/animate/objects/clear_history").execute(*args, **kwargs) + return PyMenu(self.service, "/results/graphics_window/windows/logo_color").execute(*args, **kwargs) - class pulse(metaclass=PyMenuMeta): - """ - Enter the pulse animation menu (only available when one or more particle track or pathline graphics objects are defined). - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.video = self.__class__.video(path + [("video", None)], service) - self.hardcopy = self.__class__.hardcopy(path + [("hardcopy", None)], service) - def pulse_mode(self, *args, **kwargs): + class axes(TUIMenu): """ - Set whether the pulse is a single pulse or continuous. + Enter the axes window options menu. """ - return PyMenu(self.service, "/solve/animate/pulse/pulse_mode").execute(*args, **kwargs) - def write(self, *args, **kwargs): + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def border(self, *args, **kwargs): + """ + Enable/disable drawing of a border around the axes window. + """ + return PyMenu(self.service, "/results/graphics_window/windows/axes/border").execute(*args, **kwargs) + def bottom(self, *args, **kwargs): + """ + Set the bottom boundary of the axes window. + """ + return PyMenu(self.service, "/results/graphics_window/windows/axes/bottom").execute(*args, **kwargs) + def clear(self, *args, **kwargs): + """ + Set the transparency of the axes window. + """ + return PyMenu(self.service, "/results/graphics_window/windows/axes/clear").execute(*args, **kwargs) + def right(self, *args, **kwargs): + """ + Set the right boundary of the axes window. + """ + return PyMenu(self.service, "/results/graphics_window/windows/axes/right").execute(*args, **kwargs) + def visible(self, *args, **kwargs): + """ + Enable/disable axes visibility. + """ + return PyMenu(self.service, "/results/graphics_window/windows/axes/visible").execute(*args, **kwargs) + + class main(TUIMenu): """ - Select a pathline or particle track graphics object, specify whether you want to write a video file or picture files, and enter the destination directory for the files. Continuous pulse animations result in a 5 second video. Single pulse animations run for a full cycle. + Enter the main view window options menu. """ - return PyMenu(self.service, "/solve/animate/pulse/write").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def border(self, *args, **kwargs): + """ + Enable/disable drawing of borders around the main viewing window. + """ + return PyMenu(self.service, "/results/graphics_window/windows/main/border").execute(*args, **kwargs) + def bottom(self, *args, **kwargs): + """ + Set the bottom boundary of the main viewing window. + """ + return PyMenu(self.service, "/results/graphics_window/windows/main/bottom").execute(*args, **kwargs) + def left(self, *args, **kwargs): + """ + Set the left boundary of the main viewing window. + """ + return PyMenu(self.service, "/results/graphics_window/windows/main/left").execute(*args, **kwargs) + def right(self, *args, **kwargs): + """ + Set the right boundary of the main viewing window. + """ + return PyMenu(self.service, "/results/graphics_window/windows/main/right").execute(*args, **kwargs) + def top(self, *args, **kwargs): + """ + Set the top boundary of the main viewing window. + """ + return PyMenu(self.service, "/results/graphics_window/windows/main/top").execute(*args, **kwargs) + def visible(self, *args, **kwargs): + """ + Enable/disable visibility of the main viewing window. + """ + return PyMenu(self.service, "/results/graphics_window/windows/main/visible").execute(*args, **kwargs) - class video(metaclass=PyMenuMeta): + class scale(TUIMenu): """ - Enter the video window options menu. + Enter the color scale window options menu. """ def __init__(self, path, service): self.path = path self.service = service - self.advance_quality = self.__class__.advance_quality(path + [("advance_quality", None)], service) - def fps(self, *args, **kwargs): + super().__init__(path, service) + def border(self, *args, **kwargs): """ - Set the Frame Per Sec(FPS) for exporting video file. + Enable/disable drawing of borders around the color scale window. """ - return PyMenu(self.service, "/solve/animate/pulse/video/fps").execute(*args, **kwargs) + return PyMenu(self.service, "/results/graphics_window/windows/scale/border").execute(*args, **kwargs) + def bottom(self, *args, **kwargs): + """ + Set the bottom boundary of the color scale window. + """ + return PyMenu(self.service, "/results/graphics_window/windows/scale/bottom").execute(*args, **kwargs) + def clear(self, *args, **kwargs): + """ + Set the transparency of the scale window. + """ + return PyMenu(self.service, "/results/graphics_window/windows/scale/clear").execute(*args, **kwargs) def format(self, *args, **kwargs): """ - Set format for exporting video file. + Set the number format of the color scale window (e.g. %0.2e). """ - return PyMenu(self.service, "/solve/animate/pulse/video/format").execute(*args, **kwargs) - def quality(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/windows/scale/format").execute(*args, **kwargs) + def font_size(self, *args, **kwargs): """ - Set quality for exporting video file. + Set the font size of the color scale window. """ - return PyMenu(self.service, "/solve/animate/pulse/video/quality").execute(*args, **kwargs) - def name(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/windows/scale/font_size").execute(*args, **kwargs) + def left(self, *args, **kwargs): """ - Exporting video file name. + Set the left boundary of the color scale window. """ - return PyMenu(self.service, "/solve/animate/pulse/video/name").execute(*args, **kwargs) - def use_original_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/windows/scale/left").execute(*args, **kwargs) + def margin(self, *args, **kwargs): """ - Enable original resolution. + Set the margin of the color scale window. """ - return PyMenu(self.service, "/solve/animate/pulse/video/use_original_resolution").execute(*args, **kwargs) - def scale(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/windows/scale/margin").execute(*args, **kwargs) + def right(self, *args, **kwargs): """ - Set scale by which video resolution will expand. + Set the right boundary of the color scale window. """ - return PyMenu(self.service, "/solve/animate/pulse/video/scale").execute(*args, **kwargs) - def set_standard_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/windows/scale/right").execute(*args, **kwargs) + def top(self, *args, **kwargs): """ - Select from pre-defined resolution list. + Set the top boundary of the color scale window. """ - return PyMenu(self.service, "/solve/animate/pulse/video/set_standard_resolution").execute(*args, **kwargs) - def width(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/windows/scale/top").execute(*args, **kwargs) + def visible(self, *args, **kwargs): + """ + Enable/disable visibility of the color scale window. + """ + return PyMenu(self.service, "/results/graphics_window/windows/scale/visible").execute(*args, **kwargs) + def alignment(self, *args, **kwargs): + """ + Set colormap to bottom/left/top/right. + """ + return PyMenu(self.service, "/results/graphics_window/windows/scale/alignment").execute(*args, **kwargs) + + class text(TUIMenu): + """ + Enter the text window options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def application(self, *args, **kwargs): + """ + Enable/disable the application name in the picture. + """ + return PyMenu(self.service, "/results/graphics_window/windows/text/application").execute(*args, **kwargs) + def border(self, *args, **kwargs): + """ + Enable/disable drawing of borders around the text window. + """ + return PyMenu(self.service, "/results/graphics_window/windows/text/border").execute(*args, **kwargs) + def bottom(self, *args, **kwargs): + """ + Set the bottom boundary of the text window. + """ + return PyMenu(self.service, "/results/graphics_window/windows/text/bottom").execute(*args, **kwargs) + def clear(self, *args, **kwargs): + """ + Enable/disable text window transparency. + """ + return PyMenu(self.service, "/results/graphics_window/windows/text/clear").execute(*args, **kwargs) + def company(self, *args, **kwargs): + """ + Enable/disable the company name in the picture. + """ + return PyMenu(self.service, "/results/graphics_window/windows/text/company").execute(*args, **kwargs) + def date(self, *args, **kwargs): + """ + Enable/disable the date in the picture. + """ + return PyMenu(self.service, "/results/graphics_window/windows/text/date").execute(*args, **kwargs) + def left(self, *args, **kwargs): + """ + Set the left boundary of the text window. """ - Set the width for exporting video file. + return PyMenu(self.service, "/results/graphics_window/windows/text/left").execute(*args, **kwargs) + def right(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/animate/pulse/video/width").execute(*args, **kwargs) - def height(self, *args, **kwargs): + Set the right boundary of the text window. """ - Set the height for exporting video file. + return PyMenu(self.service, "/results/graphics_window/windows/text/right").execute(*args, **kwargs) + def top(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/animate/pulse/video/height").execute(*args, **kwargs) - - class advance_quality(metaclass=PyMenuMeta): + Set the top boundary of the text window. """ - Advance Quality setting. + return PyMenu(self.service, "/results/graphics_window/windows/text/top").execute(*args, **kwargs) + def visible(self, *args, **kwargs): """ - def __init__(self, path, service): - self.path = path - self.service = service - def bitrate_scale(self, *args, **kwargs): - """ - Mp4 bitrate scale - Best-64000 High-32000 Medium-16000 Low-8000. - """ - return PyMenu(self.service, "/solve/animate/pulse/video/advance_quality/bitrate_scale").execute(*args, **kwargs) - def enable_h264(self, *args, **kwargs): - """ - H264 encoding flag. - """ - return PyMenu(self.service, "/solve/animate/pulse/video/advance_quality/enable_h264").execute(*args, **kwargs) - def bitrate(self, *args, **kwargs): - """ - Set video bitrate(kbits/sec) for exporting video file. - """ - return PyMenu(self.service, "/solve/animate/pulse/video/advance_quality/bitrate").execute(*args, **kwargs) - def compression_method(self, *args, **kwargs): - """ - Compression methode for Microsoft AVI movie. - """ - return PyMenu(self.service, "/solve/animate/pulse/video/advance_quality/compression_method").execute(*args, **kwargs) - def keyframe(self, *args, **kwargs): - """ - Set video keyframe rate for exporting video file. - """ - return PyMenu(self.service, "/solve/animate/pulse/video/advance_quality/keyframe").execute(*args, **kwargs) + Enable/disable text window transparency. + """ + return PyMenu(self.service, "/results/graphics_window/windows/text/visible").execute(*args, **kwargs) - class hardcopy(metaclass=PyMenuMeta): + class video(TUIMenu): """ - Hardcopy options menu. + Enter the video window options menu. """ def __init__(self, path, service): self.path = path self.service = service - self.color_mode = self.__class__.color_mode(path + [("color_mode", None)], service) - self.driver = self.__class__.driver(path + [("driver", None)], service) - def invert_background(self, *args, **kwargs): + super().__init__(path, service) + def background(self, *args, **kwargs): """ - Use a white background when the picture is saved. + Set the background color in the video picture. """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/invert_background").execute(*args, **kwargs) - def landscape(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/windows/video/background").execute(*args, **kwargs) + def color_filter(self, *args, **kwargs): """ - Plot hardcopies in landscape or portrait orientation. + Set the color filter options for the picture. """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/landscape").execute(*args, **kwargs) - def preview(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/windows/video/color_filter").execute(*args, **kwargs) + def foreground(self, *args, **kwargs): """ - Display a preview image of a hardcopy. + Set the foreground color in the video picture. """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/preview").execute(*args, **kwargs) - def x_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/windows/video/foreground").execute(*args, **kwargs) + def on(self, *args, **kwargs): """ - Set the width of raster-formatted images in pixels (0 implies current window size). + Enable/disable video picture settings. """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/x_resolution").execute(*args, **kwargs) - def y_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/windows/video/on").execute(*args, **kwargs) + def pixel_size(self, *args, **kwargs): """ - Set the height of raster-formatted images in pixels (0 implies current window size). + Set the window size in pixels. """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/y_resolution").execute(*args, **kwargs) - def dpi(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/windows/video/pixel_size").execute(*args, **kwargs) + + class xy(TUIMenu): + """ + Enter the X-Y plot window options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def border(self, *args, **kwargs): """ - Set the DPI for EPS and Postscript files, specifies the resolution in dots per inch (DPI) instead of setting the width and height. + Enable/disable drawing of a border around the X-Y plotter window. """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/dpi").execute(*args, **kwargs) - def use_window_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/windows/xy/border").execute(*args, **kwargs) + def bottom(self, *args, **kwargs): """ - Use the currently active window's resolution for hardcopy (ignores the x-resolution and y-resolution in this case). + Set the bottom boundary of the X-Y plotter window. """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/use_window_resolution").execute(*args, **kwargs) - def set_standard_resolution(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/windows/xy/bottom").execute(*args, **kwargs) + def left(self, *args, **kwargs): """ - Select from pre-defined resolution list. + Set the left boundary of the X-Y plotter window. """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/set_standard_resolution").execute(*args, **kwargs) - def jpeg_hardcopy_quality(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/windows/xy/left").execute(*args, **kwargs) + def right(self, *args, **kwargs): """ - To set jpeg hardcopy quality. + Set the right boundary of the X-Y plotter window. """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/jpeg_hardcopy_quality").execute(*args, **kwargs) - - class color_mode(metaclass=PyMenuMeta): + return PyMenu(self.service, "/results/graphics_window/windows/xy/right").execute(*args, **kwargs) + def top(self, *args, **kwargs): """ - Enter the hardcopy color mode menu. + Set the top boundary of the X-Y plotter window. """ - def __init__(self, path, service): - self.path = path - self.service = service - def color(self, *args, **kwargs): - """ - Plot hardcopies in color. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/color_mode/color").execute(*args, **kwargs) - def gray_scale(self, *args, **kwargs): - """ - Convert color to grayscale for hardcopy. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/color_mode/gray_scale").execute(*args, **kwargs) - def mono_chrome(self, *args, **kwargs): - """ - Convert color to monochrome (black and white) for hardcopy. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/color_mode/mono_chrome").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Display the current hardcopy color mode. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/color_mode/list").execute(*args, **kwargs) - - class driver(metaclass=PyMenuMeta): + return PyMenu(self.service, "/results/graphics_window/windows/xy/top").execute(*args, **kwargs) + def visible(self, *args, **kwargs): """ - Enter the set hardcopy driver menu. + Enable/disable X-Y plotter window visibility. """ - def __init__(self, path, service): - self.path = path - self.service = service - self.post_format = self.__class__.post_format(path + [("post_format", None)], service) - def dump_window(self, *args, **kwargs): - """ - Set the command used to dump the graphics window to a file. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/dump_window").execute(*args, **kwargs) - def eps(self, *args, **kwargs): - """ - Produce encapsulated PostScript (EPS) output for hardcopies. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/eps").execute(*args, **kwargs) - def jpeg(self, *args, **kwargs): - """ - Produce JPEG output for hardcopies. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/jpeg").execute(*args, **kwargs) - def post_script(self, *args, **kwargs): - """ - Produce PostScript output for hardcopies. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/post_script").execute(*args, **kwargs) - def ppm(self, *args, **kwargs): - """ - Produce PPM output for hardcopies. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/ppm").execute(*args, **kwargs) - def tiff(self, *args, **kwargs): - """ - Use TIFF output for hardcopies. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/tiff").execute(*args, **kwargs) - def png(self, *args, **kwargs): - """ - Use PNG output for hardcopies. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/png").execute(*args, **kwargs) - def hsf(self, *args, **kwargs): - """ - Use HSF output for hardcopies. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/hsf").execute(*args, **kwargs) - def avz(self, *args, **kwargs): - """ - Use AVZ output for hardcopies. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/avz").execute(*args, **kwargs) - def glb(self, *args, **kwargs): - """ - Use GLB output for hardcopies. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/glb").execute(*args, **kwargs) - def vrml(self, *args, **kwargs): - """ - Use VRML output for hardcopies. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/vrml").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - List the current hardcopy driver. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/list").execute(*args, **kwargs) - def options(self, *args, **kwargs): - """ - Set the hardcopy options. Available options are: - \\n "no gamma correction", disables gamma correction of colors, - \\n "physical size = (width,height)", where width and height - are the actual measurements of the printable area of the page - in centimeters. - \\n "subscreen = (left,right,bottom,top)", where left,right, - bottom, and top are numbers in [-1,1] describing a subwindow on - the page in which to place the hardcopy. - - \\n The options may be combined by separating them with commas. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/options").execute(*args, **kwargs) - - class post_format(metaclass=PyMenuMeta): - """ - Enter the PostScript driver format menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def fast_raster(self, *args, **kwargs): - """ - Use the new raster format. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/post_format/fast_raster").execute(*args, **kwargs) - def raster(self, *args, **kwargs): - """ - Use the original raster format. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/post_format/raster").execute(*args, **kwargs) - def rle_raster(self, *args, **kwargs): - """ - Use the run-length encoded raster format. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/post_format/rle_raster").execute(*args, **kwargs) - def vector(self, *args, **kwargs): - """ - Use vector format. - """ - return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/post_format/vector").execute(*args, **kwargs) - - class initialize(metaclass=PyMenuMeta): - """ - Enters the flow initialization menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.compute_defaults = self.__class__.compute_defaults(path + [("compute_defaults", None)], service) - self.mp_localized_turb_init = self.__class__.mp_localized_turb_init(path + [("mp_localized_turb_init", None)], service) - self.vof_patch_smooth_options = self.__class__.vof_patch_smooth_options(path + [("vof_patch_smooth_options", None)], service) - self.set_fmg_options = self.__class__.set_fmg_options(path + [("set_fmg_options", None)], service) - self.set_hyb_initialization = self.__class__.set_hyb_initialization(path + [("set_hyb_initialization", None)], service) - def open_channel_auto_init(self, *args, **kwargs): - """ - Opens channel automatic initialization. - """ - return PyMenu(self.service, "/solve/initialize/open_channel_auto_init").execute(*args, **kwargs) - def levelset_auto_init(self, *args, **kwargs): - """ - Levelset function automatic initialization. - """ - return PyMenu(self.service, "/solve/initialize/levelset_auto_init").execute(*args, **kwargs) - def dpm_reset(self, *args, **kwargs): - """ - Resets discrete phase source terms to zero. - """ - return PyMenu(self.service, "/solve/initialize/dpm_reset").execute(*args, **kwargs) - def lwf_initialization(self, *args, **kwargs): - """ - Deletes wall film particles and initializes wall film variables to zero. This option is available only with the wall-film DPM boundary condition. - """ - return PyMenu(self.service, "/solve/initialize/lwf_initialization").execute(*args, **kwargs) - def initialize_flow(self, *args, **kwargs): - """ - Initializes the flow field with the current default values. - """ - return PyMenu(self.service, "/solve/initialize/initialize_flow").execute(*args, **kwargs) - def init_acoustics_options(self, *args, **kwargs): - """ - Specifies the number of timesteps for ramping of sound sources and re-initializes the acoustics wave equation solution. For the initialized acoustics solution, Fluent reports the current state of the sound sources ramping. - """ - return PyMenu(self.service, "/solve/initialize/init_acoustics_options").execute(*args, **kwargs) - def hyb_initialization(self, *args, **kwargs): - """ - Initializes using the hybrid initialization method. - """ - return PyMenu(self.service, "/solve/initialize/hyb_initialization").execute(*args, **kwargs) - def init_flow_statistics(self, *args, **kwargs): - """ - Initializes unsteady statistics. - """ - return PyMenu(self.service, "/solve/initialize/init_flow_statistics").execute(*args, **kwargs) - def patch(self, *args, **kwargs): - """ - Patch a value for a flow variable in the domain. - """ - return PyMenu(self.service, "/solve/initialize/patch").execute(*args, **kwargs) - def show_time_sampled(self, *args, **kwargs): - """ - Displays the amount of simulated time covered by the data sampled for unsteady statistics. - """ - return PyMenu(self.service, "/solve/initialize/show_time_sampled").execute(*args, **kwargs) - def show_iterations_sampled(self, *args, **kwargs): - """ - Displays the number of iterations covered by the data sampled for steady statistics. - """ - return PyMenu(self.service, "/solve/initialize/show_iterations_sampled").execute(*args, **kwargs) - def init_turb_vel_fluctuations(self, *args, **kwargs): - """ - Initializes instantaneous velocity field out of steady state RANS results, for use before enabling a scale resolving simulation such as LES. - """ - return PyMenu(self.service, "/solve/initialize/init_turb_vel_fluctuations").execute(*args, **kwargs) - def fmg_initialization(self, *args, **kwargs): - """ - Initializes using the full-multigrid initialization (FMG). - """ - return PyMenu(self.service, "/solve/initialize/fmg_initialization").execute(*args, **kwargs) - def repair_wall_distance(self, *args, **kwargs): - """ - Corrects wall distance at very high aspect ratio hexahedral/polyhedral cells. - """ - return PyMenu(self.service, "/solve/initialize/repair_wall_distance").execute(*args, **kwargs) - def set_defaults(self, *args, **kwargs): - """ - Sets default initial values. - """ - return PyMenu(self.service, "/solve/initialize/set_defaults").execute(*args, **kwargs) - def set_fmg_initialization(self, *args, **kwargs): - """ - Enters the set full-multigrid for initialization menu. Initial values for each variable can be set within this menu. - """ - return PyMenu(self.service, "/solve/initialize/set_fmg_initialization").execute(*args, **kwargs) - def list_defaults(self, *args, **kwargs): - """ - Lists default values. - """ - return PyMenu(self.service, "/solve/initialize/list_defaults").execute(*args, **kwargs) - def reference_frame(self, *args, **kwargs): - """ - Sets reference frame to absolute or relative. - """ - return PyMenu(self.service, "/solve/initialize/reference_frame").execute(*args, **kwargs) + return PyMenu(self.service, "/results/graphics_window/windows/xy/visible").execute(*args, **kwargs) - class compute_defaults(metaclass=PyMenuMeta): + class titles(TUIMenu): """ - Enters the compute default values menu. + Set problem title. """ def __init__(self, path, service): self.path = path self.service = service - def axis(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/axis").execute(*args, **kwargs) - def degassing(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/degassing").execute(*args, **kwargs) - def dummy_entry(self, *args, **kwargs): - """ - . - """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/dummy_entry").execute(*args, **kwargs) - def all_zones(self, *args, **kwargs): - """ - Initializes the flow field with the default values. - """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/all_zones").execute(*args, **kwargs) - def exhaust_fan(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/exhaust_fan").execute(*args, **kwargs) - def fan(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/fan").execute(*args, **kwargs) - def fluid(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/fluid").execute(*args, **kwargs) - def geometry(self, *args, **kwargs): - """ - Compute flow-initialization defaults from a zone of this type. - """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/geometry").execute(*args, **kwargs) - def inlet_vent(self, *args, **kwargs): + super().__init__(path, service) + def left_top(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Set the title text for left top in title segment. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/inlet_vent").execute(*args, **kwargs) - def intake_fan(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/titles/left_top").execute(*args, **kwargs) + def left_bottom(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Set the title text for left bottom in title segment. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/intake_fan").execute(*args, **kwargs) - def interface(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/titles/left_bottom").execute(*args, **kwargs) + def right_top(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Set the title text for right top in title segment. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/interface").execute(*args, **kwargs) - def interior(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/titles/right_top").execute(*args, **kwargs) + def right_middle(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Set the title text for right middle in title segment. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/interior").execute(*args, **kwargs) - def mass_flow_inlet(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/titles/right_middle").execute(*args, **kwargs) + def right_bottom(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Set the title text for right bottom in title segment. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/mass_flow_inlet").execute(*args, **kwargs) - def mass_flow_outlet(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/titles/right_bottom").execute(*args, **kwargs) + + class views(TUIMenu): + """ + Enter the view manipulation menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.camera = self.__class__.camera(path + [("camera", None)], service) + super().__init__(path, service) + def auto_scale(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Scale and center the current scene. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/mass_flow_outlet").execute(*args, **kwargs) - def network(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/views/auto_scale").execute(*args, **kwargs) + def default_view(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Reset view to front and center. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/network").execute(*args, **kwargs) - def network_end(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/views/default_view").execute(*args, **kwargs) + def delete_view(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Remove a view from the list. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/network_end").execute(*args, **kwargs) - def outflow(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/views/delete_view").execute(*args, **kwargs) + def last_view(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Return to the camera position before the last manipulation. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/outflow").execute(*args, **kwargs) - def outlet_vent(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/views/last_view").execute(*args, **kwargs) + def next_view(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Return to the camera position after the current position in the stack. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/outlet_vent").execute(*args, **kwargs) - def overset(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/views/next_view").execute(*args, **kwargs) + def list_views(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + List predefined and saved views. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/overset").execute(*args, **kwargs) - def periodic(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/views/list_views").execute(*args, **kwargs) + def restore_view(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Use a saved view. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/periodic").execute(*args, **kwargs) - def porous_jump(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/views/restore_view").execute(*args, **kwargs) + def read_views(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Read views from a view file. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/porous_jump").execute(*args, **kwargs) - def pressure_far_field(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/views/read_views").execute(*args, **kwargs) + def save_view(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Save the current view to the view list. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/pressure_far_field").execute(*args, **kwargs) - def pressure_inlet(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/views/save_view").execute(*args, **kwargs) + def write_views(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Write selected views to a view file. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/pressure_inlet").execute(*args, **kwargs) - def pressure_outlet(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/views/write_views").execute(*args, **kwargs) + + class camera(TUIMenu): """ - Compute flow-initialization defaults from a zone of this type. + Enter the camera menu to modify the current viewing parameters. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/pressure_outlet").execute(*args, **kwargs) - def radiator(self, *args, **kwargs): + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def dolly_camera(self, *args, **kwargs): + """ + Adjust the camera position and target. + """ + return PyMenu(self.service, "/results/graphics_window/views/camera/dolly_camera").execute(*args, **kwargs) + def field(self, *args, **kwargs): + """ + Set the field of view (width and height). + """ + return PyMenu(self.service, "/results/graphics_window/views/camera/field").execute(*args, **kwargs) + def orbit_camera(self, *args, **kwargs): + """ + Adjust the camera position without modifying the target. + """ + return PyMenu(self.service, "/results/graphics_window/views/camera/orbit_camera").execute(*args, **kwargs) + def pan_camera(self, *args, **kwargs): + """ + Adjust the camera target without modifying the position. + """ + return PyMenu(self.service, "/results/graphics_window/views/camera/pan_camera").execute(*args, **kwargs) + def position(self, *args, **kwargs): + """ + Set the camera position. + """ + return PyMenu(self.service, "/results/graphics_window/views/camera/position").execute(*args, **kwargs) + def projection(self, *args, **kwargs): + """ + Set the camera projection type. + """ + return PyMenu(self.service, "/results/graphics_window/views/camera/projection").execute(*args, **kwargs) + def roll_camera(self, *args, **kwargs): + """ + Adjust the camera up-vector. + """ + return PyMenu(self.service, "/results/graphics_window/views/camera/roll_camera").execute(*args, **kwargs) + def target(self, *args, **kwargs): + """ + Set the point to be the center of the camera view. + """ + return PyMenu(self.service, "/results/graphics_window/views/camera/target").execute(*args, **kwargs) + def up_vector(self, *args, **kwargs): + """ + Set the camera up-vector. + """ + return PyMenu(self.service, "/results/graphics_window/views/camera/up_vector").execute(*args, **kwargs) + def zoom_camera(self, *args, **kwargs): + """ + Adjust the camera field of view. + """ + return PyMenu(self.service, "/results/graphics_window/views/camera/zoom_camera").execute(*args, **kwargs) + + class display_states(TUIMenu): + """ + Enter the display state manipulation menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def list(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Print the names of the available display states to the console. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/radiator").execute(*args, **kwargs) - def rans_les_interface(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/display_states/list").execute(*args, **kwargs) + def apply(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Apply a display state to the active window. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/rans_les_interface").execute(*args, **kwargs) - def recirculation_inlet(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/display_states/apply").execute(*args, **kwargs) + def delete(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Delete a display state. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/recirculation_inlet").execute(*args, **kwargs) - def recirculation_outlet(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/display_states/delete").execute(*args, **kwargs) + def use_active(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Update an existing display state's settings to match those of the active graphics window. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/recirculation_outlet").execute(*args, **kwargs) - def shadow(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/display_states/use_active").execute(*args, **kwargs) + def copy(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Create a new display state with settings copied from an existing display state. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/shadow").execute(*args, **kwargs) - def solid(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/display_states/copy").execute(*args, **kwargs) + def read(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Read display states from a file. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/solid").execute(*args, **kwargs) - def symmetry(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/display_states/read").execute(*args, **kwargs) + def write(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Write display states to a file. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/symmetry").execute(*args, **kwargs) - def velocity_inlet(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/display_states/write").execute(*args, **kwargs) + def edit(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Edit a particular display state setting. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/velocity_inlet").execute(*args, **kwargs) - def wall(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/display_states/edit").execute(*args, **kwargs) + def create(self, *args, **kwargs): """ - Compute flow-initialization defaults from a zone of this type. + Create a new display state. """ - return PyMenu(self.service, "/solve/initialize/compute_defaults/wall").execute(*args, **kwargs) + return PyMenu(self.service, "/results/graphics_window/display_states/create").execute(*args, **kwargs) - class mp_localized_turb_init(metaclass=PyMenuMeta): + class view_sync(TUIMenu): """ - Enters the menu for localized turbulent flow initialization. + Enter the display state manipulation menu. """ def __init__(self, path, service): self.path = path self.service = service - def enable(self, *args, **kwargs): + super().__init__(path, service) + def list(self, *args, **kwargs): """ - Enables/disables localized initialization of turbulent flow variables. + Print window ids of open windows. """ - return PyMenu(self.service, "/solve/initialize/mp_localized_turb_init/enable").execute(*args, **kwargs) - def turb_init_parameters(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/view_sync/list").execute(*args, **kwargs) + def start(self, *args, **kwargs): """ - Sets values for the turbulent intensity and turbulent viscosity ratio for localized initialization. + Start view synchronization. """ - return PyMenu(self.service, "/solve/initialize/mp_localized_turb_init/turb_init_parameters").execute(*args, **kwargs) - - class vof_patch_smooth_options(metaclass=PyMenuMeta): - """ - Enters the vof patch/smooth options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def set_options(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/view_sync/start").execute(*args, **kwargs) + def stop(self, *args, **kwargs): """ - Sets options for patching and smoothing volume fraction. + Stop view synchronization. """ - return PyMenu(self.service, "/solve/initialize/vof_patch_smooth_options/set_options").execute(*args, **kwargs) - def execute_smoothing(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/view_sync/stop").execute(*args, **kwargs) + def remove_all(self, *args, **kwargs): """ - Execute volumetric smoothing for volume fraction. + Unsynchronize all windows. """ - return PyMenu(self.service, "/solve/initialize/vof_patch_smooth_options/execute_smoothing").execute(*args, **kwargs) - - class set_fmg_options(metaclass=PyMenuMeta): - """ - Enter the full-multigrid option menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def viscous_terms(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/view_sync/remove_all").execute(*args, **kwargs) + def add_all(self, *args, **kwargs): """ - Enable/disable viscous terms during FMG initialization. + Synchronize all windows. """ - return PyMenu(self.service, "/solve/initialize/set_fmg_options/viscous_terms").execute(*args, **kwargs) - def species_reactions(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/view_sync/add_all").execute(*args, **kwargs) + def add(self, *args, **kwargs): """ - Enable/disable species volumetric reactions during FMG initialization. + Add list of window ids for synchronization. """ - return PyMenu(self.service, "/solve/initialize/set_fmg_options/species_reactions").execute(*args, **kwargs) - def set_turbulent_viscosity_ratio(self, *args, **kwargs): + return PyMenu(self.service, "/results/graphics_window/view_sync/add").execute(*args, **kwargs) + def remove(self, *args, **kwargs): """ - Set turbulent viscosity ratio used during FMG initialization. + Remove list of window ids from synchronization. """ - return PyMenu(self.service, "/solve/initialize/set_fmg_options/set_turbulent_viscosity_ratio").execute(*args, **kwargs) + return PyMenu(self.service, "/results/graphics_window/view_sync/remove").execute(*args, **kwargs) - class set_hyb_initialization(metaclass=PyMenuMeta): - """ - Enters the hybrid initialization menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def general_settings(self, *args, **kwargs): - """ - Enters the general settings menu. - """ - return PyMenu(self.service, "/solve/initialize/set_hyb_initialization/general_settings").execute(*args, **kwargs) - def turbulent_settings(self, *args, **kwargs): - """ - Enter the turbulent settings menu. - """ - return PyMenu(self.service, "/solve/initialize/set_hyb_initialization/turbulent_settings").execute(*args, **kwargs) - def species_settings(self, *args, **kwargs): - """ - Enters the species-settings menu. - """ - return PyMenu(self.service, "/solve/initialize/set_hyb_initialization/species_settings").execute(*args, **kwargs) + class solution(TUIMenu): + """ + Enter solution menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.calculation_activities = self.__class__.calculation_activities(path + [("calculation_activities", None)], service) + self.cell_registers = self.__class__.cell_registers(path + [("cell_registers", None)], service) + self.controls = self.__class__.controls(path + [("controls", None)], service) + self.expert = self.__class__.expert(path + [("expert", None)], service) + self.initialize = self.__class__.initialize(path + [("initialize", None)], service) + self.methods = self.__class__.methods(path + [("methods", None)], service) + self.monitors = self.__class__.monitors(path + [("monitors", None)], service) + self.report_definitions = self.__class__.report_definitions(path + [("report_definitions", None)], service) + self.run_calculation = self.__class__.run_calculation(path + [("run_calculation", None)], service) + super().__init__(path, service) - class monitors(metaclass=PyMenuMeta): + class calculation_activities(TUIMenu): """ - Sets solution monitors. + Enter calculation activities menu. """ def __init__(self, path, service): self.path = path self.service = service - self._ = self.__class__._(path + [("_", None)], service) - self.__ = self.__class__.__(path + [("__", None)], service) - self.report_files = self.__class__.report_files(path + [("report_files", None)], service) - self.report_plots = self.__class__.report_plots(path + [("report_plots", None)], service) - self.residual = self.__class__.residual(path + [("residual", None)], service) - def convergence_conditions(self, *args, **kwargs): - """ - Manage convergence report. - """ - return PyMenu(self.service, "/solve/monitors/convergence_conditions").execute(*args, **kwargs) - def set_average_over(self, *args, **kwargs): - """ - Set the average over input for monitors. - """ - return PyMenu(self.service, "/solve/monitors/set_average_over").execute(*args, **kwargs) + self.animate = self.__class__.animate(path + [("animate", None)], service) + self.auto_save = self.__class__.auto_save(path + [("auto_save", None)], service) + self.cell_register_operations = self.__class__.cell_register_operations(path + [("cell_register_operations", None)], service) + self.execute_commands = self.__class__.execute_commands(path + [("execute_commands", None)], service) + self.solution_strategy = self.__class__.solution_strategy(path + [("solution_strategy", None)], service) + super().__init__(path, service) - class _(metaclass=PyMenuMeta): + class animate(TUIMenu): """ - Enter the convergence menu to add surface, volume, drag, lift and moment monitors to convergence criteria. + Enter the animation menu. """ def __init__(self, path, service): self.path = path self.service = service - def add_edit(self, *args, **kwargs): - """ - Add or edit convergence criterion for surface, volume, drag, lift and moment monitors. - """ - return PyMenu(self.service, "/solve/monitors/_/add_edit").execute(*args, **kwargs) - def frequency(self, *args, **kwargs): - """ - To set how often convergence checks are done with respect to iterations or time steps. - """ - return PyMenu(self.service, "/solve/monitors/_/frequency").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - List defined convergence criteria for monitors. - """ - return PyMenu(self.service, "/solve/monitors/_/list").execute(*args, **kwargs) - def condition(self, *args, **kwargs): - """ - Option to stop the calculations. All convergence conditions are met or any convergence condition is met. - """ - return PyMenu(self.service, "/solve/monitors/_/condition").execute(*args, **kwargs) - def average_over_last_n_iterations_timesteps(self, *args, **kwargs): + self.define = self.__class__.define(path + [("define", None)], service) + self.objects = self.__class__.objects(path + [("objects", None)], service) + super().__init__(path, service) + + class define(TUIMenu): """ - Option to average over previous values for checking convergence. + Enter the animation definition menu. """ - return PyMenu(self.service, "/solve/monitors/_/average_over_last_n_iterations_timesteps").execute(*args, **kwargs) - def delete(self, *args, **kwargs): + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def define_monitor(self, *args, **kwargs): + """ + Define new animation. + """ + return PyMenu(self.service, "/solution/calculation_activities/animate/define/define_monitor").execute(*args, **kwargs) + def edit_monitor(self, *args, **kwargs): + """ + Change animation monitor attributes. + """ + return PyMenu(self.service, "/solution/calculation_activities/animate/define/edit_monitor").execute(*args, **kwargs) + + class objects(TUIMenu): """ - Delete a monitor from convergence criteria. + Enter to define, edit, delete solution animation objects. """ - return PyMenu(self.service, "/solve/monitors/_/delete").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def create(self, *args, **kwargs): + """ + Create new graphics object. + """ + return PyMenu(self.service, "/solution/calculation_activities/animate/objects/create").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edit graphics object. + """ + return PyMenu(self.service, "/solution/calculation_activities/animate/objects/edit").execute(*args, **kwargs) + def copy(self, *args, **kwargs): + """ + Copy graphics object. + """ + return PyMenu(self.service, "/solution/calculation_activities/animate/objects/copy").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Delete graphics object. + """ + return PyMenu(self.service, "/solution/calculation_activities/animate/objects/delete").execute(*args, **kwargs) + def clear_history(self, *args, **kwargs): + """ + Clear object history. + """ + return PyMenu(self.service, "/solution/calculation_activities/animate/objects/clear_history").execute(*args, **kwargs) - class __(metaclass=PyMenuMeta): + class auto_save(TUIMenu): """ - Enter the statistic monitors menu. + Enter the auto save menu. """ def __init__(self, path, service): self.path = path self.service = service - def monitors(self, *args, **kwargs): + super().__init__(path, service) + def case_frequency(self, *args, **kwargs): """ - Choose which statistics to monitor as printed and/or plotted output. + Set the preference for saving case files. """ - return PyMenu(self.service, "/solve/monitors/__/monitors").execute(*args, **kwargs) - def plot(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/auto_save/case_frequency").execute(*args, **kwargs) + def data_frequency(self, *args, **kwargs): """ - Enable/disable plotting of statistics during iteration. + Set the iteration or time step increment for saving data files. """ - return PyMenu(self.service, "/solve/monitors/__/plot").execute(*args, **kwargs) - def print(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/auto_save/data_frequency").execute(*args, **kwargs) + def root_name(self, *args, **kwargs): """ - Enable/disable printing of statistics during iteration. + Set the root name for auto-saved files. The number of iterations or time steps will be appended to this root name. """ - return PyMenu(self.service, "/solve/monitors/__/print").execute(*args, **kwargs) - def write(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/auto_save/root_name").execute(*args, **kwargs) + def retain_most_recent_files(self, *args, **kwargs): """ - Enable/disable writing of statistics during iteration. + After the maximum (as in max-files) is reached, a file will be deleted for each file saved. """ - return PyMenu(self.service, "/solve/monitors/__/write").execute(*args, **kwargs) - def window(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/auto_save/retain_most_recent_files").execute(*args, **kwargs) + def max_files(self, *args, **kwargs): """ - Specify first window in which statistics will be plotted during iteration. - Multiple statistics are plotted in separate windows, beginning with this one. + Set the maximum number of data files to save. After the maximum is reached, a file will be deleted for each file saved. """ - return PyMenu(self.service, "/solve/monitors/__/window").execute(*args, **kwargs) - def file_basename(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/auto_save/max_files").execute(*args, **kwargs) + def append_file_name_with(self, *args, **kwargs): """ - Specify the file basename and extension. The name of the individual monitor will be insterted automatically. + Set the suffix for auto-saved files. The file name can be appended by flow-time, time-step value or by user specified flags in file name. """ - return PyMenu(self.service, "/solve/monitors/__/file_basename").execute(*args, **kwargs) - def x_axis(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/auto_save/append_file_name_with").execute(*args, **kwargs) + def save_data_file_every(self, *args, **kwargs): """ - Choose what quantity to use on the abscissa in the plot and in the data written to files. + Set the auto save frequency type to either time-step or crank-angle and set the corresponding frequency. """ - return PyMenu(self.service, "/solve/monitors/__/x_axis").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/calculation_activities/auto_save/save_data_file_every").execute(*args, **kwargs) - class report_files(metaclass=PyMenuMeta): + class cell_register_operations(TUIMenu): """ - Manage report files. + Manage Cell Register Operations. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def add(self, *args, **kwargs): """ Add a new object. """ - return PyMenu(self.service, "/solve/monitors/report_files/add").execute(*args, **kwargs) - def clear_data(self, *args, **kwargs): - """ - Delete the report file from the system. - """ - return PyMenu(self.service, "/solve/monitors/report_files/clear_data").execute(*args, **kwargs) - def delete_all(self, *args, **kwargs): - """ - Delete all report file objects. - """ - return PyMenu(self.service, "/solve/monitors/report_files/delete_all").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/calculation_activities/cell_register_operations/add").execute(*args, **kwargs) def edit(self, *args, **kwargs): """ Edit an object. """ - return PyMenu(self.service, "/solve/monitors/report_files/edit").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/calculation_activities/cell_register_operations/edit").execute(*args, **kwargs) def delete(self, *args, **kwargs): """ Delete an object. """ - return PyMenu(self.service, "/solve/monitors/report_files/delete").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/calculation_activities/cell_register_operations/delete").execute(*args, **kwargs) def list(self, *args, **kwargs): """ List objects. """ - return PyMenu(self.service, "/solve/monitors/report_files/list").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/calculation_activities/cell_register_operations/list").execute(*args, **kwargs) def list_properties(self, *args, **kwargs): """ List properties of an object. """ - return PyMenu(self.service, "/solve/monitors/report_files/list_properties").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/calculation_activities/cell_register_operations/list_properties").execute(*args, **kwargs) - class report_plots(metaclass=PyMenuMeta): + class execute_commands(TUIMenu): """ - Manage report plots. + Enter the execute-monitor-commands menu. """ def __init__(self, path, service): self.path = path self.service = service - def add(self, *args, **kwargs): - """ - Add a new object. - """ - return PyMenu(self.service, "/solve/monitors/report_plots/add").execute(*args, **kwargs) - def axes(self, *args, **kwargs): - """ - Set axes options of an object. - """ - return PyMenu(self.service, "/solve/monitors/report_plots/axes").execute(*args, **kwargs) - def clear_data(self, *args, **kwargs): + super().__init__(path, service) + def add_edit(self, *args, **kwargs): """ - Clear report plot data. + Add or edit execute-commands. """ - return PyMenu(self.service, "/solve/monitors/report_plots/clear_data").execute(*args, **kwargs) - def curves(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/execute_commands/add_edit").execute(*args, **kwargs) + def enable(self, *args, **kwargs): """ - Set curves options of an object. + Enable an execute-command. """ - return PyMenu(self.service, "/solve/monitors/report_plots/curves").execute(*args, **kwargs) - def delete_all(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/execute_commands/enable").execute(*args, **kwargs) + def disable(self, *args, **kwargs): """ - Delete all plot objects. + Disable an execute-command. """ - return PyMenu(self.service, "/solve/monitors/report_plots/delete_all").execute(*args, **kwargs) - def edit(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/execute_commands/disable").execute(*args, **kwargs) + def copy(self, *args, **kwargs): """ - Edit an object. + Copy an execute-command. """ - return PyMenu(self.service, "/solve/monitors/report_plots/edit").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/calculation_activities/execute_commands/copy").execute(*args, **kwargs) def delete(self, *args, **kwargs): """ - Delete an object. - """ - return PyMenu(self.service, "/solve/monitors/report_plots/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - List objects. + Delete an execute-command. """ - return PyMenu(self.service, "/solve/monitors/report_plots/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/execute_commands/delete").execute(*args, **kwargs) + def export(self, *args, **kwargs): """ - List properties of an object. + Export execute-commands to a TSV file. """ - return PyMenu(self.service, "/solve/monitors/report_plots/list_properties").execute(*args, **kwargs) - def plot(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/execute_commands/export").execute(*args, **kwargs) + def import_(self, *args, **kwargs): """ - Plot. + Import execute-commands from a TSV file. """ - return PyMenu(self.service, "/solve/monitors/report_plots/plot").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/calculation_activities/execute_commands/import").execute(*args, **kwargs) - class residual(metaclass=PyMenuMeta): + class solution_strategy(TUIMenu): """ - Enters the residual monitors menu. + Enter the automatic initialization and case modification strategy menu. """ def __init__(self, path, service): self.path = path self.service = service - def check_convergence(self, *args, **kwargs): - """ - Chooses which currently monitored residuals should be checked for convergence. - """ - return PyMenu(self.service, "/solve/monitors/residual/check_convergence").execute(*args, **kwargs) - def convergence_criteria(self, *args, **kwargs): - """ - Sets convergence criteria for residuals that are currently being both monitored and checked. - """ - return PyMenu(self.service, "/solve/monitors/residual/convergence_criteria").execute(*args, **kwargs) - def criterion_type(self, *args, **kwargs): - """ - Sets convergence criterion type. - """ - return PyMenu(self.service, "/solve/monitors/residual/criterion_type").execute(*args, **kwargs) - def monitor(self, *args, **kwargs): - """ - Chooses which residuals to monitor as printed and/or plotted output. - """ - return PyMenu(self.service, "/solve/monitors/residual/monitor").execute(*args, **kwargs) - def enhanced_continuity_residual(self, *args, **kwargs): + self.automatic_case_modification = self.__class__.automatic_case_modification(path + [("automatic_case_modification", None)], service) + super().__init__(path, service) + def enable_strategy(self, *args, **kwargs): """ - Enables/disables an enhanced formulation for the local scaling of the continuity residuals with the pressure-based solver, so that the absolute mass flow rate at each cell is used. This text command is only available when the computing of the local scale is enabled through the solve/monitors/residual/scale-by-coefficient? text command. + Specify whether automatic initialization and case modification should be enabled. """ - return PyMenu(self.service, "/solve/monitors/residual/enhanced_continuity_residual").execute(*args, **kwargs) - def n_display(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/enable_strategy").execute(*args, **kwargs) + def execute_strategy(self, *args, **kwargs): """ - Sets the number of most recent residuals to display in plots. + Execute the automatic initialization and case modification strategy defined at present. """ - return PyMenu(self.service, "/solve/monitors/residual/n_display").execute(*args, **kwargs) - def n_maximize_norms(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/execute_strategy").execute(*args, **kwargs) + def add_edit_modification(self, *args, **kwargs): """ - Sets the number of iterations through which normalization factors will be maximized. + Define a single case modification. """ - return PyMenu(self.service, "/solve/monitors/residual/n_maximize_norms").execute(*args, **kwargs) - def normalization_factors(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/add_edit_modification").execute(*args, **kwargs) + def copy_modification(self, *args, **kwargs): """ - Sets normalization factors for currently monitored residuals (if normalize? is set to yes). + Copy a single case modification. """ - return PyMenu(self.service, "/solve/monitors/residual/normalization_factors").execute(*args, **kwargs) - def normalize(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/copy_modification").execute(*args, **kwargs) + def delete_modification(self, *args, **kwargs): """ - Chooses whether to normalize residuals in printed and plotted output. + Delete a single case modification. """ - return PyMenu(self.service, "/solve/monitors/residual/normalize").execute(*args, **kwargs) - def n_save(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/delete_modification").execute(*args, **kwargs) + def enable_modification(self, *args, **kwargs): """ - Sets number of residuals to be saved with data. History is automatically compacted when buffer becomes full. + Enable a single defined case modification. """ - return PyMenu(self.service, "/solve/monitors/residual/n_save").execute(*args, **kwargs) - def plot(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/enable_modification").execute(*args, **kwargs) + def disable_modification(self, *args, **kwargs): """ - Chooses whether residuals will be plotted during iteration. + Disable a single defined case modification. """ - return PyMenu(self.service, "/solve/monitors/residual/plot").execute(*args, **kwargs) - def print(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/disable_modification").execute(*args, **kwargs) + def import_modifications(self, *args, **kwargs): """ - Chooses whether residuals will be printed during iteration. + Import a list of case modifications from a tsv file. """ - return PyMenu(self.service, "/solve/monitors/residual/print").execute(*args, **kwargs) - def relative_conv_criteria(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/import_modifications").execute(*args, **kwargs) + def export_modifications(self, *args, **kwargs): """ - Sets relative convergence criteria for residuals that are currently being both monitored and checked. + Export all case modifications to a tsv file. """ - return PyMenu(self.service, "/solve/monitors/residual/relative_conv_criteria").execute(*args, **kwargs) - def re_normalize(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/export_modifications").execute(*args, **kwargs) + def continue_strategy_execution(self, *args, **kwargs): """ - Re-normalize residuals by maximum values. + Continue execution of the automatic initialization and case modification strategy defined at present. """ - return PyMenu(self.service, "/solve/monitors/residual/re_normalize").execute(*args, **kwargs) - def reset(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/continue_strategy_execution").execute(*args, **kwargs) + def automatic_initialization(self, *args, **kwargs): """ - Chooses whether to delete the residual history and reset iteration counter to 1. + Define how the case is to be initialized automatically. """ - return PyMenu(self.service, "/solve/monitors/residual/reset").execute(*args, **kwargs) - def scale_by_coefficient(self, *args, **kwargs): + return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/automatic_initialization").execute(*args, **kwargs) + + class automatic_case_modification(TUIMenu): """ - Chooses whether to scale residuals by coefficient sum in printed and plotted output. + Define how the case is to be modified as the solution progresses. """ - return PyMenu(self.service, "/solve/monitors/residual/scale_by_coefficient").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def before_init_modification(self, *args, **kwargs): + """ + Specify modification to be performed before initialization. + """ + return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/automatic_case_modification/before_init_modification").execute(*args, **kwargs) + def original_settings(self, *args, **kwargs): + """ + Specify modification to be performed after initialization to restore to original settings. + """ + return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/automatic_case_modification/original_settings").execute(*args, **kwargs) + def modifications(self, *args, **kwargs): + """ + Specify modifications to be performed during solution. + """ + return PyMenu(self.service, "/solution/calculation_activities/solution_strategy/automatic_case_modification/modifications").execute(*args, **kwargs) - class report_files(metaclass=PyMenuMeta): + class cell_registers(TUIMenu): """ - Enters the report files menu. + Manage Cell Registers. """ def __init__(self, path, service): self.path = path self.service = service - def add(self, *args, **kwargs): - """ - Creates a report file. - """ - return PyMenu(self.service, "/solve/report_files/add").execute(*args, **kwargs) - def clear_data(self, *args, **kwargs): - """ - Clears the data associated with a report file. - """ - return PyMenu(self.service, "/solve/report_files/clear_data").execute(*args, **kwargs) - def delete_all(self, *args, **kwargs): - """ - Deletes all of the report file objects. - """ - return PyMenu(self.service, "/solve/report_files/delete_all").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edits a report file. - """ - return PyMenu(self.service, "/solve/report_files/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes a report file object. - """ - return PyMenu(self.service, "/solve/report_files/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Lists all defined report files. - """ - return PyMenu(self.service, "/solve/report_files/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): + super().__init__(path, service) + def adapt(self, *args, **kwargs): """ - Lists the properties of a report file. + Adapt cell register objects. """ - return PyMenu(self.service, "/solve/report_files/list_properties").execute(*args, **kwargs) - - class report_definitions(metaclass=PyMenuMeta): - """ - Enters the report definitions menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solution/cell_registers/adapt").execute(*args, **kwargs) def add(self, *args, **kwargs): """ Add a new object. """ - return PyMenu(self.service, "/solve/report_definitions/add").execute(*args, **kwargs) - def compute(self, *args, **kwargs): + return PyMenu(self.service, "/solution/cell_registers/add").execute(*args, **kwargs) + def apply_poor_mesh_numerics(self, *args, **kwargs): """ - Computes selected report definition. + Apply poor mesh numerics to cell register objects. """ - return PyMenu(self.service, "/solve/report_definitions/compute").execute(*args, **kwargs) - def copy(self, *args, **kwargs): + return PyMenu(self.service, "/solution/cell_registers/apply_poor_mesh_numerics").execute(*args, **kwargs) + def coarsen(self, *args, **kwargs): """ - Creates a copy of a report definition. + Coarsen cell register objects. """ - return PyMenu(self.service, "/solve/report_definitions/copy").execute(*args, **kwargs) - def delete_all(self, *args, **kwargs): + return PyMenu(self.service, "/solution/cell_registers/coarsen").execute(*args, **kwargs) + def display(self, *args, **kwargs): """ - Deletes all of the report definition objects. + Display cell register objects. """ - return PyMenu(self.service, "/solve/report_definitions/delete_all").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/cell_registers/display").execute(*args, **kwargs) def edit(self, *args, **kwargs): """ - Edits a report definition. + Edit an object. """ - return PyMenu(self.service, "/solve/report_definitions/edit").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/cell_registers/edit").execute(*args, **kwargs) def delete(self, *args, **kwargs): """ - Deletes a report definition. + Delete an object. """ - return PyMenu(self.service, "/solve/report_definitions/delete").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/cell_registers/delete").execute(*args, **kwargs) def list(self, *args, **kwargs): """ - Lists all defined report definitions. + List objects. """ - return PyMenu(self.service, "/solve/report_definitions/list").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/cell_registers/list").execute(*args, **kwargs) def list_properties(self, *args, **kwargs): """ - Lists the properties of a report definition. + List properties of an object. """ - return PyMenu(self.service, "/solve/report_definitions/list_properties").execute(*args, **kwargs) - def rename(self, *args, **kwargs): + return PyMenu(self.service, "/solution/cell_registers/list_properties").execute(*args, **kwargs) + def refine(self, *args, **kwargs): """ - Renames a report definition. + Refine cell register objects. """ - return PyMenu(self.service, "/solve/report_definitions/rename").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/cell_registers/refine").execute(*args, **kwargs) - class report_plots(metaclass=PyMenuMeta): + class controls(TUIMenu): """ - Enters the report plots menu. + Enter the controls menu. """ def __init__(self, path, service): self.path = path self.service = service - def add(self, *args, **kwargs): - """ - Creates a report plot. - """ - return PyMenu(self.service, "/solve/report_plots/add").execute(*args, **kwargs) - def axes(self, *args, **kwargs): - """ - Defines the axes for a report plot. - """ - return PyMenu(self.service, "/solve/report_plots/axes").execute(*args, **kwargs) - def clear_data(self, *args, **kwargs): - """ - Clears the data associated with a report plot. - """ - return PyMenu(self.service, "/solve/report_plots/clear_data").execute(*args, **kwargs) - def curves(self, *args, **kwargs): + self.acoustics_wave_equation_controls = self.__class__.acoustics_wave_equation_controls(path + [("acoustics_wave_equation_controls", None)], service) + self.advanced = self.__class__.advanced(path + [("advanced", None)], service) + self.contact_solution_controls = self.__class__.contact_solution_controls(path + [("contact_solution_controls", None)], service) + self.query = self.__class__.query(path + [("query", None)], service) + super().__init__(path, service) + def courant_number(self, *args, **kwargs): """ - Defines the curves for a report plot. + Set the fine mesh Courant number (time step factor). """ - return PyMenu(self.service, "/solve/report_plots/curves").execute(*args, **kwargs) - def delete_all(self, *args, **kwargs): + return PyMenu(self.service, "/solution/controls/courant_number").execute(*args, **kwargs) + def equations(self, *args, **kwargs): """ - Deletes all of the report plot objects. + Enter the equations menu. """ - return PyMenu(self.service, "/solve/report_plots/delete_all").execute(*args, **kwargs) - def edit(self, *args, **kwargs): + return PyMenu(self.service, "/solution/controls/equations").execute(*args, **kwargs) + def limits(self, *args, **kwargs): """ - Edits a report plot. + Set solver limits for the values of various solution variables. """ - return PyMenu(self.service, "/solve/report_plots/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): + return PyMenu(self.service, "/solution/controls/limits").execute(*args, **kwargs) + def p_v_controls(self, *args, **kwargs): """ - Deletes a report plot object. + Set P-V-Controls. """ - return PyMenu(self.service, "/solve/report_plots/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): + return PyMenu(self.service, "/solution/controls/p_v_controls").execute(*args, **kwargs) + def relaxation_factor(self, *args, **kwargs): """ - Lists all defined report plots. + Enter the relaxation-factor menu. """ - return PyMenu(self.service, "/solve/report_plots/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): + return PyMenu(self.service, "/solution/controls/relaxation_factor").execute(*args, **kwargs) + def set_controls_to_default(self, *args, **kwargs): """ - Lists the properties of a report plot. + Set controls to default values. """ - return PyMenu(self.service, "/solve/report_plots/list_properties").execute(*args, **kwargs) - def plot(self, *args, **kwargs): + return PyMenu(self.service, "/solution/controls/set_controls_to_default").execute(*args, **kwargs) + def under_relaxation(self, *args, **kwargs): """ - Plots the specified report plot. + Enter the under-relaxation menu. """ - return PyMenu(self.service, "/solve/report_plots/plot").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/controls/under_relaxation").execute(*args, **kwargs) - class cell_registers(metaclass=PyMenuMeta): - """ - Enters the cell registers menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def adapt(self, *args, **kwargs): - """ - Adapt cell register objects. - """ - return PyMenu(self.service, "/solve/cell_registers/adapt").execute(*args, **kwargs) - def add(self, *args, **kwargs): - """ - Creates a new cell register. - """ - return PyMenu(self.service, "/solve/cell_registers/add").execute(*args, **kwargs) - def apply_poor_mesh_numerics(self, *args, **kwargs): - """ - Applies poor mesh numerics to the mesh of a cell register. - """ - return PyMenu(self.service, "/solve/cell_registers/apply_poor_mesh_numerics").execute(*args, **kwargs) - def coarsen(self, *args, **kwargs): - """ - Coarsen the mesh based on a cell register. - """ - return PyMenu(self.service, "/solve/cell_registers/coarsen").execute(*args, **kwargs) - def display(self, *args, **kwargs): - """ - Displays a cell register. + class acoustics_wave_equation_controls(TUIMenu): """ - return PyMenu(self.service, "/solve/cell_registers/display").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edits an existing cell register. - """ - return PyMenu(self.service, "/solve/cell_registers/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes a cell register. - """ - return PyMenu(self.service, "/solve/cell_registers/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Lists all of the currently defined cell registers. + Enter menu for acoustics wave equation solver controls. """ - return PyMenu(self.service, "/solve/cell_registers/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): + def __init__(self, path, service): + self.path = path + self.service = service + self.expert = self.__class__.expert(path + [("expert", None)], service) + super().__init__(path, service) + def relative_convergence_criterion(self, *args, **kwargs): + """ + Specify convergence tolerance for the timestep iterations + as the target residual reduction factor. + """ + return PyMenu(self.service, "/solution/controls/acoustics_wave_equation_controls/relative_convergence_criterion").execute(*args, **kwargs) + def max_iterations_per_timestep(self, *args, **kwargs): + """ + Specify maximum number of iterations per timestep. + """ + return PyMenu(self.service, "/solution/controls/acoustics_wave_equation_controls/max_iterations_per_timestep").execute(*args, **kwargs) + + class expert(TUIMenu): + """ + Enter menu for expert controls. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def under_relaxation_factor(self, *args, **kwargs): + """ + Specify under-relaxation factor to be used in + the diagonal matrix elements of implicit solver. + """ + return PyMenu(self.service, "/solution/controls/acoustics_wave_equation_controls/expert/under_relaxation_factor").execute(*args, **kwargs) + def explicit_relaxation_factor(self, *args, **kwargs): + """ + Specify explicit relaxation factor to be applied to + the solution correction when updating solution in the timestep iterations. + """ + return PyMenu(self.service, "/solution/controls/acoustics_wave_equation_controls/expert/explicit_relaxation_factor").execute(*args, **kwargs) + + class advanced(TUIMenu): """ - Lists the properties of a cell register. + Controls advanced options. """ - return PyMenu(self.service, "/solve/cell_registers/list_properties").execute(*args, **kwargs) - def refine(self, *args, **kwargs): + def __init__(self, path, service): + self.path = path + self.service = service + self.amg_options = self.__class__.amg_options(path + [("amg_options", None)], service) + self.fast_transient_settings = self.__class__.fast_transient_settings(path + [("fast_transient_settings", None)], service) + super().__init__(path, service) + def correction_tolerance(self, *args, **kwargs): + """ + Enter the correction tolerance menu. + """ + return PyMenu(self.service, "/solution/controls/advanced/correction_tolerance").execute(*args, **kwargs) + def multi_grid_amg(self, *args, **kwargs): + """ + Set the parameters that govern the algebraic multigrid procedure. + """ + return PyMenu(self.service, "/solution/controls/advanced/multi_grid_amg").execute(*args, **kwargs) + def multi_grid_controls(self, *args, **kwargs): + """ + Enter the multi-grid-controls menu. + """ + return PyMenu(self.service, "/solution/controls/advanced/multi_grid_controls").execute(*args, **kwargs) + def multi_grid_fas(self, *args, **kwargs): + """ + Set the coefficients that govern the FAS multigrid procedure. + """ + return PyMenu(self.service, "/solution/controls/advanced/multi_grid_fas").execute(*args, **kwargs) + def multi_stage(self, *args, **kwargs): + """ + Set the multiple-stage time stepping scheme coefficients. + """ + return PyMenu(self.service, "/solution/controls/advanced/multi_stage").execute(*args, **kwargs) + def relaxation_method(self, *args, **kwargs): + """ + Set the solver relaxation method. + """ + return PyMenu(self.service, "/solution/controls/advanced/relaxation_method").execute(*args, **kwargs) + def slope_limiter_set(self, *args, **kwargs): + """ + Enter the slope limiter set menu. + """ + return PyMenu(self.service, "/solution/controls/advanced/slope_limiter_set").execute(*args, **kwargs) + + class amg_options(TUIMenu): + """ + Enter AMG options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def laplace_coarsening(self, *args, **kwargs): + """ + Set AMG laplace coarsening options. + """ + return PyMenu(self.service, "/solution/controls/advanced/amg_options/laplace_coarsening").execute(*args, **kwargs) + def conservative_amg_coarsening(self, *args, **kwargs): + """ + Use conservative AMG coarsening?. + """ + return PyMenu(self.service, "/solution/controls/advanced/amg_options/conservative_amg_coarsening").execute(*args, **kwargs) + def aggressive_amg_coarsening(self, *args, **kwargs): + """ + Use aggressive AMG coarsening. + """ + return PyMenu(self.service, "/solution/controls/advanced/amg_options/aggressive_amg_coarsening").execute(*args, **kwargs) + def amg_gpgpu_options(self, *args, **kwargs): + """ + Set GPGPU AMG solver options. + """ + return PyMenu(self.service, "/solution/controls/advanced/amg_options/amg_gpgpu_options").execute(*args, **kwargs) + + class fast_transient_settings(TUIMenu): + """ + Enter the fast transient settings menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def rk2(self, *args, **kwargs): + """ + Enable the use of a two-stage Runge-Kutta scheme for time integration. + """ + return PyMenu(self.service, "/solution/controls/advanced/fast_transient_settings/rk2").execute(*args, **kwargs) + + class contact_solution_controls(TUIMenu): """ - Refine the mesh based on a cell register. + Solver controls for contact marks method. """ - return PyMenu(self.service, "/solve/cell_registers/refine").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + self.parameters = self.__class__.parameters(path + [("parameters", None)], service) + self.spatial = self.__class__.spatial(path + [("spatial", None)], service) + self.transient = self.__class__.transient(path + [("transient", None)], service) + self.amg = self.__class__.amg(path + [("amg", None)], service) + self.models = self.__class__.models(path + [("models", None)], service) + self.methods = self.__class__.methods(path + [("methods", None)], service) + self.miscellaneous = self.__class__.miscellaneous(path + [("miscellaneous", None)], service) + super().__init__(path, service) + def solution_stabilization(self, *args, **kwargs): + """ + Automatic solver settings adjustment for solution stabilization during contact process. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/solution_stabilization").execute(*args, **kwargs) + def set_settings_to_default(self, *args, **kwargs): + """ + Set contact solution stabilization to default. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/set_settings_to_default").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Specify verbosity level for contact solution controls. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/verbosity").execute(*args, **kwargs) + + class parameters(TUIMenu): + """ + Parameters used in stabilization strategy. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def iterations(self, *args, **kwargs): + """ + Specify additional iterations to accomodate contact solution stabilization. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/parameters/iterations").execute(*args, **kwargs) + def solution_stabilization_persistence(self, *args, **kwargs): + """ + Persistence of the solution stabilization based on events [0-contact based, 1-always on]. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/parameters/solution_stabilization_persistence").execute(*args, **kwargs) + def persistence_fixed_time_steps(self, *args, **kwargs): + """ + Specify fixed time-steps for solution stabilization persistence after trigger. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/parameters/persistence_fixed_time_steps").execute(*args, **kwargs) + def persistence_fixed_duration(self, *args, **kwargs): + """ + Specify fixed time for solution stabilization persistence after trigger. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/parameters/persistence_fixed_duration").execute(*args, **kwargs) + def extrapolation_method(self, *args, **kwargs): + """ + Solution extrapolation method for cells changing status from contact to non-contact [0-none, 1-local extrapolation]. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/parameters/extrapolation_method").execute(*args, **kwargs) + + class spatial(TUIMenu): + """ + Spatial discretization control options. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def first_to_second_order_blending(self, *args, **kwargs): + """ + Set factor to control first order to second order blending. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/spatial/first_to_second_order_blending").execute(*args, **kwargs) + def first_to_second_order_blending_list(self, *args, **kwargs): + """ + List set factor to control first order to second order blending. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/spatial/first_to_second_order_blending_list").execute(*args, **kwargs) + def scheme(self, *args, **kwargs): + """ + Set advection scheme for contact event stability. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/spatial/scheme").execute(*args, **kwargs) + def flow_skew_diffusion_exclude(self, *args, **kwargs): + """ + Exclude skew diffusion discretization contribution for momentum. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/spatial/flow_skew_diffusion_exclude").execute(*args, **kwargs) + def scalars_skew_diffusion_exclude(self, *args, **kwargs): + """ + Exclude skew diffusion discretization contribution for scalars. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/spatial/scalars_skew_diffusion_exclude").execute(*args, **kwargs) + def rhie_chow_flux_specify(self, *args, **kwargs): + """ + Allow specification of the the rhie-chow flux method. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/spatial/rhie_chow_flux_specify").execute(*args, **kwargs) + def rhie_chow_method(self, *args, **kwargs): + """ + Enter the rhie-chow flux method. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/spatial/rhie_chow_method").execute(*args, **kwargs) + + class transient(TUIMenu): + """ + Transient discretization control options . + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def transient_parameters_specify(self, *args, **kwargs): + """ + Allow transient parameter specification. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/transient/transient_parameters_specify").execute(*args, **kwargs) + def transient_scheme(self, *args, **kwargs): + """ + Specify temporal scheme to be used. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/transient/transient_scheme").execute(*args, **kwargs) + def time_scale_modification_method(self, *args, **kwargs): + """ + Enter time scale modification method. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/transient/time_scale_modification_method").execute(*args, **kwargs) + def time_scale_modification_factor(self, *args, **kwargs): + """ + Specify time-scale modification factor. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/transient/time_scale_modification_factor").execute(*args, **kwargs) + + class amg(TUIMenu): + """ + AMG control options. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enforce_laplace_coarsening(self, *args, **kwargs): + """ + Enforce the use of laplace coarsening in AMG. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/amg/enforce_laplace_coarsening").execute(*args, **kwargs) + def increase_pre_sweeps(self, *args, **kwargs): + """ + Allow increase in AMG pre-sweep. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/amg/increase_pre_sweeps").execute(*args, **kwargs) + def pre_sweeps(self, *args, **kwargs): + """ + Specify the number of AMG pre-sweeps. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/amg/pre_sweeps").execute(*args, **kwargs) + def specify_coarsening_rate(self, *args, **kwargs): + """ + Modify AMG coarsening rate. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/amg/specify_coarsening_rate").execute(*args, **kwargs) + def coarsen_rate(self, *args, **kwargs): + """ + Specify AMG coarsening rate. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/amg/coarsen_rate").execute(*args, **kwargs) + + class models(TUIMenu): + """ + Model control options. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def model_ramping(self, *args, **kwargs): + """ + Activate model ramping for solver stability and accuracy. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/models/model_ramping").execute(*args, **kwargs) + def ramp_flow(self, *args, **kwargs): + """ + Ramp flow for solver stability and accuracy. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/models/ramp_flow").execute(*args, **kwargs) + def ramp_turbulence(self, *args, **kwargs): + """ + Ramp turbulence for solver stability and accuracy. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/models/ramp_turbulence").execute(*args, **kwargs) + def ramp_scalars(self, *args, **kwargs): + """ + Ramp all scalar transport equations for solver stability and accuracy. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/models/ramp_scalars").execute(*args, **kwargs) - class cell_register_operations(metaclass=PyMenuMeta): - """ - Enters the cell register operations menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def add(self, *args, **kwargs): - """ - Creates a new cell register operation. - """ - return PyMenu(self.service, "/solve/cell_register_operations/add").execute(*args, **kwargs) - def edit(self, *args, **kwargs): - """ - Edits an existing cell register operation. - """ - return PyMenu(self.service, "/solve/cell_register_operations/edit").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Deletes a cell register operation. - """ - return PyMenu(self.service, "/solve/cell_register_operations/delete").execute(*args, **kwargs) - def list(self, *args, **kwargs): - """ - Lists the currently defined cell register operations. - """ - return PyMenu(self.service, "/solve/cell_register_operations/list").execute(*args, **kwargs) - def list_properties(self, *args, **kwargs): + class methods(TUIMenu): + """ + Methods control options. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def pressure_velocity_coupling_controls(self, *args, **kwargs): + """ + Enable pressure-velocity coupling method change for solver stability and accuracy. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/methods/pressure_velocity_coupling_controls").execute(*args, **kwargs) + def pressure_velocity_coupling_method(self, *args, **kwargs): + """ + Specify pressure-velocity coupling method change for solver stability and accuracy. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/methods/pressure_velocity_coupling_method").execute(*args, **kwargs) + def gradient_controls(self, *args, **kwargs): + """ + Modify gradient method for solver stability and accuracy. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/methods/gradient_controls").execute(*args, **kwargs) + def specify_gradient_method(self, *args, **kwargs): + """ + Specify gradient method for solver stability and accuracy. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/methods/specify_gradient_method").execute(*args, **kwargs) + + class miscellaneous(TUIMenu): + """ + Miscellaneous. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def compute_statistics(self, *args, **kwargs): + """ + Compute solution statistics for contact updates. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/miscellaneous/compute_statistics").execute(*args, **kwargs) + def statistics_level(self, *args, **kwargs): + """ + Solution statistics level for contact updates. + """ + return PyMenu(self.service, "/solution/controls/contact_solution_controls/miscellaneous/statistics_level").execute(*args, **kwargs) + + class query(TUIMenu): """ - Lists the properties of a report register operation. + Enter controls query menu. """ - return PyMenu(self.service, "/solve/cell_register_operations/list_properties").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + self.acoustics_wave_equation_controls = self.__class__.acoustics_wave_equation_controls(path + [("acoustics_wave_equation_controls", None)], service) + self.advanced = self.__class__.advanced(path + [("advanced", None)], service) + super().__init__(path, service) + def courant_number(self, *args, **kwargs): + """ + Get the fine mesh Courant number (time step factor). + """ + return PyMenu(self.service, "/solution/controls/query/courant_number").execute(*args, **kwargs) + def equations(self, *args, **kwargs): + """ + Enter the equations menu. + """ + return PyMenu(self.service, "/solution/controls/query/equations").execute(*args, **kwargs) + def limits(self, *args, **kwargs): + """ + Get solver limits for the values of various solution variables. + """ + return PyMenu(self.service, "/solution/controls/query/limits").execute(*args, **kwargs) + def p_v_controls(self, *args, **kwargs): + """ + Get P-V-Controls. + """ + return PyMenu(self.service, "/solution/controls/query/p_v_controls").execute(*args, **kwargs) + def relaxation_factor(self, *args, **kwargs): + """ + Enter the relaxation-factor menu. + """ + return PyMenu(self.service, "/solution/controls/query/relaxation_factor").execute(*args, **kwargs) + def under_relaxation(self, *args, **kwargs): + """ + Enter under relaxation menu. + """ + return PyMenu(self.service, "/solution/controls/query/under_relaxation").execute(*args, **kwargs) + + class acoustics_wave_equation_controls(TUIMenu): + """ + Enter menu for acoustics wave equation solver controls. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.expert = self.__class__.expert(path + [("expert", None)], service) + super().__init__(path, service) + def relative_convergence_criterion(self, *args, **kwargs): + """ + Specify convergence tolerance for the timestep iterations + as the target residual reduction factor. + """ + return PyMenu(self.service, "/solution/controls/query/acoustics_wave_equation_controls/relative_convergence_criterion").execute(*args, **kwargs) + def max_iterations_per_timestep(self, *args, **kwargs): + """ + Specify maximum number of iterations per timestep. + """ + return PyMenu(self.service, "/solution/controls/query/acoustics_wave_equation_controls/max_iterations_per_timestep").execute(*args, **kwargs) + + class expert(TUIMenu): + """ + Enter menu for expert controls. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def under_relaxation_factor(self, *args, **kwargs): + """ + Specify under-relaxation factor to be used in + the diagonal matrix elements of implicit solver. + """ + return PyMenu(self.service, "/solution/controls/query/acoustics_wave_equation_controls/expert/under_relaxation_factor").execute(*args, **kwargs) + def explicit_relaxation_factor(self, *args, **kwargs): + """ + Specify explicit relaxation factor to be applied to + the solution correction when updating solution in the timestep iterations. + """ + return PyMenu(self.service, "/solution/controls/query/acoustics_wave_equation_controls/expert/explicit_relaxation_factor").execute(*args, **kwargs) + + class advanced(TUIMenu): + """ + Controls advanced options. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.amg_options = self.__class__.amg_options(path + [("amg_options", None)], service) + super().__init__(path, service) + def correction_tolerance(self, *args, **kwargs): + """ + Enter the correction tolerance menu. + """ + return PyMenu(self.service, "/solution/controls/query/advanced/correction_tolerance").execute(*args, **kwargs) + def multi_grid_amg(self, *args, **kwargs): + """ + Get the parameters that govern the algebraic multigrid procedure. + """ + return PyMenu(self.service, "/solution/controls/query/advanced/multi_grid_amg").execute(*args, **kwargs) + def multi_grid_controls(self, *args, **kwargs): + """ + Enter the multi-grid-controls menu. + """ + return PyMenu(self.service, "/solution/controls/query/advanced/multi_grid_controls").execute(*args, **kwargs) + def multi_grid_fas(self, *args, **kwargs): + """ + Get the coefficients that govern the FAS multigrid procedure. + """ + return PyMenu(self.service, "/solution/controls/query/advanced/multi_grid_fas").execute(*args, **kwargs) + def multi_stage(self, *args, **kwargs): + """ + Set the multiple-stage time stepping scheme coefficients. + """ + return PyMenu(self.service, "/solution/controls/query/advanced/multi_stage").execute(*args, **kwargs) + def relaxation_method(self, *args, **kwargs): + """ + Set the solver relaxation method. + """ + return PyMenu(self.service, "/solution/controls/query/advanced/relaxation_method").execute(*args, **kwargs) + + class amg_options(TUIMenu): + """ + Enter AMG options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def laplace_coarsening(self, *args, **kwargs): + """ + Get AMG laplace coarsening options. + """ + return PyMenu(self.service, "/solution/controls/query/advanced/amg_options/laplace_coarsening").execute(*args, **kwargs) + def conservative_amg_coarsening(self, *args, **kwargs): + """ + Use conservative AMG coarsening?. + """ + return PyMenu(self.service, "/solution/controls/query/advanced/amg_options/conservative_amg_coarsening").execute(*args, **kwargs) + def aggressive_amg_coarsening(self, *args, **kwargs): + """ + Use aggressive AMG coarsening. + """ + return PyMenu(self.service, "/solution/controls/query/advanced/amg_options/aggressive_amg_coarsening").execute(*args, **kwargs) + def amg_gpgpu_options(self, *args, **kwargs): + """ + Amg gpu options. + """ + return PyMenu(self.service, "/solution/controls/query/advanced/amg_options/amg_gpgpu_options").execute(*args, **kwargs) - class set(metaclass=PyMenuMeta): + class expert(TUIMenu): """ - Enters the set solution parameters menu. + Enter expert options for solution. """ def __init__(self, path, service): self.path = path self.service = service - self.contact_solution_controls = self.__class__.contact_solution_controls(path + [("contact_solution_controls", None)], service) - self.transient_controls = self.__class__.transient_controls(path + [("transient_controls", None)], service) - self.data_sampling_options = self.__class__.data_sampling_options(path + [("data_sampling_options", None)], service) - self.pseudo_time_method = self.__class__.pseudo_time_method(path + [("pseudo_time_method", None)], service) - self.nita_expert_controls = self.__class__.nita_expert_controls(path + [("nita_expert_controls", None)], service) - self.multiphase_numerics = self.__class__.multiphase_numerics(path + [("multiphase_numerics", None)], service) - self.open_channel_wave_options = self.__class__.open_channel_wave_options(path + [("open_channel_wave_options", None)], service) - self.high_order_term_relaxation = self.__class__.high_order_term_relaxation(path + [("high_order_term_relaxation", None)], service) - self.poor_mesh_numerics = self.__class__.poor_mesh_numerics(path + [("poor_mesh_numerics", None)], service) - self.amg_options = self.__class__.amg_options(path + [("amg_options", None)], service) - self.warped_face_gradient_correction = self.__class__.warped_face_gradient_correction(path + [("warped_face_gradient_correction", None)], service) - self.fast_transient_settings = self.__class__.fast_transient_settings(path + [("fast_transient_settings", None)], service) self.divergence_prevention = self.__class__.divergence_prevention(path + [("divergence_prevention", None)], service) - self.advanced = self.__class__.advanced(path + [("advanced", None)], service) self.high_speed_numerics = self.__class__.high_speed_numerics(path + [("high_speed_numerics", None)], service) + self.poor_mesh_numerics = self.__class__.poor_mesh_numerics(path + [("poor_mesh_numerics", None)], service) self.previous_defaults = self.__class__.previous_defaults(path + [("previous_defaults", None)], service) - self.overset = self.__class__.overset(path + [("overset", None)], service) - self.acoustics_wave_equation_controls = self.__class__.acoustics_wave_equation_controls(path + [("acoustics_wave_equation_controls", None)], service) - self.p_v_controls_advanced = self.__class__.p_v_controls_advanced(path + [("p_v_controls_advanced", None)], service) - def adaptive_time_stepping(self, *args, **kwargs): - """ - Set Error-based adaptive time-stepping parameters. - """ - return PyMenu(self.service, "/solve/set/adaptive_time_stepping").execute(*args, **kwargs) - def cfl_based_adaptive_time_stepping(self, *args, **kwargs): - """ - Set CFL-based adaptive time-stepping parameters. - """ - return PyMenu(self.service, "/solve/set/cfl_based_adaptive_time_stepping").execute(*args, **kwargs) - def variable_time_stepping(self, *args, **kwargs): + self.non_reflecting_boundary_treatment = self.__class__.non_reflecting_boundary_treatment(path + [("non_reflecting_boundary_treatment", None)], service) + self.open_channel_wave_options = self.__class__.open_channel_wave_options(path + [("open_channel_wave_options", None)], service) + self.secondary_gradient_limiting = self.__class__.secondary_gradient_limiting(path + [("secondary_gradient_limiting", None)], service) + super().__init__(path, service) + def alternate_wall_temp_formulation(self, *args, **kwargs): """ - Set Multiphase-Specific Adaptive time stepping parameters. + Alternate formulation for wall temperatures?. """ - return PyMenu(self.service, "/solve/set/variable_time_stepping").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/expert/alternate_wall_temp_formulation").execute(*args, **kwargs) def bc_pressure_extrapolations(self, *args, **kwargs): """ - Sets pressure extrapolations schemes on boundaries. + Setting pressure extrapolations schemes on boundaries. """ - return PyMenu(self.service, "/solve/set/bc_pressure_extrapolations").execute(*args, **kwargs) - def correction_tolerance(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/bc_pressure_extrapolations").execute(*args, **kwargs) + def bcd_boundedness(self, *args, **kwargs): """ - Enters the correction tolerance menu. + BCD scheme boundedness strength, constant or expression (0 to 1). """ - return PyMenu(self.service, "/solve/set/correction_tolerance").execute(*args, **kwargs) - def courant_number(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/bcd_boundedness").execute(*args, **kwargs) + def bcd_weights_freeze(self, *args, **kwargs): """ - Sets the fine-grid Courant number (time step factor). This command is available only for the coupled solvers. + At each timestep, freeze BCD scheme weights after specified iteration + in order to improve timestep convergence. """ - return PyMenu(self.service, "/solve/set/courant_number").execute(*args, **kwargs) - def data_sampling(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/bcd_weights_freeze").execute(*args, **kwargs) + def correction_form(self, *args, **kwargs): """ - Enables data sampling for steady or unsteady flow statistics. + Discretize momentum equations in correction form for the pressure-based solver. """ - return PyMenu(self.service, "/solve/set/data_sampling").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/expert/correction_form").execute(*args, **kwargs) def disable_reconstruction(self, *args, **kwargs): """ - Completely disables reconstruction, resulting in totally first-order accuracy. - """ - return PyMenu(self.service, "/solve/set/disable_reconstruction").execute(*args, **kwargs) - def discretization_scheme(self, *args, **kwargs): - """ - Enters the discretization scheme menu. This allows you to select the discretization scheme for the convection terms in the solution equations. The following text commands can make a selection from a subset of the models in the following table: + Enable/Disable reconstruction. When disabled, accuracy will be first-order. """ - return PyMenu(self.service, "/solve/set/discretization_scheme").execute(*args, **kwargs) - def flux_type(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/disable_reconstruction").execute(*args, **kwargs) + def energy_numerical_noise_filter(self, *args, **kwargs): """ - Sets the flux type. Note that for the pressure-based solver, you can enable the Auto Select option that automatically selects the flux interpolation type based on the setup of the case. + The energy equation numerical noise filter can be enabled to eliminate non-physical numerical noise in the energy field. + The numerical noise can appear in solution fields where large variations in specific heat or combustion with phase change are present. + Using the energy equation numerical noise filter increases robustness, but may make the solution slightly more diffusive. """ - return PyMenu(self.service, "/solve/set/flux_type").execute(*args, **kwargs) - def equations(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/energy_numerical_noise_filter").execute(*args, **kwargs) + def explicit_under_relaxation_value(self, *args, **kwargs): """ - Selects the equations to be solved. + Explicit under-relaxation value. """ - return PyMenu(self.service, "/solve/set/equations").execute(*args, **kwargs) - def expert(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/explicit_under_relaxation_value").execute(*args, **kwargs) + def equation_ordering(self, *args, **kwargs): """ - Sets expert options. + Set the equation order. """ - return PyMenu(self.service, "/solve/set/expert").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/expert/equation_ordering").execute(*args, **kwargs) def flow_warnings(self, *args, **kwargs): """ - Specifies whether or not to print warning messages when reversed flow occurs at inlets and outlets, and when mass-flow inlets develop supersonic regions. By default, flow warnings are printed. - """ - return PyMenu(self.service, "/solve/set/flow_warnings").execute(*args, **kwargs) - def gradient_scheme(self, *args, **kwargs): - """ - Sets gradient options. - """ - return PyMenu(self.service, "/solve/set/gradient_scheme").execute(*args, **kwargs) - def nb_gradient_boundary_option(self, *args, **kwargs): - """ - Switches between the modified treatment of node-based gradients at boundary cells and the legacy treatment (R14.5.7 and earlier). If using the density-based solver, you can also specify the extended treatment. For details, see . + Control the display of warning diagnostics for boundaries with reversed flow, etc. """ - return PyMenu(self.service, "/solve/set/nb_gradient_boundary_option").execute(*args, **kwargs) - def limits(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/flow_warnings").execute(*args, **kwargs) + def limiter_warnings(self, *args, **kwargs): """ - Sets solver limits for various solution variables, in order to improve the stability of the solution. + Control the display of limiter warning diagnostics. """ - return PyMenu(self.service, "/solve/set/limits").execute(*args, **kwargs) - def limiter_warnings(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/limiter_warnings").execute(*args, **kwargs) + def linearized_mass_transfer_udf(self, *args, **kwargs): """ - Specifies whether or not to print warning messages when quantities are being limited. By default, limiter warnings are printed. + Use linearized mass transfer UDFs?. """ - return PyMenu(self.service, "/solve/set/limiter_warnings").execute(*args, **kwargs) - def mp_mfluid_aniso_drag(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/linearized_mass_transfer_udf").execute(*args, **kwargs) + def lock_solid_temperature(self, *args, **kwargs): """ - Sets anisotropic drag parameters for the Eulerian multiphase model. + Lock the temperature for all solid and shell cell zones in the domain. """ - return PyMenu(self.service, "/solve/set/mp_mfluid_aniso_drag").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/expert/lock_solid_temperature").execute(*args, **kwargs) def material_property_warnings(self, *args, **kwargs): """ Control the display of material property warning diagnostics: @@ -39305,796 +28289,861 @@ def material_property_warnings(self, *args, **kwargs): 1 - messages per material 2 - messages per material and per property. """ - return PyMenu(self.service, "/solve/set/material_property_warnings").execute(*args, **kwargs) - def mp_reference_density(self, *args, **kwargs): - """ - Sets the reference density method for the Eulerian multiphase model. The following options are available: - - - - 0 (default): Averaged density of the phase - - - - 1: Cell density of the phase - - - - 1: Constant value of 1 - - - - 1: Cell density of the phase - - - See for more information. - """ - return PyMenu(self.service, "/solve/set/mp_reference_density").execute(*args, **kwargs) - def max_corrections(self, *args, **kwargs): - """ - Enters the max-corrections menu. - """ - return PyMenu(self.service, "/solve/set/max_corrections").execute(*args, **kwargs) - def multi_grid_amg(self, *args, **kwargs): - """ - Sets the parameters that govern the algebraic multigrid procedure. - """ - return PyMenu(self.service, "/solve/set/multi_grid_amg").execute(*args, **kwargs) - def multi_grid_fas(self, *args, **kwargs): - """ - Sets the parameters that control the FAS multigrid solver. This command appears only when the explicit coupled solver is used. - """ - return PyMenu(self.service, "/solve/set/multi_grid_fas").execute(*args, **kwargs) - def multi_grid_controls(self, *args, **kwargs): - """ - Sets multigrid parameters and termination criteria. - """ - return PyMenu(self.service, "/solve/set/multi_grid_controls").execute(*args, **kwargs) - def multi_stage(self, *args, **kwargs): - """ - Sets the multi-stage coefficients and the dissipation and viscous evaluation stages. This command appears only when the explicit coupled solver is used. - """ - return PyMenu(self.service, "/solve/set/multi_stage").execute(*args, **kwargs) - def number_of_iterations(self, *args, **kwargs): - """ - Sets the number of iterations for a steady-state simulation without starting the calculation. - """ - return PyMenu(self.service, "/solve/set/number_of_iterations").execute(*args, **kwargs) - def numerics(self, *args, **kwargs): - """ - Sets numerics options. - """ - return PyMenu(self.service, "/solve/set/numerics").execute(*args, **kwargs) - def second_order_time_options(self, *args, **kwargs): - """ - Enables / disables the variable time step size formulation for second-order implicit transient formulations. If you disable the variable time step size formulation, note that any change in the time step size will introduce an error proportional to the change in the time step size ratio. - """ - return PyMenu(self.service, "/solve/set/second_order_time_options").execute(*args, **kwargs) - def solution_steering(self, *args, **kwargs): - """ - Enables solution steering for the density-based solver. - """ - return PyMenu(self.service, "/solve/set/solution_steering").execute(*args, **kwargs) - def set_solution_steering(self, *args, **kwargs): - """ - Sets solution steering parameters. - """ - return PyMenu(self.service, "/solve/set/set_solution_steering").execute(*args, **kwargs) - def p_v_coupling(self, *args, **kwargs): - """ - Selects which pressure-velocity coupling scheme is to be used. Five schemes are available: - """ - return PyMenu(self.service, "/solve/set/p_v_coupling").execute(*args, **kwargs) - def p_v_controls(self, *args, **kwargs): - """ - Sets pressure-velocity controls. - """ - return PyMenu(self.service, "/solve/set/p_v_controls").execute(*args, **kwargs) - def phase_based_vof_discretization(self, *args, **kwargs): - """ - Sets phase based slope limiter for VOF compressive scheme. - """ - return PyMenu(self.service, "/solve/set/phase_based_vof_discretization").execute(*args, **kwargs) - def accelerated_non_iterative_time_marching(self, *args, **kwargs): - """ - Enables a modified NITA scheme and other setting changes that can speed up the simulation. This option is only available with the Large Eddy Simulation (LES) turbulence model, and is intended for unreacting flow simulations that use a constant-density fluid. - """ - return PyMenu(self.service, "/solve/set/accelerated_non_iterative_time_marching").execute(*args, **kwargs) - def relaxation_method(self, *args, **kwargs): - """ - Sets the solver relaxation method. - """ - return PyMenu(self.service, "/solve/set/relaxation_method").execute(*args, **kwargs) - def reactions(self, *args, **kwargs): - """ - Enables the species reaction sources and sets relaxation factor. - """ - return PyMenu(self.service, "/solve/set/reactions").execute(*args, **kwargs) - def relaxation_factor(self, *args, **kwargs): - """ - Enters the relaxation-factor menu. - """ - return PyMenu(self.service, "/solve/set/relaxation_factor").execute(*args, **kwargs) - def reporting_interval(self, *args, **kwargs): - """ - Sets the number of iterations for which convergence monitors are reported. The default is 1 (after every iteration). - """ - return PyMenu(self.service, "/solve/set/reporting_interval").execute(*args, **kwargs) - def residual_smoothing(self, *args, **kwargs): - """ - Sets the implicit residual smoothing parameters. This command is available only for the explicit coupled solver. - """ - return PyMenu(self.service, "/solve/set/residual_smoothing").execute(*args, **kwargs) - def residual_tolerance(self, *args, **kwargs): - """ - Enters the residual tolerance menu. - """ - return PyMenu(self.service, "/solve/set/residual_tolerance").execute(*args, **kwargs) - def residual_verbosity(self, *args, **kwargs): - """ - Sets the amount of residual information to be printed. A value of 0 (the default) prints residuals at the end of each fine grid iteration. A value of 1 prints residuals after every stage of the fine grid iteration. A value of 2 prints residuals after every stage on every grid level. - """ - return PyMenu(self.service, "/solve/set/residual_verbosity").execute(*args, **kwargs) - def set_solution_methods_to_default(self, *args, **kwargs): - """ - Sets the solution methods to the default settings. - """ - return PyMenu(self.service, "/solve/set/set_solution_methods_to_default").execute(*args, **kwargs) - def set_controls_to_default(self, *args, **kwargs): - """ - Sets controls to default values. - """ - return PyMenu(self.service, "/solve/set/set_controls_to_default").execute(*args, **kwargs) - def set_all_species_together(self, *args, **kwargs): - """ - Sets all species discretizations and URFs together. - """ - return PyMenu(self.service, "/solve/set/set_all_species_together").execute(*args, **kwargs) - def slope_limiter_set(self, *args, **kwargs): - """ - Selects a new Fluent solver slope limiter. - """ - return PyMenu(self.service, "/solve/set/slope_limiter_set").execute(*args, **kwargs) - def vof_numerics(self, *args, **kwargs): - """ - Sets VOF numeric options. - """ - return PyMenu(self.service, "/solve/set/vof_numerics").execute(*args, **kwargs) - def vof_explicit_controls(self, *args, **kwargs): - """ - Sets the sub time step calculation method for VOF calculations. - """ - return PyMenu(self.service, "/solve/set/vof_explicit_controls").execute(*args, **kwargs) - def surface_tension(self, *args, **kwargs): - """ - Sets surface-tension calculation options. - """ - return PyMenu(self.service, "/solve/set/surface_tension").execute(*args, **kwargs) - def surface_tension_expert(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/material_property_warnings").execute(*args, **kwargs) + def mp_mfluid_aniso_drag(self, *args, **kwargs): """ - Set surface-tension expert options. + Set anisotropic drag parameters for Eulerian multiphase. """ - return PyMenu(self.service, "/solve/set/surface_tension_expert").execute(*args, **kwargs) - def open_channel_controls(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/mp_mfluid_aniso_drag").execute(*args, **kwargs) + def mp_reference_density(self, *args, **kwargs): """ - For flows that do not transition from sub-critical to super-critical, or vice-versa, you can speed-up the solution calculation by updating the frequency of Froude number during run time. + Set reference density option for Eulerian multiphase. """ - return PyMenu(self.service, "/solve/set/open_channel_controls").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/expert/mp_reference_density").execute(*args, **kwargs) def numerical_beach_controls(self, *args, **kwargs): """ - Sets damping function in flow direction. This command appears only when the VOF model is enabled. Select the damping function to be used: - - - - - - Index - Damping Function - - - - - 0 - Linear - - - 1 - Quadratic - - - 2 - Cubic - - - 3 - Cosine - - - - - + Set damping function in flow direction. """ - return PyMenu(self.service, "/solve/set/numerical_beach_controls").execute(*args, **kwargs) - def heterogeneous_stiff_chemistry(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/numerical_beach_controls").execute(*args, **kwargs) + def open_channel_controls(self, *args, **kwargs): """ - Sets the heterogeneous stiff-chemistry solver. + + Set additional open channel controls. """ - return PyMenu(self.service, "/solve/set/heterogeneous_stiff_chemistry").execute(*args, **kwargs) - def stiff_chemistry(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/open_channel_controls").execute(*args, **kwargs) + def retain_cell_residuals(self, *args, **kwargs): """ - Sets solver options for stiff chemistry solutions. + Retain cell residuals for postprocessing?. """ - return PyMenu(self.service, "/solve/set/stiff_chemistry").execute(*args, **kwargs) - def time_step(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/retain_cell_residuals").execute(*args, **kwargs) + def retain_temporary_solver_mem(self, *args, **kwargs): """ - Set the time step. + Retain temporary solver memory?. """ - return PyMenu(self.service, "/solve/set/time_step").execute(*args, **kwargs) - def under_relaxation(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/retain_temporary_solver_mem").execute(*args, **kwargs) + def set_all_species_together(self, *args, **kwargs): """ - Enters the under-relaxation menu, which allows you to set the under-relaxation factor for each equation that is being solved in a segregated manner. + Set all species discretizations and URFs together. """ - return PyMenu(self.service, "/solve/set/under_relaxation").execute(*args, **kwargs) - def convergence_acceleration_for_stretched_meshes(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/set_all_species_together").execute(*args, **kwargs) + def show_all_discretization_schemes(self, *args, **kwargs): """ - Enables convergence acceleration for stretched meshes to improve the convergence of the implicit density based solver on meshes with high cell stretching. + Allow selection of all applicable discretization schemes?. """ - return PyMenu(self.service, "/solve/set/convergence_acceleration_for_stretched_meshes").execute(*args, **kwargs) - def reduced_rank_extrapolation(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/show_all_discretization_schemes").execute(*args, **kwargs) + def singhal_et_al_cavitation_model(self, *args, **kwargs): """ - Enable Reduced Rank Extrapolation method to accelerate solution time. + Use Singhal-et-al cavitation model?. """ - return PyMenu(self.service, "/solve/set/reduced_rank_extrapolation").execute(*args, **kwargs) - def reduced_rank_extrapolation_options(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/singhal_et_al_cavitation_model").execute(*args, **kwargs) + def surface_tension(self, *args, **kwargs): """ - Reduced Rank Extrapolation options. + Set surface-tension calculation options. """ - return PyMenu(self.service, "/solve/set/reduced_rank_extrapolation_options").execute(*args, **kwargs) - def moving_mesh_numerics(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/surface_tension").execute(*args, **kwargs) + def surface_tension_expert(self, *args, **kwargs): """ - Transient options for sliding, moving, and/or dynamic mesh. + Set surface-tension expert options. """ - return PyMenu(self.service, "/solve/set/moving_mesh_numerics").execute(*args, **kwargs) - def lock_solid_temperature(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/surface_tension_expert").execute(*args, **kwargs) + def vof_explicit_controls(self, *args, **kwargs): """ - Specifies whether you want to lock (or “freeze”) the temperature values for all the cells in solid zones (including those to which you have a hooked an energy source through a UDF) and in walls that have shell conduction enabled, so that the values do not change during further solver iterations. + Set Explicit VOF controls. """ - return PyMenu(self.service, "/solve/set/lock_solid_temperature").execute(*args, **kwargs) - def enable_output_dp_dt(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/vof_explicit_controls").execute(*args, **kwargs) + + class divergence_prevention(TUIMenu): """ - Controls whether the output field variabledp-dt will be available for transient simulation postprocessing. If you select no, pressure fields at the previous time steps will not be stored in memory which reduces memory usage. + Enter the divergence prevention menu. """ - return PyMenu(self.service, "/solve/set/enable_output_dp_dt").execute(*args, **kwargs) - def equation_ordering(self, *args, **kwargs): + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable(self, *args, **kwargs): + """ + Enable divergence prevention. + """ + return PyMenu(self.service, "/solution/expert/divergence_prevention/enable").execute(*args, **kwargs) + + class high_speed_numerics(TUIMenu): """ - Sets the order in which the model equations are solved, which can affect the convergence speed when you are using the pressure-based solver. The standard method is enabled by default and corresponds to the ordering shown in and in the Theory Guide; alternatively, you can select theoptimized-for-volumetric-expansion method, which is recommended for flows in which the density is strongly dependent on thermal effects, chemical composition, and so on (such as combustion simulations). This text command is not available for steady simulations and/or when a multiphase model is enabled. + Enter high-speed-numerics menu. """ - return PyMenu(self.service, "/solve/set/equation_ordering").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable(self, *args, **kwargs): + """ + Enable/disable high-speed-numerics. + """ + return PyMenu(self.service, "/solution/expert/high_speed_numerics/enable").execute(*args, **kwargs) + def expert(self, *args, **kwargs): + """ + Expert high-speed-numerics. + """ + return PyMenu(self.service, "/solution/expert/high_speed_numerics/expert").execute(*args, **kwargs) + def visualize_pressure_discontinuity_sensor(self, *args, **kwargs): + """ + Enable/disable pressure-discontinuity-sensor visualization. + """ + return PyMenu(self.service, "/solution/expert/high_speed_numerics/visualize_pressure_discontinuity_sensor").execute(*args, **kwargs) - class contact_solution_controls(metaclass=PyMenuMeta): + class poor_mesh_numerics(TUIMenu): """ - Solver controls for contact marks method. + Enter Poor Mesh Numerics Menu. """ def __init__(self, path, service): self.path = path self.service = service - self.parameters = self.__class__.parameters(path + [("parameters", None)], service) - self.spatial = self.__class__.spatial(path + [("spatial", None)], service) - self.transient = self.__class__.transient(path + [("transient", None)], service) - self.amg = self.__class__.amg(path + [("amg", None)], service) - self.models = self.__class__.models(path + [("models", None)], service) - self.methods = self.__class__.methods(path + [("methods", None)], service) - self.miscellaneous = self.__class__.miscellaneous(path + [("miscellaneous", None)], service) - def solution_stabilization(self, *args, **kwargs): + self.solution_based_pmn = self.__class__.solution_based_pmn(path + [("solution_based_pmn", None)], service) + super().__init__(path, service) + def enable(self, *args, **kwargs): """ - Automatic solver settings adjustment for solution stabilization during contact process. + Solution correction on meshes of poor quality. """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/solution_stabilization").execute(*args, **kwargs) - def set_settings_to_default(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/enable").execute(*args, **kwargs) + def cell_quality_based(self, *args, **kwargs): """ - Set contact solution stabilization to default. + Enable/disable poor mesh numerics on cells with low quality. """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/set_settings_to_default").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/cell_quality_based").execute(*args, **kwargs) + def set_quality_threshold(self, *args, **kwargs): """ - Specify verbosity level for contact solution controls. + Set quality threshold. """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/verbosity").execute(*args, **kwargs) - - class parameters(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/set_quality_threshold").execute(*args, **kwargs) + def solution_and_quality_based(self, *args, **kwargs): """ - Parameters used in stabilization strategy. + Enable/disable poor mesh numerics based on solution and cell quality. """ - def __init__(self, path, service): - self.path = path - self.service = service - def iterations(self, *args, **kwargs): - """ - Specify additional iterations to accomodate contact solution stabilization. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/parameters/iterations").execute(*args, **kwargs) - def solution_stabilization_persistence(self, *args, **kwargs): - """ - Persistence of the solution stabilization based on events [0-contact based, 1-always on]. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/parameters/solution_stabilization_persistence").execute(*args, **kwargs) - def persistence_fixed_time_steps(self, *args, **kwargs): - """ - Specify fixed time-steps for solution stabilization persistence after trigger. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/parameters/persistence_fixed_time_steps").execute(*args, **kwargs) - def persistence_fixed_duration(self, *args, **kwargs): - """ - Specify fixed time for solution stabilization persistence after trigger. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/parameters/persistence_fixed_duration").execute(*args, **kwargs) - def extrapolation_method(self, *args, **kwargs): - """ - Solution extrapolation method for cells changing status from contact to non-contact [0-none, 1-local extrapolation]. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/parameters/extrapolation_method").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/solution_and_quality_based").execute(*args, **kwargs) + def gradient_quality_based(self, *args, **kwargs): + """ + Enable/disable poor mesh numerics based on cell gradient quality. + """ + return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/gradient_quality_based").execute(*args, **kwargs) + def orthogonality_enhancing_cell_centroids(self, *args, **kwargs): + """ + Relocate select cell centroids, to improve orthogonality metrics and solution stability. + """ + return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/orthogonality_enhancing_cell_centroids").execute(*args, **kwargs) + def user_defined_on_register(self, *args, **kwargs): + """ + Include cells in register in poor mesh numerics. + """ + return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/user_defined_on_register").execute(*args, **kwargs) + def reset_poor_elements(self, *args, **kwargs): + """ + Reset marking of poor cell elements. + """ + return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/reset_poor_elements").execute(*args, **kwargs) + def print_poor_elements_count(self, *args, **kwargs): + """ + Print poor cells count. + """ + return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/print_poor_elements_count").execute(*args, **kwargs) + def enhanced_pmn(self, *args, **kwargs): + """ + This option is available with the density-based solver. When enabled, it will apply quality-based poor-mesh-numerics order=1 on any cells with a quality-measure below 0.2. In addition, their CFL number is limited to 1.0. + """ + return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/enhanced_pmn").execute(*args, **kwargs) - class spatial(metaclass=PyMenuMeta): + class solution_based_pmn(TUIMenu): """ - Spatial discretization control options. + Solution based poor-mesh numerics menu. """ def __init__(self, path, service): self.path = path self.service = service - def first_to_second_order_blending(self, *args, **kwargs): - """ - Set factor to control first order to second order blending. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/spatial/first_to_second_order_blending").execute(*args, **kwargs) - def first_to_second_order_blending_list(self, *args, **kwargs): - """ - List set factor to control first order to second order blending. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/spatial/first_to_second_order_blending_list").execute(*args, **kwargs) - def scheme(self, *args, **kwargs): + super().__init__(path, service) + def enable(self, *args, **kwargs): """ - Set advection scheme for contact event stability. + Enable solution based treatment. """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/spatial/scheme").execute(*args, **kwargs) - def flow_skew_diffusion_exclude(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/solution_based_pmn/enable").execute(*args, **kwargs) + def mark_primary_solution_limits(self, *args, **kwargs): """ - Exclude skew diffusion discretization contribution for momentum. + Mark cells violating solution limits. """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/spatial/flow_skew_diffusion_exclude").execute(*args, **kwargs) - def scalars_skew_diffusion_exclude(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/solution_based_pmn/mark_primary_solution_limits").execute(*args, **kwargs) + def mark_velocity_limit(self, *args, **kwargs): """ - Exclude skew diffusion discretization contribution for scalars. + Mark cells exceeding velocity limit. """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/spatial/scalars_skew_diffusion_exclude").execute(*args, **kwargs) - def rhie_chow_flux_specify(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/solution_based_pmn/mark_velocity_limit").execute(*args, **kwargs) + def mark_cfl_limit(self, *args, **kwargs): """ - Allow specification of the the rhie-chow flux method. + Mark cells exceeding cfl limit. """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/spatial/rhie_chow_flux_specify").execute(*args, **kwargs) - def rhie_chow_method(self, *args, **kwargs): + return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/solution_based_pmn/mark_cfl_limit").execute(*args, **kwargs) + def mark_cfl_jump(self, *args, **kwargs): """ - Enter the rhie-chow flux method. + Mark cells exceeding cfl jump in neighborhood. """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/spatial/rhie_chow_method").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/expert/poor_mesh_numerics/solution_based_pmn/mark_cfl_jump").execute(*args, **kwargs) - class transient(metaclass=PyMenuMeta): + class previous_defaults(TUIMenu): + """ + Enter previous defaults menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def undo_r19_point_0_default_changes(self, *args, **kwargs): """ - Transient discretization control options . + Undo default changes introduced in R19.0. """ - def __init__(self, path, service): - self.path = path - self.service = service - def transient_parameters_specify(self, *args, **kwargs): - """ - Allow transient parameter specification. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/transient/transient_parameters_specify").execute(*args, **kwargs) - def transient_scheme(self, *args, **kwargs): - """ - Specify temporal scheme to be used. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/transient/transient_scheme").execute(*args, **kwargs) - def time_scale_modification_method(self, *args, **kwargs): - """ - Enter time scale modification method. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/transient/time_scale_modification_method").execute(*args, **kwargs) - def time_scale_modification_factor(self, *args, **kwargs): - """ - Specify time-scale modification factor. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/transient/time_scale_modification_factor").execute(*args, **kwargs) - - class amg(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solution/expert/previous_defaults/undo_r19_point_0_default_changes").execute(*args, **kwargs) + def undo_2019r1_default_changes(self, *args, **kwargs): """ - AMG control options. + Undo default changes introduced in 2019R1. """ - def __init__(self, path, service): - self.path = path - self.service = service - def enforce_laplace_coarsening(self, *args, **kwargs): - """ - Enforce the use of laplace coarsening in AMG. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/amg/enforce_laplace_coarsening").execute(*args, **kwargs) - def increase_pre_sweeps(self, *args, **kwargs): - """ - Allow increase in AMG pre-sweep. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/amg/increase_pre_sweeps").execute(*args, **kwargs) - def pre_sweeps(self, *args, **kwargs): - """ - Specify the number of AMG pre-sweeps. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/amg/pre_sweeps").execute(*args, **kwargs) - def specify_coarsening_rate(self, *args, **kwargs): - """ - Modify AMG coarsening rate. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/amg/specify_coarsening_rate").execute(*args, **kwargs) - def coarsen_rate(self, *args, **kwargs): - """ - Specify AMG coarsening rate. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/amg/coarsen_rate").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/expert/previous_defaults/undo_2019r1_default_changes").execute(*args, **kwargs) + def undo_2019r3_default_changes(self, *args, **kwargs): + """ + Undo default changes introduced in 2019R3. + """ + return PyMenu(self.service, "/solution/expert/previous_defaults/undo_2019r3_default_changes").execute(*args, **kwargs) + def undo_2021r1_default_changes(self, *args, **kwargs): + """ + Undo default changes introduced in 2021R1. + """ + return PyMenu(self.service, "/solution/expert/previous_defaults/undo_2021r1_default_changes").execute(*args, **kwargs) + def undo_2021r2_default_changes(self, *args, **kwargs): + """ + Undo default changes introduced in 2021R2. + """ + return PyMenu(self.service, "/solution/expert/previous_defaults/undo_2021r2_default_changes").execute(*args, **kwargs) + def undo_2022r1_default_changes(self, *args, **kwargs): + """ + Undo default changes introduced in 2022R1. + """ + return PyMenu(self.service, "/solution/expert/previous_defaults/undo_2022r1_default_changes").execute(*args, **kwargs) - class models(metaclass=PyMenuMeta): + class non_reflecting_boundary_treatment(TUIMenu): + """ + Enter non reflecting boundary treatment using minimal pressure reflection approach menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def pressure_inlet(self, *args, **kwargs): """ - Model control options. + Enabling the use of minimal pressure reflection treatment. This treatment will minimize pressure wave reflections from the boundaries on which this option is active, but not necessarily fully eliminating them. The reflections would be of an acceptable limit in order to not contaminate the solution, the simulation will gain from the robustness of the new algorithm compared to traditional non-reflecting boundary condition treatment. """ - def __init__(self, path, service): - self.path = path - self.service = service - def model_ramping(self, *args, **kwargs): - """ - Activate model ramping for solver stability and accuracy. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/models/model_ramping").execute(*args, **kwargs) - def ramp_flow(self, *args, **kwargs): - """ - Ramp flow for solver stability and accuracy. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/models/ramp_flow").execute(*args, **kwargs) - def ramp_turbulence(self, *args, **kwargs): - """ - Ramp turbulence for solver stability and accuracy. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/models/ramp_turbulence").execute(*args, **kwargs) - def ramp_scalars(self, *args, **kwargs): - """ - Ramp all scalar transport equations for solver stability and accuracy. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/models/ramp_scalars").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/expert/non_reflecting_boundary_treatment/pressure_inlet").execute(*args, **kwargs) + def pressure_outlet(self, *args, **kwargs): + """ + Enabling the use of minimal pressure reflection treatment. This treatment will minimize pressure wave reflections from the boundaries on which this option is active, but not necessarily fully eliminating them. The reflections would be of an acceptable limit in order to not contaminate the solution, the simulation will gain from the robustness of the new algorithm compared to traditional non-reflecting boundary condition treatment. + """ + return PyMenu(self.service, "/solution/expert/non_reflecting_boundary_treatment/pressure_outlet").execute(*args, **kwargs) + def velocity_inlet(self, *args, **kwargs): + """ + Enabling the use of minimal pressure reflection treatment. This treatment will minimize pressure wave reflections from the boundaries on which this option is active, but not necessarily fully eliminating them. The reflections would be of an acceptable limit in order to not contaminate the solution, the simulation will gain from the robustness of the new algorithm compared to traditional non-reflecting boundary condition treatment. + """ + return PyMenu(self.service, "/solution/expert/non_reflecting_boundary_treatment/velocity_inlet").execute(*args, **kwargs) - class methods(metaclass=PyMenuMeta): + class open_channel_wave_options(TUIMenu): + """ + Enter the open-channel-wave-options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def set_verbosity(self, *args, **kwargs): """ - Methods control options. + Set open channel wave verbosity. """ - def __init__(self, path, service): - self.path = path - self.service = service - def pressure_velocity_coupling_controls(self, *args, **kwargs): - """ - Enable pressure-velocity coupling method change for solver stability and accuracy. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/methods/pressure_velocity_coupling_controls").execute(*args, **kwargs) - def pressure_velocity_coupling_method(self, *args, **kwargs): - """ - Specify pressure-velocity coupling method change for solver stability and accuracy. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/methods/pressure_velocity_coupling_method").execute(*args, **kwargs) - def gradient_controls(self, *args, **kwargs): - """ - Modify gradient method for solver stability and accuracy. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/methods/gradient_controls").execute(*args, **kwargs) - def specify_gradient_method(self, *args, **kwargs): - """ - Specify gradient method for solver stability and accuracy. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/methods/specify_gradient_method").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/expert/open_channel_wave_options/set_verbosity").execute(*args, **kwargs) + def stokes_wave_variants(self, *args, **kwargs): + """ + Set stokes wave theory variants. + """ + return PyMenu(self.service, "/solution/expert/open_channel_wave_options/stokes_wave_variants").execute(*args, **kwargs) + def set_buffer_layer_ht(self, *args, **kwargs): + """ + Set bufer layer height between phases for segregated velocity inputs. + """ + return PyMenu(self.service, "/solution/expert/open_channel_wave_options/set_buffer_layer_ht").execute(*args, **kwargs) - class miscellaneous(metaclass=PyMenuMeta): + class secondary_gradient_limiting(TUIMenu): + """ + Enter the Secondary Gradient Limiting Menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def energy(self, *args, **kwargs): """ - Miscellaneous. + Enable/disable secondary gradient limiting at coupled walls for energy equation. """ - def __init__(self, path, service): - self.path = path - self.service = service - def compute_statistics(self, *args, **kwargs): - """ - Compute solution statistics for contact updates. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/miscellaneous/compute_statistics").execute(*args, **kwargs) - def statistics_level(self, *args, **kwargs): - """ - Solution statistics level for contact updates. - """ - return PyMenu(self.service, "/solve/set/contact_solution_controls/miscellaneous/statistics_level").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/expert/secondary_gradient_limiting/energy").execute(*args, **kwargs) + def uds(self, *args, **kwargs): + """ + Enable/disable secondary gradient limiting at coupled walls for user-defined scalars. + """ + return PyMenu(self.service, "/solution/expert/secondary_gradient_limiting/uds").execute(*args, **kwargs) + def mesh_quality_limits(self, *args, **kwargs): + """ + Specify minimum and maximum mesh quality limits. + """ + return PyMenu(self.service, "/solution/expert/secondary_gradient_limiting/mesh_quality_limits").execute(*args, **kwargs) + + class initialize(TUIMenu): + """ + Enter the flow initialization menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.compute_defaults = self.__class__.compute_defaults(path + [("compute_defaults", None)], service) + self.mp_localized_turb_init = self.__class__.mp_localized_turb_init(path + [("mp_localized_turb_init", None)], service) + self.vof_patch_smooth_options = self.__class__.vof_patch_smooth_options(path + [("vof_patch_smooth_options", None)], service) + self.set_fmg_options = self.__class__.set_fmg_options(path + [("set_fmg_options", None)], service) + self.set_hyb_initialization = self.__class__.set_hyb_initialization(path + [("set_hyb_initialization", None)], service) + super().__init__(path, service) + def open_channel_auto_init(self, *args, **kwargs): + """ + Open channel automatic initialization. + """ + return PyMenu(self.service, "/solution/initialize/open_channel_auto_init").execute(*args, **kwargs) + def levelset_auto_init(self, *args, **kwargs): + """ + Levelset function automatic initialization. + """ + return PyMenu(self.service, "/solution/initialize/levelset_auto_init").execute(*args, **kwargs) + def dpm_reset(self, *args, **kwargs): + """ + Reset discrete phase source terms to zero. + """ + return PyMenu(self.service, "/solution/initialize/dpm_reset").execute(*args, **kwargs) + def lwf_initialization(self, *args, **kwargs): + """ + Delete wall film particles and initialize wall film variables to zero. + """ + return PyMenu(self.service, "/solution/initialize/lwf_initialization").execute(*args, **kwargs) + def initialize_flow(self, *args, **kwargs): + """ + Initialize the flow field with the current default values. + """ + return PyMenu(self.service, "/solution/initialize/initialize_flow").execute(*args, **kwargs) + def init_acoustics_options(self, *args, **kwargs): + """ + Specify number of timesteps for ramping of sources + and initialize acoustics model variables. + During ramping the sound sources are multiplied by a factor smoothly growing from 0 to 1. + """ + return PyMenu(self.service, "/solution/initialize/init_acoustics_options").execute(*args, **kwargs) + def hyb_initialization(self, *args, **kwargs): + """ + Initialize using the hybrid initialization method. + """ + return PyMenu(self.service, "/solution/initialize/hyb_initialization").execute(*args, **kwargs) + def init_flow_statistics(self, *args, **kwargs): + """ + Initialize statistics. + """ + return PyMenu(self.service, "/solution/initialize/init_flow_statistics").execute(*args, **kwargs) + def patch(self, *args, **kwargs): + """ + Patch a value for a flow variable in the domain. + """ + return PyMenu(self.service, "/solution/initialize/patch").execute(*args, **kwargs) + def show_time_sampled(self, *args, **kwargs): + """ + Display the amount of simulated time covered by the data sampled for unsteady statistics. + """ + return PyMenu(self.service, "/solution/initialize/show_time_sampled").execute(*args, **kwargs) + def show_iterations_sampled(self, *args, **kwargs): + """ + Display the amount of simulated iterations covered by the data sampled for steady statistics. + """ + return PyMenu(self.service, "/solution/initialize/show_iterations_sampled").execute(*args, **kwargs) + def init_turb_vel_fluctuations(self, *args, **kwargs): + """ + Initialize turbulent velocity fluctuations. + """ + return PyMenu(self.service, "/solution/initialize/init_turb_vel_fluctuations").execute(*args, **kwargs) + def fmg_initialization(self, *args, **kwargs): + """ + Initialize using the full-multigrid initialization (FMG). + """ + return PyMenu(self.service, "/solution/initialize/fmg_initialization").execute(*args, **kwargs) + def repair_wall_distance(self, *args, **kwargs): + """ + Correct wall distance at very high aspect ratio hexahedral/polyhedral cells. + """ + return PyMenu(self.service, "/solution/initialize/repair_wall_distance").execute(*args, **kwargs) + def set_defaults(self, *args, **kwargs): + """ + Enter the set defaults menu. + """ + return PyMenu(self.service, "/solution/initialize/set_defaults").execute(*args, **kwargs) + def set_fmg_initialization(self, *args, **kwargs): + """ + Enter the set full-multigrid for initialization menu. + """ + return PyMenu(self.service, "/solution/initialize/set_fmg_initialization").execute(*args, **kwargs) + def list_defaults(self, *args, **kwargs): + """ + List default values. + """ + return PyMenu(self.service, "/solution/initialize/list_defaults").execute(*args, **kwargs) + def reference_frame(self, *args, **kwargs): + """ + Set reference frame absolute or relative. + """ + return PyMenu(self.service, "/solution/initialize/reference_frame").execute(*args, **kwargs) - class transient_controls(metaclass=PyMenuMeta): + class compute_defaults(TUIMenu): """ - Enters the transient controls menu, which allows you to define settings related to time advancement for transient flow calculations. + Enter the compute defaults menu. """ def __init__(self, path, service): self.path = path self.service = service - self.multiphase_specific_time_constraints = self.__class__.multiphase_specific_time_constraints(path + [("multiphase_specific_time_constraints", None)], service) - def specified_time_step(self, *args, **kwargs): + super().__init__(path, service) + def axis(self, *args, **kwargs): """ - Specifies whether to define the transient advancement either directly by entering a time step size / period / frequency (using the text commands available in thesolve/set/transient-controls menu) or indirectly by entering a Courant number value (using the solve/set/courant-number text command). This text command is only available for the density-based solver when both the explicit formulation and explicit transient formulation are used. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/specified_time_step").execute(*args, **kwargs) - def fixed_user_specified(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/axis").execute(*args, **kwargs) + def degassing(self, *args, **kwargs): """ - Allows you to specify that a fixed time stepping method is used in which you directly specify the time step size and number of time steps. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/fixed_user_specified").execute(*args, **kwargs) - def fixed_periodic(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/degassing").execute(*args, **kwargs) + def dummy_entry(self, *args, **kwargs): """ - Allows you to specify that a fixed time stepping method is used in which a specified period or frequency is the basis for determining the time step size and number of time steps. + . """ - return PyMenu(self.service, "/solve/set/transient_controls/fixed_periodic").execute(*args, **kwargs) - def duration_specification_method(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/dummy_entry").execute(*args, **kwargs) + def all_zones(self, *args, **kwargs): """ - Sets the method by which you will specify the duration of the calculation. The duration can be defined by the total time, the total number of time steps, the incremental time, or the number of incremental time steps. In this context, "total" indicates that Fluent will consider the amount of time / steps that have already been solved and stop appropriately, whereas "incremental" indicates that the solution will proceed for a specified amount of time / steps regardless of what has previously been calculated. This text command is only available when the time stepping is adaptive or based on a user-defined function. + Initialize the flow field with the default values. """ - return PyMenu(self.service, "/solve/set/transient_controls/duration_specification_method").execute(*args, **kwargs) - def incremental_time(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/all_zones").execute(*args, **kwargs) + def exhaust_fan(self, *args, **kwargs): """ - Sets the amount of incremental (that is, additional) time to run the simulation, regardless of how much time has already been run in previous calculations. This text command is only available when the solve/set/transient-controls/duration-specification-method is set to3. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/incremental_time").execute(*args, **kwargs) - def max_iterations_per_time_step(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/exhaust_fan").execute(*args, **kwargs) + def fan(self, *args, **kwargs): """ - Sets the number of time steps for a transient simulation. This option is available when automatic initialization and case modification is enabled. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/max_iterations_per_time_step").execute(*args, **kwargs) - def number_of_time_steps(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/fan").execute(*args, **kwargs) + def fluid(self, *args, **kwargs): """ - Sets the number of time steps for a transient simulation without starting the calculation. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/number_of_time_steps").execute(*args, **kwargs) - def total_number_of_time_steps(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/fluid").execute(*args, **kwargs) + def geometry(self, *args, **kwargs): """ - Sets the total number of time steps that the simulation will run (which includes any time steps that have already been run in previous calculations). This text command is only available when the solve/set/transient-controls/duration-specification-method is set to1. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/total_number_of_time_steps").execute(*args, **kwargs) - def total_time(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/geometry").execute(*args, **kwargs) + def inlet_vent(self, *args, **kwargs): """ - Sets the total amount of time that the simulation will be run (which includes any time that has already been run in previous calculations). This text command is only available when the solve/set/transient-controls/duration-specification-method is set to2. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/total_time").execute(*args, **kwargs) - def time_step_size(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/inlet_vent").execute(*args, **kwargs) + def intake_fan(self, *args, **kwargs): """ - Sets the magnitude of the (physical) time step . This text command is only available when the solve/set/transient-controls/fixed-user-specified text command is set toyes. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/time_step_size").execute(*args, **kwargs) - def solution_status(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/intake_fan").execute(*args, **kwargs) + def interface(self, *args, **kwargs): """ - Allows you to open theSimulation Status dialog box, which reports details about the simulation. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/solution_status").execute(*args, **kwargs) - def extrapolate_vars(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/interface").execute(*args, **kwargs) + def interior(self, *args, **kwargs): """ - Applies a predictor algorithm for computing initial conditions at time step n+1. The predictor algorithm is a computation that sets a better initial condition for the time step. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/extrapolate_vars").execute(*args, **kwargs) - def extrapolate_eqn_vars(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/interior").execute(*args, **kwargs) + def mass_flow_inlet(self, *args, **kwargs): """ - Enters the extrapolation menu. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/extrapolate_eqn_vars").execute(*args, **kwargs) - def max_flow_time(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/mass_flow_inlet").execute(*args, **kwargs) + def mass_flow_outlet(self, *args, **kwargs): """ - Sets the maximum flow time. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/max_flow_time").execute(*args, **kwargs) - def cfl_based_time_stepping_advanced_options(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/mass_flow_outlet").execute(*args, **kwargs) + def network(self, *args, **kwargs): """ - Set CFL-based adaptive time-stepping advanced parameters. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/cfl_based_time_stepping_advanced_options").execute(*args, **kwargs) - def cfl_based_time_stepping(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/network").execute(*args, **kwargs) + def network_end(self, *args, **kwargs): """ - Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent as the calculation proceeds such that the Courant–Friedrichs–Lewy (CFL) condition is satisfied, using the specified Courant number. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/cfl_based_time_stepping").execute(*args, **kwargs) - def multiphase_specific_time_stepping(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/network_end").execute(*args, **kwargs) + def outflow(self, *args, **kwargs): """ - Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent based on the convective time scale (global Courant number): the time-step-size calculation depends on the mesh density and velocity in interfacial cells. This method is available for all multiphase models using the implicit or explicit volume fraction formulation, except for the wet steam model. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/multiphase_specific_time_stepping").execute(*args, **kwargs) - def udf_based_time_stepping(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/outflow").execute(*args, **kwargs) + def outlet_vent(self, *args, **kwargs): """ - Allows you to specify that the time step size is defined by a user-defined function (UDF) that uses theDEFINE_DELTAT macro. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/udf_based_time_stepping").execute(*args, **kwargs) - def error_based_time_stepping(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/outlet_vent").execute(*args, **kwargs) + def overset(self, *args, **kwargs): """ - Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent based on the specified truncation error tolerance. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/error_based_time_stepping").execute(*args, **kwargs) - def undo_timestep(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/overset").execute(*args, **kwargs) + def periodic(self, *args, **kwargs): """ - When enabled, if the truncation error within a time step exceeds the specified tolerance Fluent will automatically undo the current calculation and make another attempt with the time step reduced by 1/2. This will be attempted up to 5 times after which Fluent will accept the result and proceed to the next time step. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/undo_timestep").execute(*args, **kwargs) - def predict_next_time(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/periodic").execute(*args, **kwargs) + def porous_jump(self, *args, **kwargs): """ - Applies a predictor algorithm for computing the next time step. The predictor algorithm is a computation that sets a better initial condition for the time step. It uses the rate of change between the prediction and the correction as an indicator for whether the next time step should be larger, smaller, or the same as the current one. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/predict_next_time").execute(*args, **kwargs) - def rotating_mesh_flow_predictor(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/porous_jump").execute(*args, **kwargs) + def pressure_far_field(self, *args, **kwargs): """ - Enables / disables an option that allows for better prediction of the flow field in rotating fluid zones at every time step, in order to speed up the calculation. This text command is only available for transient simulations. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/rotating_mesh_flow_predictor").execute(*args, **kwargs) - def solid_time_step_size(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/pressure_far_field").execute(*args, **kwargs) + def pressure_inlet(self, *args, **kwargs): """ - Allows you to specify that the time step size used for solid zones is independent from that used for fluid zones. This text command is only available when both a solid zone exists and energy is enabled. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/solid_time_step_size").execute(*args, **kwargs) - def time_step_size_for_acoustic_export(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/compute_defaults/pressure_inlet").execute(*args, **kwargs) + def pressure_outlet(self, *args, **kwargs): """ - Specifies the time interval for acoustic data sampling. This text command is only available when both the Ffowcs Williams and Hawkings model is selected and the density-based solver is used with the explicit formulation and explicit transient formulation. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/solve/set/transient_controls/time_step_size_for_acoustic_export").execute(*args, **kwargs) - - class multiphase_specific_time_constraints(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solution/initialize/compute_defaults/pressure_outlet").execute(*args, **kwargs) + def radiator(self, *args, **kwargs): """ - Enters the menu for setting multiphase-specific time constraints. + Compute flow-initialization defaults from a zone of this type. """ - def __init__(self, path, service): - self.path = path - self.service = service - self.time_scale_options = self.__class__.time_scale_options(path + [("time_scale_options", None)], service) - def moving_mesh_cfl_constraint(self, *args, **kwargs): - """ - Enable time step size constraints based on moving mesh courant number. - """ - return PyMenu(self.service, "/solve/set/transient_controls/multiphase_specific_time_constraints/moving_mesh_cfl_constraint").execute(*args, **kwargs) - def physics_based_constraint(self, *args, **kwargs): - """ - Enables/disables the physics-driven time-step constraints. - """ - return PyMenu(self.service, "/solve/set/transient_controls/multiphase_specific_time_constraints/physics_based_constraint").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - When enabled, various time scales (depending on the selection) are printed to the console window at every time step. This text command is available with the moving mesh CFL constraint and with the physics-based constraint. - """ - return PyMenu(self.service, "/solve/set/transient_controls/multiphase_specific_time_constraints/verbosity").execute(*args, **kwargs) - - class time_scale_options(metaclass=PyMenuMeta): - """ - Enters the menu for choosing the time-scale options. This menu becomes available after you enable the physics-driven time-step constraints using the solve/set/transient-controls/multiphase-specific-time-constraints/physics-based-constraint? text command. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def viscous_scale(self, *args, **kwargs): - """ - Allows you to Include the viscous time scale. This option is disabled by default. This command is not available with inviscid flows. - """ - return PyMenu(self.service, "/solve/set/transient_controls/multiphase_specific_time_constraints/time_scale_options/viscous_scale").execute(*args, **kwargs) - def gravity_scale(self, *args, **kwargs): - """ - Allows you to Include the gravitational time scale. This option is available only if gravity is enabled. - """ - return PyMenu(self.service, "/solve/set/transient_controls/multiphase_specific_time_constraints/time_scale_options/gravity_scale").execute(*args, **kwargs) - def surface_tension_scale(self, *args, **kwargs): - """ - Allows you to Include the surface-tension-driven time scale. This option is available only if the surface tension force modeling is enabled. - """ - return PyMenu(self.service, "/solve/set/transient_controls/multiphase_specific_time_constraints/time_scale_options/surface_tension_scale").execute(*args, **kwargs) - def acoustic_scale(self, *args, **kwargs): - """ - Allows you to Include the acoustic time scale. This option is available only for compressible flows. - """ - return PyMenu(self.service, "/solve/set/transient_controls/multiphase_specific_time_constraints/time_scale_options/acoustic_scale").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/initialize/compute_defaults/radiator").execute(*args, **kwargs) + def rans_les_interface(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solution/initialize/compute_defaults/rans_les_interface").execute(*args, **kwargs) + def recirculation_inlet(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solution/initialize/compute_defaults/recirculation_inlet").execute(*args, **kwargs) + def recirculation_outlet(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solution/initialize/compute_defaults/recirculation_outlet").execute(*args, **kwargs) + def shadow(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solution/initialize/compute_defaults/shadow").execute(*args, **kwargs) + def solid(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solution/initialize/compute_defaults/solid").execute(*args, **kwargs) + def symmetry(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solution/initialize/compute_defaults/symmetry").execute(*args, **kwargs) + def velocity_inlet(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solution/initialize/compute_defaults/velocity_inlet").execute(*args, **kwargs) + def wall(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solution/initialize/compute_defaults/wall").execute(*args, **kwargs) - class data_sampling_options(metaclass=PyMenuMeta): + class mp_localized_turb_init(TUIMenu): """ - Enter the menu for specifying quantities and zones for steady and unsteady flow statistics. + Localized initialization of turbulent flow variables for VOF/Mixture multiphase flow models. """ def __init__(self, path, service): self.path = path self.service = service - def add_datasets(self, *args, **kwargs): - """ - Add a dataset. After providing the zones for a dataset, press [Enter] to move onto selecting quantities. Enter () to complete the quantity selection for this dataset. - """ - return PyMenu(self.service, "/solve/set/data_sampling_options/add_datasets").execute(*args, **kwargs) - def add_rtdft_datasets(self, *args, **kwargs): - """ - Specify zone and quantity combinations for sampling Fourier coefficients of unsteady flows. - """ - return PyMenu(self.service, "/solve/set/data_sampling_options/add_rtdft_datasets").execute(*args, **kwargs) - def remove_dataset(self, *args, **kwargs): + super().__init__(path, service) + def enable(self, *args, **kwargs): """ - Remove dataset. + Localized initialization of turbulent flow variables for VOF/Mixture multiphase flow models. """ - return PyMenu(self.service, "/solve/set/data_sampling_options/remove_dataset").execute(*args, **kwargs) - def list_datasets(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/mp_localized_turb_init/enable").execute(*args, **kwargs) + def turb_init_parameters(self, *args, **kwargs): """ - Lists the combinations of zones and quantities that are defined for sampling steady and unsteady flow statistics. + Turbulent flow parameters for localized initialization. """ - return PyMenu(self.service, "/solve/set/data_sampling_options/list_datasets").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/initialize/mp_localized_turb_init/turb_init_parameters").execute(*args, **kwargs) - class pseudo_time_method(metaclass=PyMenuMeta): + class vof_patch_smooth_options(TUIMenu): """ - Enters the pseudo time method menu. This menu is only available for cases that use a pressure-based segregated solver (SIMPLE, SIMPLEC, or PISO) or for steady-state cases that use the pressure-based coupled solver or the density-based implicit solver. + Enter the vof patch/smooth options menu. """ def __init__(self, path, service): self.path = path self.service = service - def formulation(self, *args, **kwargs): + super().__init__(path, service) + def set_options(self, *args, **kwargs): """ - Enables and sets the pseudo time step size formulation or disables the pseudo time method option. + Patch and smoothing options for volume fraction. """ - return PyMenu(self.service, "/solve/set/pseudo_time_method/formulation").execute(*args, **kwargs) - def local_time_step_settings(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/vof_patch_smooth_options/set_options").execute(*args, **kwargs) + def execute_smoothing(self, *args, **kwargs): """ - Defines the pseudo time Courant number when the local time step formulation is selected. + Execute volumetric smoothing for volume fraction. """ - return PyMenu(self.service, "/solve/set/pseudo_time_method/local_time_step_settings").execute(*args, **kwargs) - def global_time_step_settings(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/vof_patch_smooth_options/execute_smoothing").execute(*args, **kwargs) + + class set_fmg_options(TUIMenu): + """ + Enter the full-multigrid option menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def viscous_terms(self, *args, **kwargs): """ - Defines the pseudo time settings for the calculation when the global time step formulation is selected. + Enable/disable viscous terms during FMG initialization. """ - return PyMenu(self.service, "/solve/set/pseudo_time_method/global_time_step_settings").execute(*args, **kwargs) - def advanced_options(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/set_fmg_options/viscous_terms").execute(*args, **kwargs) + def species_reactions(self, *args, **kwargs): """ - Enters the advanced options menu, which allows you to enable / disable the pseudo time method for individual equations and define their pseudo time scale factors or under-relaxation factors, respectively. These settings only apply when the global time step formulation is selected. + Enable/disable species volumetric reactions during FMG initialization. """ - return PyMenu(self.service, "/solve/set/pseudo_time_method/advanced_options").execute(*args, **kwargs) - def relaxation_factors(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/set_fmg_options/species_reactions").execute(*args, **kwargs) + def set_turbulent_viscosity_ratio(self, *args, **kwargs): """ - Enters the relaxation factors menu, where you can set the pseudo time explicit relaxation factors for individual equations. These factors only apply when the global time step formulation is selected. + Set turbulent viscosity ratio used during FMG initialization. """ - return PyMenu(self.service, "/solve/set/pseudo_time_method/relaxation_factors").execute(*args, **kwargs) - def relaxation_method(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/set_fmg_options/set_turbulent_viscosity_ratio").execute(*args, **kwargs) + + class set_hyb_initialization(TUIMenu): + """ + Enter the settings for hybrid initialization method. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def general_settings(self, *args, **kwargs): """ - Select relaxation definition for pseudo time method. + Enter the general settings menu. """ - return PyMenu(self.service, "/solve/set/pseudo_time_method/relaxation_method").execute(*args, **kwargs) - def relaxation_bounds(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/set_hyb_initialization/general_settings").execute(*args, **kwargs) + def turbulent_settings(self, *args, **kwargs): """ - Select relaxation bounding scheme for pseudo time method. + Enter the turbulent settings menu. """ - return PyMenu(self.service, "/solve/set/pseudo_time_method/relaxation_bounds").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): + return PyMenu(self.service, "/solution/initialize/set_hyb_initialization/turbulent_settings").execute(*args, **kwargs) + def species_settings(self, *args, **kwargs): """ - Sets the verbosity of the messages related to the pseudo time method. + Enter the species settings menu. """ - return PyMenu(self.service, "/solve/set/pseudo_time_method/verbosity").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/initialize/set_hyb_initialization/species_settings").execute(*args, **kwargs) - class nita_expert_controls(metaclass=PyMenuMeta): + class methods(TUIMenu): + """ + Enter the methods menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.expert = self.__class__.expert(path + [("expert", None)], service) + self.high_order_term_relaxation = self.__class__.high_order_term_relaxation(path + [("high_order_term_relaxation", None)], service) + self.multiphase_numerics = self.__class__.multiphase_numerics(path + [("multiphase_numerics", None)], service) + self.nita_expert_controls = self.__class__.nita_expert_controls(path + [("nita_expert_controls", None)], service) + self.overset = self.__class__.overset(path + [("overset", None)], service) + self.pseudo_time_method = self.__class__.pseudo_time_method(path + [("pseudo_time_method", None)], service) + self.query = self.__class__.query(path + [("query", None)], service) + self.warped_face_gradient_correction = self.__class__.warped_face_gradient_correction(path + [("warped_face_gradient_correction", None)], service) + super().__init__(path, service) + def accelerated_non_iterative_time_marching(self, *args, **kwargs): """ - Enters the NITA expert control menu. + Enable/disable accelerated non-iterative time marching. + """ + return PyMenu(self.service, "/solution/methods/accelerated_non_iterative_time_marching").execute(*args, **kwargs) + def convergence_acceleration_for_stretched_meshes(self, *args, **kwargs): + """ + Enable convergence acceleration for stretched meshes to improve the convergence of the implicit density based solver on meshes with high cell stretching. + """ + return PyMenu(self.service, "/solution/methods/convergence_acceleration_for_stretched_meshes").execute(*args, **kwargs) + def discretization_scheme(self, *args, **kwargs): + """ + Enter the discretization-scheme menu. + """ + return PyMenu(self.service, "/solution/methods/discretization_scheme").execute(*args, **kwargs) + def flux_type(self, *args, **kwargs): + """ + Enter the flux type. + """ + return PyMenu(self.service, "/solution/methods/flux_type").execute(*args, **kwargs) + def frozen_flux(self, *args, **kwargs): + """ + Enable/disable frozen flux formulation for transient flows. + """ + return PyMenu(self.service, "/solution/methods/frozen_flux").execute(*args, **kwargs) + def gradient_scheme(self, *args, **kwargs): + """ + Set gradient options. + """ + return PyMenu(self.service, "/solution/methods/gradient_scheme").execute(*args, **kwargs) + def nb_gradient_boundary_option(self, *args, **kwargs): + """ + Set ggnb options. + """ + return PyMenu(self.service, "/solution/methods/nb_gradient_boundary_option").execute(*args, **kwargs) + def noniterative_time_advance(self, *args, **kwargs): + """ + Enable/disable the noniterative time advancement scheme. + """ + return PyMenu(self.service, "/solution/methods/noniterative_time_advance").execute(*args, **kwargs) + def p_v_coupling(self, *args, **kwargs): + """ + Select the pressure velocity coupling scheme. + """ + return PyMenu(self.service, "/solution/methods/p_v_coupling").execute(*args, **kwargs) + def phase_based_vof_discretization(self, *args, **kwargs): + """ + Set phase based slope limiter for VOF compressive scheme. + """ + return PyMenu(self.service, "/solution/methods/phase_based_vof_discretization").execute(*args, **kwargs) + def reduced_rank_extrapolation(self, *args, **kwargs): + """ + Enable Reduced Rank Extrapolation method to accelerate solution time. + """ + return PyMenu(self.service, "/solution/methods/reduced_rank_extrapolation").execute(*args, **kwargs) + def reduced_rank_extrapolation_options(self, *args, **kwargs): + """ + Reduced Rank Extrapolation options. + """ + return PyMenu(self.service, "/solution/methods/reduced_rank_extrapolation_options").execute(*args, **kwargs) + def residual_smoothing(self, *args, **kwargs): + """ + Set residual smoothing factor and number of iterations. + """ + return PyMenu(self.service, "/solution/methods/residual_smoothing").execute(*args, **kwargs) + def set_solution_methods_to_default(self, *args, **kwargs): + """ + Set solution methods to default values. + """ + return PyMenu(self.service, "/solution/methods/set_solution_methods_to_default").execute(*args, **kwargs) + def unsteady_1st_order(self, *args, **kwargs): + """ + Enable/disable first-order unsteady solution model. + """ + return PyMenu(self.service, "/solution/methods/unsteady_1st_order").execute(*args, **kwargs) + def unsteady_2nd_order(self, *args, **kwargs): + """ + Enable/disable the second-order unsteady solution model. + """ + return PyMenu(self.service, "/solution/methods/unsteady_2nd_order").execute(*args, **kwargs) + def unsteady_2nd_order_bounded(self, *args, **kwargs): + """ + Enable/disable bounded second-order unsteady formulation. + """ + return PyMenu(self.service, "/solution/methods/unsteady_2nd_order_bounded").execute(*args, **kwargs) + def unsteady_global_time(self, *args, **kwargs): + """ + Enable/disable the unsteady global-time-step solution model. + """ + return PyMenu(self.service, "/solution/methods/unsteady_global_time").execute(*args, **kwargs) + def vof_numerics(self, *args, **kwargs): + """ + Set VOF numeric options. + """ + return PyMenu(self.service, "/solution/methods/vof_numerics").execute(*args, **kwargs) + + class expert(TUIMenu): + """ + Enter expert menu. """ def __init__(self, path, service): self.path = path self.service = service - def set_verbosity(self, *args, **kwargs): + super().__init__(path, service) + def reactions(self, *args, **kwargs): """ - Setting this to 1, enables the verbosity for NITA diagnostics. The default value of 0 disables verbosity output for NITA diagnostics. + Enable/disable the species reaction sources and set relaxation factor. """ - return PyMenu(self.service, "/solve/set/nita_expert_controls/set_verbosity").execute(*args, **kwargs) - def skewness_neighbor_coupling(self, *args, **kwargs): + return PyMenu(self.service, "/solution/methods/expert/reactions").execute(*args, **kwargs) + def numerics(self, *args, **kwargs): + """ + Set numeric options. + """ + return PyMenu(self.service, "/solution/methods/expert/numerics").execute(*args, **kwargs) + + class high_order_term_relaxation(TUIMenu): + """ + Enter High Order Relaxation Menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.options = self.__class__.options(path + [("options", None)], service) + super().__init__(path, service) + def enable(self, *args, **kwargs): """ - Enables/disables coupling of the neighbor and skewness corrections. + Enable/Disable High Order Term Relaxation. """ - return PyMenu(self.service, "/solve/set/nita_expert_controls/skewness_neighbor_coupling").execute(*args, **kwargs) - def hybrid_nita_settings(self, *args, **kwargs): + return PyMenu(self.service, "/solution/methods/high_order_term_relaxation/enable").execute(*args, **kwargs) + + class options(TUIMenu): """ - Enables and sets hybrid NITA options. For more details, see . + High Order Term Relaxation Options. """ - return PyMenu(self.service, "/solve/set/nita_expert_controls/hybrid_nita_settings").execute(*args, **kwargs) + def __init__(self, path, service): + self.path = path + self.service = service + self.variables = self.__class__.variables(path + [("variables", None)], service) + super().__init__(path, service) + def relaxation_factor(self, *args, **kwargs): + """ + Sets relaxation factor. + """ + return PyMenu(self.service, "/solution/methods/high_order_term_relaxation/options/relaxation_factor").execute(*args, **kwargs) + def expert(self, *args, **kwargs): + """ + Enter high order relaxation option with respect to diffusion gradient. + """ + return PyMenu(self.service, "/solution/methods/high_order_term_relaxation/options/expert").execute(*args, **kwargs) + + class variables(TUIMenu): + """ + Select Variables. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def select(self, *args, **kwargs): + """ + Select variables for high order term relaxation. + """ + return PyMenu(self.service, "/solution/methods/high_order_term_relaxation/options/variables/select").execute(*args, **kwargs) - class multiphase_numerics(metaclass=PyMenuMeta): + class multiphase_numerics(TUIMenu): """ - Sets multiphase numerics options. + Enter the multiphase numerics options menu. """ def __init__(self, path, service): self.path = path @@ -40108,82 +29157,87 @@ def __init__(self, path, service): self.default_controls = self.__class__.default_controls(path + [("default_controls", None)], service) self.face_pressure_controls = self.__class__.face_pressure_controls(path + [("face_pressure_controls", None)], service) self.solution_stabilization = self.__class__.solution_stabilization(path + [("solution_stabilization", None)], service) + super().__init__(path, service) - class porous_media(metaclass=PyMenuMeta): + class porous_media(TUIMenu): """ - Enters the porous media numerics menu. + Multiphase relative permeability numerics menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def relative_permeability(self, *args, **kwargs): """ - Allows you to fix the saturation (volume fraction) of the phase at its user-specified residual saturation value. + Multiphase relative permeability fix option. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/porous_media/relative_permeability").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/porous_media/relative_permeability").execute(*args, **kwargs) - class compressible_flow(metaclass=PyMenuMeta): + class compressible_flow(TUIMenu): """ - Enters the compressible multiphase flow numerics menu. + Multiphase compressible numerics options menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def enhanced_numerics(self, *args, **kwargs): """ - Enables an enhanced numerical treatment that provides better stability at startup and during calculation of compressible flows. + Multiphase enhanced compressible flow numerics options. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/compressible_flow/enhanced_numerics").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/compressible_flow/enhanced_numerics").execute(*args, **kwargs) def alternate_bc_formulation(self, *args, **kwargs): """ - Enables an alternative formulation for compressible phases at an inlet boundary. This formulation calculates static temperature and pressure using an iterative method based on fundamental thermodynamic relations. + Multiphase compressible flow BC alternate method. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/compressible_flow/alternate_bc_formulation").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/compressible_flow/alternate_bc_formulation").execute(*args, **kwargs) - class boiling_parameters(metaclass=PyMenuMeta): + class boiling_parameters(TUIMenu): """ - Enters the menu for the multiphase boiling model parameters. + Multiphase boiling parameters menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def thin_film(self, *args, **kwargs): """ - When enabled, includes multiphase boiling thin film effects using . + Multiphase boiling thin film effects. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/boiling_parameters/thin_film").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/boiling_parameters/thin_film").execute(*args, **kwargs) def liquid_vof_factor(self, *args, **kwargs): """ - When enabled, considers liquid volume fraction effects by multiplying the heat transfer coefficients by the local liquid volume fraction. + Multiphase boiling liquid volume fraction effects. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/boiling_parameters/liquid_vof_factor").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/boiling_parameters/liquid_vof_factor").execute(*args, **kwargs) - class viscous_flow(metaclass=PyMenuMeta): + class viscous_flow(TUIMenu): """ - Enters the viscous multiphase flow numerics menu. + Multiphase viscous flow numerics options menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def viscosity_averaging(self, *args, **kwargs): """ - Forces harmonic averaging of cell viscosities to calculate face viscosity used in momentum equation. This can improve convergence for highly viscous flow applications (the VOF model only). + Multiphase options for viscosity averaging. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/viscous_flow/viscosity_averaging").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/viscous_flow/viscosity_averaging").execute(*args, **kwargs) def turb_visc_based_damping(self, *args, **kwargs): """ Turbulence viscosity based damping controls. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/viscous_flow/turb_visc_based_damping").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/viscous_flow/turb_visc_based_damping").execute(*args, **kwargs) def interfacial_artificial_viscosity(self, *args, **kwargs): """ Interfacial artifical viscosity controls. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/viscous_flow/interfacial_artificial_viscosity").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/viscous_flow/interfacial_artificial_viscosity").execute(*args, **kwargs) - class heat_mass_transfer(metaclass=PyMenuMeta): + class heat_mass_transfer(TUIMenu): """ - Enters the menu for the multiphase heat mass transfer parameters. + Multiphase interphase heat and mass transfer numerics options menu. """ def __init__(self, path, service): self.path = path @@ -40192,132 +29246,139 @@ def __init__(self, path, service): self.evaporation_condensation = self.__class__.evaporation_condensation(path + [("evaporation_condensation", None)], service) self.boiling = self.__class__.boiling(path + [("boiling", None)], service) self.area_density = self.__class__.area_density(path + [("area_density", None)], service) + super().__init__(path, service) def alternative_energy_treatment(self, *args, **kwargs): """ - Enables the alternative treatment of the energy sources. For more information, see . + Alternative treatment of latent heat source due to mass transfer. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/alternative_energy_treatment").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/alternative_energy_treatment").execute(*args, **kwargs) - class cavitation(metaclass=PyMenuMeta): + class cavitation(TUIMenu): """ - Enters the cavitation heat mass transfer menu. + Cavitation numerics options menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def schnerr_evap_coeff(self, *args, **kwargs): """ - Sets the evaporation coefficient for the Schnerr-Sauer model ( in ). The default and recommended value of 1. + Evaporation coefficient for Schnerr-Sauer model. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/cavitation/schnerr_evap_coeff").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/cavitation/schnerr_evap_coeff").execute(*args, **kwargs) def schnerr_cond_coeff(self, *args, **kwargs): """ - Sets the condensation coefficient for the Schnerr-Sauer model ( in ). The default and recommended value of 0.2. + Condensation coefficient for Schnerr-Sauer model. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/cavitation/schnerr_cond_coeff").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/cavitation/schnerr_cond_coeff").execute(*args, **kwargs) def max_vapor_pressure_ratio(self, *args, **kwargs): """ - Sets the maximum limit on the vapor pressure after the turbulence and thermal correction. The default value is five times the vapor pressure, with consideration of turbulent and thermal effects for each cell and phase. + Maximum limit on vapor pressure after turbulence and thermal correction. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/cavitation/max_vapor_pressure_ratio").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/cavitation/max_vapor_pressure_ratio").execute(*args, **kwargs) def min_vapor_pressure(self, *args, **kwargs): """ - Sets the minimum vapor pressure limit for the cavitation mass-transfer model. The default value is 1 Pa. + Minimum vapor pressure limit for cavitation model. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/cavitation/min_vapor_pressure").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/cavitation/min_vapor_pressure").execute(*args, **kwargs) def display_clipped_pressure(self, *args, **kwargs): """ Clipped pressure is just used for the properties evaluation. Mass Transfer Rate uses unclipped pressure. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/cavitation/display_clipped_pressure").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/cavitation/display_clipped_pressure").execute(*args, **kwargs) def turbulent_diffusion(self, *args, **kwargs): """ - Enables/disables the turbulent diffusion treatment for a cavitating turbulent flow. See for details. + Enable/disable turbulent diffusion treatment between phases participating in cavitation. + This treatment is generally recommended for better solution stability. + However, in case of numerical difficulties, it can be disabled. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/cavitation/turbulent_diffusion").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/cavitation/turbulent_diffusion").execute(*args, **kwargs) - class evaporation_condensation(metaclass=PyMenuMeta): + class evaporation_condensation(TUIMenu): """ Evaporation-condensation advanced options menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def vof_from_min_limit(self, *args, **kwargs): """ Minimum volume fraction below which mass transfer rate is set to zero. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/evaporation_condensation/vof_from_min_limit").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/evaporation_condensation/vof_from_min_limit").execute(*args, **kwargs) def vof_from_max_limit(self, *args, **kwargs): """ Maximum volume fraction above which mass transfer rate is set to zero. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/evaporation_condensation/vof_from_max_limit").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/evaporation_condensation/vof_from_max_limit").execute(*args, **kwargs) def vof_to_min_limit(self, *args, **kwargs): """ Minimum volume fraction below which mass transfer rate is set to zero. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/evaporation_condensation/vof_to_min_limit").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/evaporation_condensation/vof_to_min_limit").execute(*args, **kwargs) def vof_to_max_limit(self, *args, **kwargs): """ Maximum volume fraction above which mass transfer rate is set to zero. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/evaporation_condensation/vof_to_max_limit").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/evaporation_condensation/vof_to_max_limit").execute(*args, **kwargs) def ia_norm_min_limit(self, *args, **kwargs): """ Minimum normalized area density below which mass transfer rate is set to zero. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/evaporation_condensation/ia_norm_min_limit").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/evaporation_condensation/ia_norm_min_limit").execute(*args, **kwargs) def max_rel_humidity(self, *args, **kwargs): """ Maximum value of relative humidity to limit condensation rate. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/evaporation_condensation/max_rel_humidity").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/evaporation_condensation/max_rel_humidity").execute(*args, **kwargs) - class boiling(metaclass=PyMenuMeta): + class boiling(TUIMenu): """ - Enters the menu for the advanced boiling options for the semi-mechanistic boiling model. + Boiling advanced options menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def heat_flux_relaxation_factor(self, *args, **kwargs): """ - Sets the under-relaxation factor for boiling heat flux. See for details. + Under-relaxation factor for boiling heat flux. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/boiling/heat_flux_relaxation_factor").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/boiling/heat_flux_relaxation_factor").execute(*args, **kwargs) def show_expert_options(self, *args, **kwargs): """ - Exposes the expert options for the semi-mechanistic boiling model. For more information about these options, see . + Exposes expert options of min/max superheat along with wetting fraction controls. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/boiling/show_expert_options").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/boiling/show_expert_options").execute(*args, **kwargs) def two_resistance_boiling_framework(self, *args, **kwargs): """ - Enables/disables the two-resistance boiling framework to improve the robustness and accuracy of the solution of cases with multiple boiling mechanisms. For more information about this item, see . + Allow generalized two-resistance framework for boiling model. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/boiling/two_resistance_boiling_framework").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/boiling/two_resistance_boiling_framework").execute(*args, **kwargs) - class area_density(metaclass=PyMenuMeta): + class area_density(TUIMenu): """ - Enters the menu for the area density. + Interfacial area density menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def vof_min_seeding(self, *args, **kwargs): """ - Sets the minimum volume fraction for the area density and cavitation. This may be useful, for example, in cases when a species mass transfer model (such as the Symmetric model or Particle model) do not consider evaporation or condensation if the volume fraction of one of the phases is zero. The seeding allows for a phase change to occur in the fluid flow. The default value is 1e-6. + Minimum vof seeding for non-zero area density in heat and mass transfer. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/area_density/vof_min_seeding").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/area_density/vof_min_seeding").execute(*args, **kwargs) def ia_grad_sym(self, *args, **kwargs): """ - Enables/disables the interfacial area density Gradient-Symmetric model. For more information about this model, see . + Interfacial area density gradient-symmetric mechanism. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/area_density/ia_grad_sym").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/heat_mass_transfer/area_density/ia_grad_sym").execute(*args, **kwargs) - class advanced_stability_controls(metaclass=PyMenuMeta): + class advanced_stability_controls(TUIMenu): """ - Enters the menu for the stability controls for multiphase flows. For more information about the below option, see and . + Stability controls for multiphase flow. """ def __init__(self, path, service): self.path = path @@ -40327,8 +29388,9 @@ def __init__(self, path, service): self.hybrid_nita = self.__class__.hybrid_nita(path + [("hybrid_nita", None)], service) self.equation_order = self.__class__.equation_order(path + [("equation_order", None)], service) self.anti_diffusion = self.__class__.anti_diffusion(path + [("anti_diffusion", None)], service) + super().__init__(path, service) - class pseudo_time(metaclass=PyMenuMeta): + class pseudo_time(TUIMenu): """ Pseudo-Time stability controls for multiphase flow. """ @@ -40336,58 +29398,60 @@ def __init__(self, path, service): self.path = path self.service = service self.auto_dt_advanced_controls = self.__class__.auto_dt_advanced_controls(path + [("auto_dt_advanced_controls", None)], service) + super().__init__(path, service) def smoothed_density_stabilization_method(self, *args, **kwargs): """ Set smoothed density stabilization method. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/pseudo_time/smoothed_density_stabilization_method").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/pseudo_time/smoothed_density_stabilization_method").execute(*args, **kwargs) def false_time_step_linearization(self, *args, **kwargs): """ Set false time-step linearization for added stability. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/pseudo_time/false_time_step_linearization").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/pseudo_time/false_time_step_linearization").execute(*args, **kwargs) - class auto_dt_advanced_controls(metaclass=PyMenuMeta): + class auto_dt_advanced_controls(TUIMenu): """ Set automatic time-stepping controls for better solution stability. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def enable(self, *args, **kwargs): """ Enable advanced automatic time stepping for better stability. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/enable").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/enable").execute(*args, **kwargs) def dt_init_limit(self, *args, **kwargs): """ Set maximum value for pseudo time step size during first iteration. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/dt_init_limit").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/dt_init_limit").execute(*args, **kwargs) def dt_max(self, *args, **kwargs): """ Set maximum value for pseudo time step size. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/dt_max").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/dt_max").execute(*args, **kwargs) def dt_factor_min(self, *args, **kwargs): """ Set minimum limit for reduction in pseudo time step size. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/dt_factor_min").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/dt_factor_min").execute(*args, **kwargs) def dt_factor_max(self, *args, **kwargs): """ Set maximum limit for increase in pseudo time step size. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/dt_factor_max").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/dt_factor_max").execute(*args, **kwargs) def max_velocity_ratio(self, *args, **kwargs): """ Set velocity ratio to freeze the time step size for better solution stability. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/max_velocity_ratio").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/max_velocity_ratio").execute(*args, **kwargs) - class p_v_coupling(metaclass=PyMenuMeta): + class p_v_coupling(TUIMenu): """ - Enters the menu for the pressure-velocity coupling controls. + Pressure velocity coupling controls for multiphase flow. """ def __init__(self, path, service): self.path = path @@ -40395,3488 +29459,5380 @@ def __init__(self, path, service): self.coupled_vof = self.__class__.coupled_vof(path + [("coupled_vof", None)], service) self.rhie_chow_flux = self.__class__.rhie_chow_flux(path + [("rhie_chow_flux", None)], service) self.skewness_correction = self.__class__.skewness_correction(path + [("skewness_correction", None)], service) + super().__init__(path, service) - class coupled_vof(metaclass=PyMenuMeta): + class coupled_vof(TUIMenu): """ - Enters the stability control menu for VOF cases that involve the Coupled pressure-velocity coupling scheme. + Set Coupled VOF stability controls. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def buoyancy_force_linearization(self, *args, **kwargs): """ - Allows you to use the linearized buoyancy force and the blended treatment for the buoyancy force. + Set buoynacy force linerization options in coupled vof. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/p_v_coupling/coupled_vof/buoyancy_force_linearization").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/p_v_coupling/coupled_vof/buoyancy_force_linearization").execute(*args, **kwargs) - class rhie_chow_flux(metaclass=PyMenuMeta): + class rhie_chow_flux(TUIMenu): """ - Enters the stability controls menu for the Rhie-Chow interpolation. + Set Rhie-Chow related stability controls. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def low_order_rhie_chow(self, *args, **kwargs): """ - Enables/disables the low-order velocity interpolation in the flux calculation. + Use low order velocity interpolation in flux calculation. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/p_v_coupling/rhie_chow_flux/low_order_rhie_chow").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/p_v_coupling/rhie_chow_flux/low_order_rhie_chow").execute(*args, **kwargs) - class skewness_correction(metaclass=PyMenuMeta): + class skewness_correction(TUIMenu): """ - Enters the skewness correction menu. + Skewness correction related stabiity controls for multiphase flow. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def limit_pressure_correction_gradient(self, *args, **kwargs): """ - Enables/disables the limited pressure correction gradient in skewness terms for the PISO, SIMPLEC, or fractional step pressure-coupling schemes. + Use limited pressure correction gradient in skewness corrections for better stability. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/p_v_coupling/skewness_correction/limit_pressure_correction_gradient").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/p_v_coupling/skewness_correction/limit_pressure_correction_gradient").execute(*args, **kwargs) - class hybrid_nita(metaclass=PyMenuMeta): + class hybrid_nita(TUIMenu): """ - Enters the equation order menu for homogeneous multiphase flow models. + Hybrid NITA stability controls for multiphase flow. """ def __init__(self, path, service): self.path = path self.service = service self.instability_detector = self.__class__.instability_detector(path + [("instability_detector", None)], service) + super().__init__(path, service) def outer_iterations(self, *args, **kwargs): """ - Sets the number of outer iterations. + Set number of outer iterations in hybrid nita. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/hybrid_nita/outer_iterations").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/hybrid_nita/outer_iterations").execute(*args, **kwargs) def initial_outer_iterations(self, *args, **kwargs): """ - Allows you to change the number of initial time-steps and the number of initial outer iterations to control solution stability. + Set hybrid nita start-up controls. """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/hybrid_nita/initial_outer_iterations").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/hybrid_nita/initial_outer_iterations").execute(*args, **kwargs) + + class instability_detector(TUIMenu): + """ + Set Hybrid NITA instability detector controls. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable_instability_detector(self, *args, **kwargs): + """ + Enable instability detector for better stability. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/enable_instability_detector").execute(*args, **kwargs) + def set_cfl_limit(self, *args, **kwargs): + """ + Set Courant Number limit for detection of unstable event. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/set_cfl_limit").execute(*args, **kwargs) + def set_cfl_type(self, *args, **kwargs): + """ + Set Courant Number type for detection of unstable event. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/set_cfl_type").execute(*args, **kwargs) + def set_velocity_limit(self, *args, **kwargs): + """ + Set velocity limit for detection of unstable event. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/set_velocity_limit").execute(*args, **kwargs) + def unstable_event_outer_iterations(self, *args, **kwargs): + """ + Set number of outer iterations for unstable event. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/unstable_event_outer_iterations").execute(*args, **kwargs) + + class equation_order(TUIMenu): + """ + Equation Order Menu for Homogeneous Multiphase Flow Models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def solve_flow_last(self, *args, **kwargs): + """ + Solve flow equation at the end of iteration as an alternative. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/equation_order/solve_flow_last").execute(*args, **kwargs) + def solve_exp_vof_at_end(self, *args, **kwargs): + """ + Solve Explicit VOF at the end of time-step as an alternative. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/equation_order/solve_exp_vof_at_end").execute(*args, **kwargs) + + class anti_diffusion(TUIMenu): + """ + Anti Diffusion Menu for VOF/Multi-Fluid VOF Models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable_dynamic_strength(self, *args, **kwargs): + """ + Enable dynamic strength to reduce compression in the tangential direction to the interface. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/anti_diffusion/enable_dynamic_strength").execute(*args, **kwargs) + def set_dynamic_strength_exponent(self, *args, **kwargs): + """ + Set cosine exponent in dynamic strength treatment. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/anti_diffusion/set_dynamic_strength_exponent").execute(*args, **kwargs) + def set_maximum_dynamic_strength(self, *args, **kwargs): + """ + Set maximum value of dynamic anti-diffusion strength. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/advanced_stability_controls/anti_diffusion/set_maximum_dynamic_strength").execute(*args, **kwargs) + + class default_controls(TUIMenu): + """ + Multiphase default controls menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def recommended_defaults_for_existing_cases(self, *args, **kwargs): + """ + Activate multiphase defaults for loaded case. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/default_controls/recommended_defaults_for_existing_cases").execute(*args, **kwargs) + def revert_to_pre_r20_point_1_default_settings(self, *args, **kwargs): + """ + Revert to pre-R20.1 multiphase flow default settings. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/default_controls/revert_to_pre_r20_point_1_default_settings").execute(*args, **kwargs) + + class face_pressure_controls(TUIMenu): + """ + Enter the face pressure expert controls menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def face_pressure_options(self, *args, **kwargs): + """ + Set face pressure options. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/face_pressure_controls/face_pressure_options").execute(*args, **kwargs) + + class solution_stabilization(TUIMenu): + """ + VOF solution stabilization menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.additional_stabilization_controls = self.__class__.additional_stabilization_controls(path + [("additional_stabilization_controls", None)], service) + self.velocity_limiting_treatment = self.__class__.velocity_limiting_treatment(path + [("velocity_limiting_treatment", None)], service) + super().__init__(path, service) + def execute_settings_optimization(self, *args, **kwargs): + """ + Execute optimized settings for VOF. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/execute_settings_optimization").execute(*args, **kwargs) + def execute_advanced_stabilization(self, *args, **kwargs): + """ + Execute advanced stabilization for VOF. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/execute_advanced_stabilization").execute(*args, **kwargs) + def execute_additional_stability_controls(self, *args, **kwargs): + """ + Execute additional stability controls for VOF. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/execute_additional_stability_controls").execute(*args, **kwargs) + + class additional_stabilization_controls(TUIMenu): + """ + Additional advanced stability controls for VOF. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def blended_compressive_scheme(self, *args, **kwargs): + """ + Blended Compressive discretization scheme for VOF. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/additional_stabilization_controls/blended_compressive_scheme").execute(*args, **kwargs) + def pseudo_time_stabilization(self, *args, **kwargs): + """ + Pseudo-Time Momentum stabilization and False Time Step Linearization methods for VOF. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/additional_stabilization_controls/pseudo_time_stabilization").execute(*args, **kwargs) + + class velocity_limiting_treatment(TUIMenu): + """ + Velocity limiting related stabiity controls for VOF. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable_velocity_limiting(self, *args, **kwargs): + """ + Enable velocity limiting treatment. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/enable_velocity_limiting").execute(*args, **kwargs) + def set_velocity_and_vof_cutoffs(self, *args, **kwargs): + """ + Set phase based velocity limiting controls. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/set_velocity_and_vof_cutoffs").execute(*args, **kwargs) + def set_damping_strengths(self, *args, **kwargs): + """ + Set phase based damping strength. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/set_damping_strengths").execute(*args, **kwargs) + def set_velocity_cutoff(self, *args, **kwargs): + """ + Enter max velocity magnitude. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/set_velocity_cutoff").execute(*args, **kwargs) + def set_damping_strength(self, *args, **kwargs): + """ + Enter damping strength. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/set_damping_strength").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Enable verbosity to print number of velocity limited cells during iterations. + """ + return PyMenu(self.service, "/solution/methods/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/verbosity").execute(*args, **kwargs) + + class nita_expert_controls(TUIMenu): + """ + Enter the nita expert controls menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def set_verbosity(self, *args, **kwargs): + """ + Set nita verbosity option. + """ + return PyMenu(self.service, "/solution/methods/nita_expert_controls/set_verbosity").execute(*args, **kwargs) + def skewness_neighbor_coupling(self, *args, **kwargs): + """ + Set skewness neighbor coupling for nita. + """ + return PyMenu(self.service, "/solution/methods/nita_expert_controls/skewness_neighbor_coupling").execute(*args, **kwargs) + def hybrid_nita_settings(self, *args, **kwargs): + """ + Select a hybrid NITA settings option for faster performance and better robustness. + """ + return PyMenu(self.service, "/solution/methods/nita_expert_controls/hybrid_nita_settings").execute(*args, **kwargs) + + class overset(TUIMenu): + """ + Enter overset solver options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.expert = self.__class__.expert(path + [("expert", None)], service) + super().__init__(path, service) + def high_order_pressure(self, *args, **kwargs): + """ + High order pressure extrapolation at overset interface. + """ + return PyMenu(self.service, "/solution/methods/overset/high_order_pressure").execute(*args, **kwargs) + def interpolation_method(self, *args, **kwargs): + """ + Choose the interpolation method for overset interface(s). + """ + return PyMenu(self.service, "/solution/methods/overset/interpolation_method").execute(*args, **kwargs) + def orphan_cell_treatment(self, *args, **kwargs): + """ + Enable solver to run with orphans present. + """ + return PyMenu(self.service, "/solution/methods/overset/orphan_cell_treatment").execute(*args, **kwargs) + + class expert(TUIMenu): + """ + Enter overset expert solver options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def mass_flux_correction_method(self, *args, **kwargs): + """ + Enter mass flux correction option at overset interfaces. + """ + return PyMenu(self.service, "/solution/methods/overset/expert/mass_flux_correction_method").execute(*args, **kwargs) + def hybrid_mode_selection(self, *args, **kwargs): + """ + Mode for hybrid interpolation. + """ + return PyMenu(self.service, "/solution/methods/overset/expert/hybrid_mode_selection").execute(*args, **kwargs) + + class pseudo_time_method(TUIMenu): + """ + Enter the pseudo time method menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def formulation(self, *args, **kwargs): + """ + Select the pseudo time step size formulation for the pseudo time method. + """ + return PyMenu(self.service, "/solution/methods/pseudo_time_method/formulation").execute(*args, **kwargs) + def local_time_step_settings(self, *args, **kwargs): + """ + Adjust the settings for the local time step formulation. + """ + return PyMenu(self.service, "/solution/methods/pseudo_time_method/local_time_step_settings").execute(*args, **kwargs) + def global_time_step_settings(self, *args, **kwargs): + """ + Adjust the settings for the global time step formulation. + """ + return PyMenu(self.service, "/solution/methods/pseudo_time_method/global_time_step_settings").execute(*args, **kwargs) + def advanced_options(self, *args, **kwargs): + """ + Enter the advanced options menu to define pseudo time settings for equations. + """ + return PyMenu(self.service, "/solution/methods/pseudo_time_method/advanced_options").execute(*args, **kwargs) + def relaxation_factors(self, *args, **kwargs): + """ + Enter the relaxation factors menu to set the pseudo time explicit relaxation factors for equations. + """ + return PyMenu(self.service, "/solution/methods/pseudo_time_method/relaxation_factors").execute(*args, **kwargs) + def relaxation_method(self, *args, **kwargs): + """ + Select relaxation definition for pseudo time method. + """ + return PyMenu(self.service, "/solution/methods/pseudo_time_method/relaxation_method").execute(*args, **kwargs) + def relaxation_bounds(self, *args, **kwargs): + """ + Select relaxation bounding scheme for pseudo time method. + """ + return PyMenu(self.service, "/solution/methods/pseudo_time_method/relaxation_bounds").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Set the verbosity for the pseudo time method. + """ + return PyMenu(self.service, "/solution/methods/pseudo_time_method/verbosity").execute(*args, **kwargs) + + class query(TUIMenu): + """ + Enter methods query menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def discretization_scheme(self, *args, **kwargs): + """ + Enter the discretization-scheme menu. + """ + return PyMenu(self.service, "/solution/methods/query/discretization_scheme").execute(*args, **kwargs) + def p_v_coupling(self, *args, **kwargs): + """ + Get the pressure velocity coupling scheme. + """ + return PyMenu(self.service, "/solution/methods/query/p_v_coupling").execute(*args, **kwargs) + + class warped_face_gradient_correction(TUIMenu): + """ + Enter warped-face-gradient-correction menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable(self, *args, **kwargs): + """ + Enable Warped-Face Gradient Correction. + """ + return PyMenu(self.service, "/solution/methods/warped_face_gradient_correction/enable").execute(*args, **kwargs) + def turbulence_options(self, *args, **kwargs): + """ + Set turbulence Warped Face Gradient Correction. + """ + return PyMenu(self.service, "/solution/methods/warped_face_gradient_correction/turbulence_options").execute(*args, **kwargs) - class instability_detector(metaclass=PyMenuMeta): - """ - Enters the menu for the instability detector controls. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable_instability_detector(self, *args, **kwargs): - """ - Enables/disables the instability detector to deal with possible instability problems. Once this option is enabled, additional instability detection options become available. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/enable_instability_detector").execute(*args, **kwargs) - def set_cfl_limit(self, *args, **kwargs): - """ - Sets the Courant number limit for detecting unstable events. This command becomes available once the enable-instability-detector? text option has been enabled. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/set_cfl_limit").execute(*args, **kwargs) - def set_cfl_type(self, *args, **kwargs): - """ - Selects the CFL number type for detection of an unstable event. This command becomes available once the enable-instability-detector? text option has been enabled. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/set_cfl_type").execute(*args, **kwargs) - def set_velocity_limit(self, *args, **kwargs): - """ - Sets the velocity limit for detecting unstable events. This command becomes available once the enable-instability-detector? text option has been enabled. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/set_velocity_limit").execute(*args, **kwargs) - def unstable_event_outer_iterations(self, *args, **kwargs): - """ - Sets the number of outer iterations for an unstable event. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/unstable_event_outer_iterations").execute(*args, **kwargs) + class monitors(TUIMenu): + """ + Enter the monitors menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self._ = self.__class__._(path + [("_", None)], service) + self.__ = self.__class__.__(path + [("__", None)], service) + self.report_files = self.__class__.report_files(path + [("report_files", None)], service) + self.report_plots = self.__class__.report_plots(path + [("report_plots", None)], service) + self.residual = self.__class__.residual(path + [("residual", None)], service) + super().__init__(path, service) + def convergence_conditions(self, *args, **kwargs): + """ + Manage convergence report. + """ + return PyMenu(self.service, "/solution/monitors/convergence_conditions").execute(*args, **kwargs) + def set_average_over(self, *args, **kwargs): + """ + Set the average over input for monitors. + """ + return PyMenu(self.service, "/solution/monitors/set_average_over").execute(*args, **kwargs) - class equation_order(metaclass=PyMenuMeta): - """ - Enters the equation order menu for homogeneous multiphase flow models. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def solve_flow_last(self, *args, **kwargs): - """ - When enabled, solves the flow equation at the end of the iteration. This improves the behavior at the start of new time-step if the solution does not converge properly. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/equation_order/solve_flow_last").execute(*args, **kwargs) - def solve_exp_vof_at_end(self, *args, **kwargs): - """ - Solve Explicit VOF at the end of time-step as an alternative. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/equation_order/solve_exp_vof_at_end").execute(*args, **kwargs) + class _(TUIMenu): + """ + Enter the convergence menu to add surface, volume, drag, lift and moment monitors to convergence criteria. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add_edit(self, *args, **kwargs): + """ + Add or edit convergence criterion for surface, volume, drag, lift and moment monitors. + """ + return PyMenu(self.service, "/solution/monitors/_/add_edit").execute(*args, **kwargs) + def frequency(self, *args, **kwargs): + """ + To set how often convergence checks are done with respect to iterations or time steps. + """ + return PyMenu(self.service, "/solution/monitors/_/frequency").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + List defined convergence criteria for monitors. + """ + return PyMenu(self.service, "/solution/monitors/_/list").execute(*args, **kwargs) + def condition(self, *args, **kwargs): + """ + Option to stop the calculations. All convergence conditions are met or any convergence condition is met. + """ + return PyMenu(self.service, "/solution/monitors/_/condition").execute(*args, **kwargs) + def average_over_last_n_iterations_timesteps(self, *args, **kwargs): + """ + Option to average over previous values for checking convergence. + """ + return PyMenu(self.service, "/solution/monitors/_/average_over_last_n_iterations_timesteps").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Delete a monitor from convergence criteria. + """ + return PyMenu(self.service, "/solution/monitors/_/delete").execute(*args, **kwargs) - class anti_diffusion(metaclass=PyMenuMeta): - """ - Enters the anti-diffusion menu. This item is available for VOF cases with the Interfacial Anti-Diffusion option enabled. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable_dynamic_strength(self, *args, **kwargs): - """ - Enables dynamic strength to reduce compression in the direction tangential to the interface. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/anti_diffusion/enable_dynamic_strength").execute(*args, **kwargs) - def set_dynamic_strength_exponent(self, *args, **kwargs): - """ - Sets the cosine exponent in the dynamic strength treatment in ). - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/anti_diffusion/set_dynamic_strength_exponent").execute(*args, **kwargs) - def set_maximum_dynamic_strength(self, *args, **kwargs): - """ - Sets the maximum value of dynamic anti-diffusion strength in ). - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/anti_diffusion/set_maximum_dynamic_strength").execute(*args, **kwargs) + class __(TUIMenu): + """ + Enter the statistic monitors menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def monitors(self, *args, **kwargs): + """ + Choose which statistics to monitor as printed and/or plotted output. + """ + return PyMenu(self.service, "/solution/monitors/__/monitors").execute(*args, **kwargs) + def plot(self, *args, **kwargs): + """ + Enable/disable plotting of statistics during iteration. + """ + return PyMenu(self.service, "/solution/monitors/__/plot").execute(*args, **kwargs) + def print(self, *args, **kwargs): + """ + Enable/disable printing of statistics during iteration. + """ + return PyMenu(self.service, "/solution/monitors/__/print").execute(*args, **kwargs) + def write(self, *args, **kwargs): + """ + Enable/disable writing of statistics during iteration. + """ + return PyMenu(self.service, "/solution/monitors/__/write").execute(*args, **kwargs) + def window(self, *args, **kwargs): + """ + Specify first window in which statistics will be plotted during iteration. + Multiple statistics are plotted in separate windows, beginning with this one. + """ + return PyMenu(self.service, "/solution/monitors/__/window").execute(*args, **kwargs) + def file_basename(self, *args, **kwargs): + """ + Specify the file basename and extension. The name of the individual monitor will be insterted automatically. + """ + return PyMenu(self.service, "/solution/monitors/__/file_basename").execute(*args, **kwargs) + def x_axis(self, *args, **kwargs): + """ + Choose what quantity to use on the abscissa in the plot and in the data written to files. + """ + return PyMenu(self.service, "/solution/monitors/__/x_axis").execute(*args, **kwargs) - class default_controls(metaclass=PyMenuMeta): + class report_files(TUIMenu): + """ + Manage report files. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add(self, *args, **kwargs): """ - Enters the default controls menu. This menu is available only for multiphase flows. + Add a new object. """ - def __init__(self, path, service): - self.path = path - self.service = service - def recommended_defaults_for_existing_cases(self, *args, **kwargs): - """ - Applies the multiphase defaults (version 2020 R1) to the loaded case file. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/default_controls/recommended_defaults_for_existing_cases").execute(*args, **kwargs) - def revert_to_pre_r20_point_1_default_settings(self, *args, **kwargs): - """ - Revert to pre-R20.1 multiphase flow default settings. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/default_controls/revert_to_pre_r20_point_1_default_settings").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/monitors/report_files/add").execute(*args, **kwargs) + def clear_data(self, *args, **kwargs): + """ + Delete the report file from the system. + """ + return PyMenu(self.service, "/solution/monitors/report_files/clear_data").execute(*args, **kwargs) + def delete_all(self, *args, **kwargs): + """ + Delete all report file objects. + """ + return PyMenu(self.service, "/solution/monitors/report_files/delete_all").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edit an object. + """ + return PyMenu(self.service, "/solution/monitors/report_files/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Delete an object. + """ + return PyMenu(self.service, "/solution/monitors/report_files/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + List objects. + """ + return PyMenu(self.service, "/solution/monitors/report_files/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + List properties of an object. + """ + return PyMenu(self.service, "/solution/monitors/report_files/list_properties").execute(*args, **kwargs) - class face_pressure_controls(metaclass=PyMenuMeta): + class report_plots(TUIMenu): + """ + Manage report plots. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add(self, *args, **kwargs): """ - Enter the face pressure expert controls menu. + Add a new object. """ - def __init__(self, path, service): - self.path = path - self.service = service - def face_pressure_options(self, *args, **kwargs): - """ - Set face pressure options. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/face_pressure_controls/face_pressure_options").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/monitors/report_plots/add").execute(*args, **kwargs) + def axes(self, *args, **kwargs): + """ + Set axes options of an object. + """ + return PyMenu(self.service, "/solution/monitors/report_plots/axes").execute(*args, **kwargs) + def clear_data(self, *args, **kwargs): + """ + Clear report plot data. + """ + return PyMenu(self.service, "/solution/monitors/report_plots/clear_data").execute(*args, **kwargs) + def curves(self, *args, **kwargs): + """ + Set curves options of an object. + """ + return PyMenu(self.service, "/solution/monitors/report_plots/curves").execute(*args, **kwargs) + def delete_all(self, *args, **kwargs): + """ + Delete all plot objects. + """ + return PyMenu(self.service, "/solution/monitors/report_plots/delete_all").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edit an object. + """ + return PyMenu(self.service, "/solution/monitors/report_plots/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Delete an object. + """ + return PyMenu(self.service, "/solution/monitors/report_plots/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + List objects. + """ + return PyMenu(self.service, "/solution/monitors/report_plots/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + List properties of an object. + """ + return PyMenu(self.service, "/solution/monitors/report_plots/list_properties").execute(*args, **kwargs) + def plot(self, *args, **kwargs): + """ + Plot. + """ + return PyMenu(self.service, "/solution/monitors/report_plots/plot").execute(*args, **kwargs) - class solution_stabilization(metaclass=PyMenuMeta): + class residual(TUIMenu): + """ + Enter the residual monitors menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def check_convergence(self, *args, **kwargs): """ - Enters the solution-stabilization numerics menu. This item is available only for the VOF model. + Choose which currently-monitored residuals + should be checked for convergence. """ - def __init__(self, path, service): - self.path = path - self.service = service - self.additional_stabilization_controls = self.__class__.additional_stabilization_controls(path + [("additional_stabilization_controls", None)], service) - self.velocity_limiting_treatment = self.__class__.velocity_limiting_treatment(path + [("velocity_limiting_treatment", None)], service) - def execute_settings_optimization(self, *args, **kwargs): - """ - Execute optimized settings for VOF. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/execute_settings_optimization").execute(*args, **kwargs) - def execute_advanced_stabilization(self, *args, **kwargs): - """ - When enabled, modifies solver settings for improved solution stability. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/execute_advanced_stabilization").execute(*args, **kwargs) - def execute_additional_stability_controls(self, *args, **kwargs): - """ - When enabled, uses additional controls for improved solution stability. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/execute_additional_stability_controls").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/monitors/residual/check_convergence").execute(*args, **kwargs) + def convergence_criteria(self, *args, **kwargs): + """ + Set convergence criteria for residuals which are + currently being both monitored and checked. + """ + return PyMenu(self.service, "/solution/monitors/residual/convergence_criteria").execute(*args, **kwargs) + def criterion_type(self, *args, **kwargs): + """ + Set convergence criterion type. + """ + return PyMenu(self.service, "/solution/monitors/residual/criterion_type").execute(*args, **kwargs) + def monitor(self, *args, **kwargs): + """ + Choose which residuals to monitor as printed and/or plotted output. + """ + return PyMenu(self.service, "/solution/monitors/residual/monitor").execute(*args, **kwargs) + def enhanced_continuity_residual(self, *args, **kwargs): + """ + Scale the continuity residuals locally based on the enhanced formulation. + """ + return PyMenu(self.service, "/solution/monitors/residual/enhanced_continuity_residual").execute(*args, **kwargs) + def n_display(self, *args, **kwargs): + """ + Set the number of most recent residuals to display in plots. + """ + return PyMenu(self.service, "/solution/monitors/residual/n_display").execute(*args, **kwargs) + def n_maximize_norms(self, *args, **kwargs): + """ + Set the number of iterations through which normalization + factors will be maximized. + """ + return PyMenu(self.service, "/solution/monitors/residual/n_maximize_norms").execute(*args, **kwargs) + def normalization_factors(self, *args, **kwargs): + """ + Set normalization factors for currently-monitored residuals. + """ + return PyMenu(self.service, "/solution/monitors/residual/normalization_factors").execute(*args, **kwargs) + def normalize(self, *args, **kwargs): + """ + Choose whether or not to normalize residuals in printed and plotted output. + """ + return PyMenu(self.service, "/solution/monitors/residual/normalize").execute(*args, **kwargs) + def n_save(self, *args, **kwargs): + """ + Set number of residuals to be saved with data. + History is automatically compacted when buffer becomes full. + """ + return PyMenu(self.service, "/solution/monitors/residual/n_save").execute(*args, **kwargs) + def plot(self, *args, **kwargs): + """ + Choose whether or not residuals will be plotted during iteration. + """ + return PyMenu(self.service, "/solution/monitors/residual/plot").execute(*args, **kwargs) + def print(self, *args, **kwargs): + """ + Choose whether or not residuals will be printed during iteration. + """ + return PyMenu(self.service, "/solution/monitors/residual/print").execute(*args, **kwargs) + def relative_conv_criteria(self, *args, **kwargs): + """ + Set relative convergence criteria for residuals which are + currently being both monitored and checked. + """ + return PyMenu(self.service, "/solution/monitors/residual/relative_conv_criteria").execute(*args, **kwargs) + def re_normalize(self, *args, **kwargs): + """ + Renormalize residuals by maximum values. + """ + return PyMenu(self.service, "/solution/monitors/residual/re_normalize").execute(*args, **kwargs) + def reset(self, *args, **kwargs): + """ + Delete the residual history and reset iteration counter to unity. + """ + return PyMenu(self.service, "/solution/monitors/residual/reset").execute(*args, **kwargs) + def scale_by_coefficient(self, *args, **kwargs): + """ + Enable/disable scaling of residuals by coefficient sum in printed and plotted output. + """ + return PyMenu(self.service, "/solution/monitors/residual/scale_by_coefficient").execute(*args, **kwargs) - class additional_stabilization_controls(metaclass=PyMenuMeta): - """ - Enters the menu for additional advanced stability controls. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def blended_compressive_scheme(self, *args, **kwargs): - """ - Enables/disables the blended compressive discretization scheme. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/additional_stabilization_controls/blended_compressive_scheme").execute(*args, **kwargs) - def pseudo_time_stabilization(self, *args, **kwargs): - """ - Pseudo-Time Momentum stabilization and False Time Step Linearization methods for VOF. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/additional_stabilization_controls/pseudo_time_stabilization").execute(*args, **kwargs) + class report_definitions(TUIMenu): + """ + Manage report definitions. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add(self, *args, **kwargs): + """ + Add a new object. + """ + return PyMenu(self.service, "/solution/report_definitions/add").execute(*args, **kwargs) + def compute(self, *args, **kwargs): + """ + Computes selected report definition. + """ + return PyMenu(self.service, "/solution/report_definitions/compute").execute(*args, **kwargs) + def copy(self, *args, **kwargs): + """ + Makes a copy of selected report definition with new name. + """ + return PyMenu(self.service, "/solution/report_definitions/copy").execute(*args, **kwargs) + def delete_all(self, *args, **kwargs): + """ + Delete all report definition objects. + """ + return PyMenu(self.service, "/solution/report_definitions/delete_all").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edit an object. + """ + return PyMenu(self.service, "/solution/report_definitions/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Delete an object. + """ + return PyMenu(self.service, "/solution/report_definitions/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + List objects. + """ + return PyMenu(self.service, "/solution/report_definitions/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + List properties of an object. + """ + return PyMenu(self.service, "/solution/report_definitions/list_properties").execute(*args, **kwargs) + def rename(self, *args, **kwargs): + """ + Rename selected report definition with new name. + """ + return PyMenu(self.service, "/solution/report_definitions/rename").execute(*args, **kwargs) - class velocity_limiting_treatment(metaclass=PyMenuMeta): - """ - Enters the menu for the velocity-limiting-treatment. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable_velocity_limiting(self, *args, **kwargs): - """ - Enables/disables the velocity limiting treatment. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/enable_velocity_limiting").execute(*args, **kwargs) - def set_velocity_and_vof_cutoffs(self, *args, **kwargs): - """ - Set phase based velocity limiting controls. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/set_velocity_and_vof_cutoffs").execute(*args, **kwargs) - def set_damping_strengths(self, *args, **kwargs): - """ - Set phase based damping strength. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/set_damping_strengths").execute(*args, **kwargs) - def set_velocity_cutoff(self, *args, **kwargs): - """ - Specifies the maximum velocity magnitude. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/set_velocity_cutoff").execute(*args, **kwargs) - def set_damping_strength(self, *args, **kwargs): - """ - Enter damping strength. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/set_damping_strength").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - When enabled, the solver prints the number of velocity limited cells at each iteration. - """ - return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/verbosity").execute(*args, **kwargs) + class run_calculation(TUIMenu): + """ + Enter run calculation menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.data_sampling_options = self.__class__.data_sampling_options(path + [("data_sampling_options", None)], service) + self.transient_controls = self.__class__.transient_controls(path + [("transient_controls", None)], service) + super().__init__(path, service) + def adaptive_time_stepping(self, *args, **kwargs): + """ + Set Error-based adaptive time-stepping parameters. + """ + return PyMenu(self.service, "/solution/run_calculation/adaptive_time_stepping").execute(*args, **kwargs) + def cfl_based_adaptive_time_stepping(self, *args, **kwargs): + """ + Set CFL-based adaptive time-stepping parameters. + """ + return PyMenu(self.service, "/solution/run_calculation/cfl_based_adaptive_time_stepping").execute(*args, **kwargs) + def data_sampling(self, *args, **kwargs): + """ + Set iteration options. + """ + return PyMenu(self.service, "/solution/run_calculation/data_sampling").execute(*args, **kwargs) + def dual_time_iterate(self, *args, **kwargs): + """ + Perform unsteady iterations. + """ + return PyMenu(self.service, "/solution/run_calculation/dual_time_iterate").execute(*args, **kwargs) + def iterate(self, *args, **kwargs): + """ + Perform a specified number of iterations. + """ + return PyMenu(self.service, "/solution/run_calculation/iterate").execute(*args, **kwargs) + def max_corrections(self, *args, **kwargs): + """ + Enter the max-corrections menu. + """ + return PyMenu(self.service, "/solution/run_calculation/max_corrections").execute(*args, **kwargs) + def mesh_motion(self, *args, **kwargs): + """ + Perform mesh motion. + """ + return PyMenu(self.service, "/solution/run_calculation/mesh_motion").execute(*args, **kwargs) + def multistage_time_iterate(self, *args, **kwargs): + """ + Perform unsteady iterations. + """ + return PyMenu(self.service, "/solution/run_calculation/multistage_time_iterate").execute(*args, **kwargs) + def number_of_iterations(self, *args, **kwargs): + """ + Set number of iterations. + """ + return PyMenu(self.service, "/solution/run_calculation/number_of_iterations").execute(*args, **kwargs) + def reporting_interval(self, *args, **kwargs): + """ + Set number of solver iterations before returning to scheme. + """ + return PyMenu(self.service, "/solution/run_calculation/reporting_interval").execute(*args, **kwargs) + def residual_tolerance(self, *args, **kwargs): + """ + Enter the residual tolerance menu. + """ + return PyMenu(self.service, "/solution/run_calculation/residual_tolerance").execute(*args, **kwargs) + def residual_verbosity(self, *args, **kwargs): + """ + Set the residual report verbosity. + """ + return PyMenu(self.service, "/solution/run_calculation/residual_verbosity").execute(*args, **kwargs) + def second_order_time_options(self, *args, **kwargs): + """ + Set options for second-order time formulation. + """ + return PyMenu(self.service, "/solution/run_calculation/second_order_time_options").execute(*args, **kwargs) + def solution_steering(self, *args, **kwargs): + """ + Enable solution steering for density-based solver. + """ + return PyMenu(self.service, "/solution/run_calculation/solution_steering").execute(*args, **kwargs) + def set_solution_steering(self, *args, **kwargs): + """ + Set Solution Steering Parameters. + """ + return PyMenu(self.service, "/solution/run_calculation/set_solution_steering").execute(*args, **kwargs) + def summary(self, *args, **kwargs): + """ + Print report summary. + """ + return PyMenu(self.service, "/solution/run_calculation/summary").execute(*args, **kwargs) + def time_step(self, *args, **kwargs): + """ + Set the time step. + """ + return PyMenu(self.service, "/solution/run_calculation/time_step").execute(*args, **kwargs) + def update_physical_time(self, *args, **kwargs): + """ + Update the solution to the next physical time level. + """ + return PyMenu(self.service, "/solution/run_calculation/update_physical_time").execute(*args, **kwargs) + def variable_time_stepping(self, *args, **kwargs): + """ + Set Multiphase-Specific Adaptive time stepping parameters. + """ + return PyMenu(self.service, "/solution/run_calculation/variable_time_stepping").execute(*args, **kwargs) - class open_channel_wave_options(metaclass=PyMenuMeta): + class data_sampling_options(TUIMenu): """ - Sets buffer layer height, verbosity, and open channel wave theory formulation. + Data sampling options for statistics. """ def __init__(self, path, service): self.path = path self.service = service - def set_verbosity(self, *args, **kwargs): - """ - Sets the open channel wave verbosity. - """ - return PyMenu(self.service, "/solve/set/open_channel_wave_options/set_verbosity").execute(*args, **kwargs) - def stokes_wave_variants(self, *args, **kwargs): + super().__init__(path, service) + def add_datasets(self, *args, **kwargs): """ - Specifies which open channel wave theory formulation Fluent uses. + Add a dataset. After providing the zones for a dataset, press [Enter] to move onto selecting quantities. Enter () to complete the quantity selection for this dataset. """ - return PyMenu(self.service, "/solve/set/open_channel_wave_options/stokes_wave_variants").execute(*args, **kwargs) - def set_buffer_layer_ht(self, *args, **kwargs): + return PyMenu(self.service, "/solution/run_calculation/data_sampling_options/add_datasets").execute(*args, **kwargs) + def add_rtdft_datasets(self, *args, **kwargs): """ - Sets the buffer layer height. + Add a dataset. After providing the zones for a dataset, press [Enter] to move onto selecting quantities. Enter () to complete the quantity selection for this dataset. """ - return PyMenu(self.service, "/solve/set/open_channel_wave_options/set_buffer_layer_ht").execute(*args, **kwargs) - - class high_order_term_relaxation(metaclass=PyMenuMeta): - """ - Enter High Order Relaxation Menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.options = self.__class__.options(path + [("options", None)], service) - def enable(self, *args, **kwargs): + return PyMenu(self.service, "/solution/run_calculation/data_sampling_options/add_rtdft_datasets").execute(*args, **kwargs) + def remove_dataset(self, *args, **kwargs): """ - Enables/disables High Order Term Relaxation. + Remove dataset. """ - return PyMenu(self.service, "/solve/set/high_order_term_relaxation/enable").execute(*args, **kwargs) - - class options(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solution/run_calculation/data_sampling_options/remove_dataset").execute(*args, **kwargs) + def list_datasets(self, *args, **kwargs): """ - High Order Term Relaxation Options. + List dataset. """ - def __init__(self, path, service): - self.path = path - self.service = service - self.variables = self.__class__.variables(path + [("variables", None)], service) - def relaxation_factor(self, *args, **kwargs): - """ - Sets the relaxation factor. - """ - return PyMenu(self.service, "/solve/set/high_order_term_relaxation/options/relaxation_factor").execute(*args, **kwargs) - def expert(self, *args, **kwargs): - """ - Enter high order relaxation option with respect to diffusion gradient. - """ - return PyMenu(self.service, "/solve/set/high_order_term_relaxation/options/expert").execute(*args, **kwargs) - - class variables(metaclass=PyMenuMeta): - """ - Selects the variables. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def select(self, *args, **kwargs): - """ - Select variables for high order term relaxation. - """ - return PyMenu(self.service, "/solve/set/high_order_term_relaxation/options/variables/select").execute(*args, **kwargs) + return PyMenu(self.service, "/solution/run_calculation/data_sampling_options/list_datasets").execute(*args, **kwargs) - class poor_mesh_numerics(metaclass=PyMenuMeta): + class transient_controls(TUIMenu): """ - Enters the poor mesh numerics menu. + Enter into the transient controls menu. """ def __init__(self, path, service): self.path = path self.service = service - self.solution_based_pmn = self.__class__.solution_based_pmn(path + [("solution_based_pmn", None)], service) - def enable(self, *args, **kwargs): - """ - Enables/disables the application of poor mesh numerics on cells (those with an orthogonal quality of 0, as well as those identified by other enabled criteria), and defines whether the local solution correction is 0th, 1st, or 2nd order. + self.multiphase_specific_time_constraints = self.__class__.multiphase_specific_time_constraints(path + [("multiphase_specific_time_constraints", None)], service) + super().__init__(path, service) + def specified_time_step(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/poor_mesh_numerics/enable").execute(*args, **kwargs) - def cell_quality_based(self, *args, **kwargs): + Use specified time step or courant number. """ - Enables/disables the application of poor mesh numerics on cells with an orthogonal quality that is equal to or less than the threshold defined by the solve/set/poor-mesh-numerics/set-quality-threshold text command (which by default is set to 0.05). + return PyMenu(self.service, "/solution/run_calculation/transient_controls/specified_time_step").execute(*args, **kwargs) + def fixed_user_specified(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/poor_mesh_numerics/cell_quality_based").execute(*args, **kwargs) - def set_quality_threshold(self, *args, **kwargs): + Enable user-specified fixed time stepping method. """ - Sets the orthogonal quality threshold used for applying poor mesh numerics when the solve/set/poor-mesh-numerics/cell-quality-based? text command is enabled. By default, cells with an orthogonal quality of 0.05 or lower are corrected. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/fixed_user_specified").execute(*args, **kwargs) + def fixed_periodic(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/poor_mesh_numerics/set_quality_threshold").execute(*args, **kwargs) - def solution_and_quality_based(self, *args, **kwargs): + Set period- or frequency-based fixed time-stepping parameters. """ - Enables/disables the detection and treatment of poor cells using a criterion based on the solution and cell quality. Poor mesh numerics are applied when the criterion value is equal to or less than a threshold value defined as part of this text command, and at a specified frequency (of iterations or time steps). This criterion is only available with the pressure-based solver. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/fixed_periodic").execute(*args, **kwargs) + def duration_specification_method(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/poor_mesh_numerics/solution_and_quality_based").execute(*args, **kwargs) - def gradient_quality_based(self, *args, **kwargs): + Set Duration Specification Method: [0] Incremental Time Steps, [1] Total Time Steps, [2] Total Time, [3] Incremental Time. """ - Enables/disables the detection and treatment of poor cells using a criterion based on the cell gradient quality. Poor mesh numerics are applied when the criterion value is equal to or less than a threshold value defined as part of this text command. This criterion is only available with the pressure-based solver, and is not supported for cases that have periodic boundaries. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/duration_specification_method").execute(*args, **kwargs) + def incremental_time(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/poor_mesh_numerics/gradient_quality_based").execute(*args, **kwargs) - def orthogonality_enhancing_cell_centroids(self, *args, **kwargs): + Set Incremental Time. """ - Enables/disables the relocation of select cell centroids, to improve the orthogonality metrics and solution stability. It is applied to cells when the criterion value is equal to or less than a threshold value defined as part of the text command. Note that the enhanced metrics are only apparent when reporting the quality in the solution mode of Fluent, and not in the meshing mode. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/incremental_time").execute(*args, **kwargs) + def max_iterations_per_time_step(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/poor_mesh_numerics/orthogonality_enhancing_cell_centroids").execute(*args, **kwargs) - def user_defined_on_register(self, *args, **kwargs): + Set Max Iterations/Time step. """ - Includes a register for the poor mesh numerics or not. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/max_iterations_per_time_step").execute(*args, **kwargs) + def number_of_time_steps(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/poor_mesh_numerics/user_defined_on_register").execute(*args, **kwargs) - def reset_poor_elements(self, *args, **kwargs): + Set inceremtal number of Time steps. """ - Resets the list of poor cells included by the default, cell quality, user-defined, cell gradient quality, and solution and cell quality criteria. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/number_of_time_steps").execute(*args, **kwargs) + def total_number_of_time_steps(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/poor_mesh_numerics/reset_poor_elements").execute(*args, **kwargs) - def print_poor_elements_count(self, *args, **kwargs): + Set total number of Time steps. """ - Prints out a listing of the poor cells for each criterion: default, cell quality, and user-defined, and (if enabled) cell gradient quality and solution and cell quality. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/total_number_of_time_steps").execute(*args, **kwargs) + def total_time(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/poor_mesh_numerics/print_poor_elements_count").execute(*args, **kwargs) - def enhanced_pmn(self, *args, **kwargs): + Set Total Simulation Time. """ - This option is available with the density-based solver. When enabled, it will apply quality-based poor-mesh-numerics order=1 on any cells with a quality-measure below 0.2. In addition, their CFL number is limited to 1.0. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/total_time").execute(*args, **kwargs) + def time_step_size(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/poor_mesh_numerics/enhanced_pmn").execute(*args, **kwargs) - - class solution_based_pmn(metaclass=PyMenuMeta): + Set the physical time step size. """ - Solution based poor-mesh numerics menu. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/time_step_size").execute(*args, **kwargs) + def solution_status(self, *args, **kwargs): """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable(self, *args, **kwargs): - """ - Enable solution based treatment. - """ - return PyMenu(self.service, "/solve/set/poor_mesh_numerics/solution_based_pmn/enable").execute(*args, **kwargs) - def mark_primary_solution_limits(self, *args, **kwargs): - """ - Mark cells violating solution limits. - """ - return PyMenu(self.service, "/solve/set/poor_mesh_numerics/solution_based_pmn/mark_primary_solution_limits").execute(*args, **kwargs) - def mark_velocity_limit(self, *args, **kwargs): - """ - Mark cells exceeding velocity limit. - """ - return PyMenu(self.service, "/solve/set/poor_mesh_numerics/solution_based_pmn/mark_velocity_limit").execute(*args, **kwargs) - def mark_cfl_limit(self, *args, **kwargs): - """ - Mark cells exceeding cfl limit. - """ - return PyMenu(self.service, "/solve/set/poor_mesh_numerics/solution_based_pmn/mark_cfl_limit").execute(*args, **kwargs) - def mark_cfl_jump(self, *args, **kwargs): - """ - Mark cells exceeding cfl jump in neighborhood. - """ - return PyMenu(self.service, "/solve/set/poor_mesh_numerics/solution_based_pmn/mark_cfl_jump").execute(*args, **kwargs) - - class amg_options(metaclass=PyMenuMeta): - """ - Enters the AMG options menu - """ - def __init__(self, path, service): - self.path = path - self.service = service - def laplace_coarsening(self, *args, **kwargs): + Activate the simulation status panel. """ - Enables / disables Laplace coarsening for scalar and/or coupled equations. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/solution_status").execute(*args, **kwargs) + def extrapolate_vars(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/amg_options/laplace_coarsening").execute(*args, **kwargs) - def conservative_amg_coarsening(self, *args, **kwargs): + Applies a predictor algorithm for computing initial condition at time step n+1. """ - Enables / disables the use of conservative coarsening techniques for scalar and/or coupled equations that can improve parallel performance and/or convergence for some difficult cases. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/extrapolate_vars").execute(*args, **kwargs) + def extrapolate_eqn_vars(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/amg_options/conservative_amg_coarsening").execute(*args, **kwargs) - def aggressive_amg_coarsening(self, *args, **kwargs): + Enter the extrapolation menu. """ - Enables / disables the use of a version of the AMG solver that is optimized for high coarsening rates. This option is recommended if the AMG solver diverges with the default settings. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/extrapolate_eqn_vars").execute(*args, **kwargs) + def max_flow_time(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/amg_options/aggressive_amg_coarsening").execute(*args, **kwargs) - def amg_gpgpu_options(self, *args, **kwargs): + Set maximum flow time. """ - Set GPGPU AMG solver options. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/max_flow_time").execute(*args, **kwargs) + def cfl_based_time_stepping_advanced_options(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/amg_options/amg_gpgpu_options").execute(*args, **kwargs) - - class warped_face_gradient_correction(metaclass=PyMenuMeta): - """ - Enters the warped-face gradient correction menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable(self, *args, **kwargs): + Set CFL-based adaptive time-stepping advanced parameters. """ - Enables/disables gradient enhancement computations and specifies whether Fluent uses fast or memory saving mode. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/cfl_based_time_stepping_advanced_options").execute(*args, **kwargs) + def cfl_based_time_stepping(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/warped_face_gradient_correction/enable").execute(*args, **kwargs) - def turbulence_options(self, *args, **kwargs): + Set CFL-based adaptive time-stepping parameters. """ - Set turbulence Warped Face Gradient Correction. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/cfl_based_time_stepping").execute(*args, **kwargs) + def multiphase_specific_time_stepping(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/warped_face_gradient_correction/turbulence_options").execute(*args, **kwargs) - - class fast_transient_settings(metaclass=PyMenuMeta): - """ - Enters the fast transient settings menu. This menu is only available for transient cases that use the density-based solver. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def rk2(self, *args, **kwargs): + Set Multiphase-specific adaptive time stepping parameters. """ - Allows you to enable the use of a two-stage Runge-Kutta scheme for time integration, or revert to the default multi-stage Runge-Kutta scheme. This text command is only available for transient cases that use the density-based explicit formulation. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/multiphase_specific_time_stepping").execute(*args, **kwargs) + def udf_based_time_stepping(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/fast_transient_settings/rk2").execute(*args, **kwargs) - - class divergence_prevention(metaclass=PyMenuMeta): - """ - Enters the divergence prevention menu. This menu is only available for the density-based solver. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable(self, *args, **kwargs): + Set the time-stepping parameters for user-defined time stepping method. """ - Enables a divergence prevention option so that Fluent applies under-relaxation to the variables in select cells where the temperature and/or pressure values are approaching the minimum and/or maximum limits. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/udf_based_time_stepping").execute(*args, **kwargs) + def error_based_time_stepping(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/divergence_prevention/enable").execute(*args, **kwargs) - - class advanced(metaclass=PyMenuMeta): - """ - Enters the advanced settings menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.non_reflecting_boundary_treatment = self.__class__.non_reflecting_boundary_treatment(path + [("non_reflecting_boundary_treatment", None)], service) - self.secondary_gradient_limiting = self.__class__.secondary_gradient_limiting(path + [("secondary_gradient_limiting", None)], service) - self.turbo_solver_options = self.__class__.turbo_solver_options(path + [("turbo_solver_options", None)], service) - def energy_numerical_noise_filter(self, *args, **kwargs): + Set Error-based adaptive time-stepping parameters. """ - Enables/disables a filter to eliminate non-physical numerical noise in the energy field. Numerical noise can appear in solution fields where large variations in specific heat or combustion with phase change are present. Using the energy equation numerical noise filter increases robustness, but may make the solution slightly more diffusive. This text command is only available with the pressure-based solver. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/error_based_time_stepping").execute(*args, **kwargs) + def undo_timestep(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/advanced/energy_numerical_noise_filter").execute(*args, **kwargs) - def linearized_mass_transfer_udf(self, *args, **kwargs): + Undo the previous time step. """ - Enables/disables the use of a linearized mass transfer user-defined function (that is, the DEFINE_LINEARIZED_MASS_TRANSFER macro), as opposed to a mass transfer user-defined function (that is, the DEFINE_MASS_TRANSFER macro). + return PyMenu(self.service, "/solution/run_calculation/transient_controls/undo_timestep").execute(*args, **kwargs) + def predict_next_time(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/advanced/linearized_mass_transfer_udf").execute(*args, **kwargs) - def singhal_et_al_cavitation_model(self, *args, **kwargs): + Applies a predictor algorithm for computing initial condition at time step n+1. """ - Enables/disables the availability of the Singhal et al. cavitation model option, which can then be enabled in the Multiphase Model dialog box or by using the following text command: define/phases/set-domain-properties/interaction-domain/heat-mass-reaction/cavitation/cavitation?. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/predict_next_time").execute(*args, **kwargs) + def rotating_mesh_flow_predictor(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/advanced/singhal_et_al_cavitation_model").execute(*args, **kwargs) - def alternate_wall_temp_formulation(self, *args, **kwargs): + Improve prediction of flow field at time step n+1 for rotating mesh. """ - Enables/disables an alternate formulation for wall temperatures. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/rotating_mesh_flow_predictor").execute(*args, **kwargs) + def solid_time_step_size(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/advanced/alternate_wall_temp_formulation").execute(*args, **kwargs) - def retain_cell_residuals(self, *args, **kwargs): + Specify a different time step size for solid zones. """ - Enables/disables the retention of cell residuals for postprocessing. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/solid_time_step_size").execute(*args, **kwargs) + def time_step_size_for_acoustic_export(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/advanced/retain_cell_residuals").execute(*args, **kwargs) - def retain_temporary_solver_mem(self, *args, **kwargs): + Set number of time step size for acoustic export. """ - Enables/disables the retention of temporary solver memory, which retains gradient data and makes some advanced options available for postprocessing. + return PyMenu(self.service, "/solution/run_calculation/transient_controls/time_step_size_for_acoustic_export").execute(*args, **kwargs) + + class multiphase_specific_time_constraints(TUIMenu): """ - return PyMenu(self.service, "/solve/set/advanced/retain_temporary_solver_mem").execute(*args, **kwargs) - def show_all_discretization_schemes(self, *args, **kwargs): + Set Multiphase-specific time constraints. """ - Enables/disables the availability of all applicable discretization schemes. + def __init__(self, path, service): + self.path = path + self.service = service + self.time_scale_options = self.__class__.time_scale_options(path + [("time_scale_options", None)], service) + super().__init__(path, service) + def moving_mesh_cfl_constraint(self, *args, **kwargs): + """ + Enable time step size constraints based on moving mesh courant number. + """ + return PyMenu(self.service, "/solution/run_calculation/transient_controls/multiphase_specific_time_constraints/moving_mesh_cfl_constraint").execute(*args, **kwargs) + def physics_based_constraint(self, *args, **kwargs): + """ + Include physics driven time-step constraints. + """ + return PyMenu(self.service, "/solution/run_calculation/transient_controls/multiphase_specific_time_constraints/physics_based_constraint").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Set verbosity to print multiphase specific time scales. + """ + return PyMenu(self.service, "/solution/run_calculation/transient_controls/multiphase_specific_time_constraints/verbosity").execute(*args, **kwargs) + + class time_scale_options(TUIMenu): + """ + Set physics based time scale options. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def viscous_scale(self, *args, **kwargs): + """ + Include viscous time scale. + """ + return PyMenu(self.service, "/solution/run_calculation/transient_controls/multiphase_specific_time_constraints/time_scale_options/viscous_scale").execute(*args, **kwargs) + def gravity_scale(self, *args, **kwargs): + """ + Include gravity based time scale. + """ + return PyMenu(self.service, "/solution/run_calculation/transient_controls/multiphase_specific_time_constraints/time_scale_options/gravity_scale").execute(*args, **kwargs) + def surface_tension_scale(self, *args, **kwargs): + """ + Include surface tension based time scale. + """ + return PyMenu(self.service, "/solution/run_calculation/transient_controls/multiphase_specific_time_constraints/time_scale_options/surface_tension_scale").execute(*args, **kwargs) + def acoustic_scale(self, *args, **kwargs): + """ + Include acoustic time scale. + """ + return PyMenu(self.service, "/solution/run_calculation/transient_controls/multiphase_specific_time_constraints/time_scale_options/acoustic_scale").execute(*args, **kwargs) + + class solve(TUIMenu): + """ + Enter the solve menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.animate = self.__class__.animate(path + [("animate", None)], service) + self.initialize = self.__class__.initialize(path + [("initialize", None)], service) + self.monitors = self.__class__.monitors(path + [("monitors", None)], service) + self.report_files = self.__class__.report_files(path + [("report_files", None)], service) + self.report_definitions = self.__class__.report_definitions(path + [("report_definitions", None)], service) + self.report_plots = self.__class__.report_plots(path + [("report_plots", None)], service) + self.cell_registers = self.__class__.cell_registers(path + [("cell_registers", None)], service) + self.cell_register_operations = self.__class__.cell_register_operations(path + [("cell_register_operations", None)], service) + self.set = self.__class__.set(path + [("set", None)], service) + self.execute_commands = self.__class__.execute_commands(path + [("execute_commands", None)], service) + super().__init__(path, service) + def patch(self, *args, **kwargs): + """ + Patches a value for a flow variable in the domain. You can either provide a numerical value, which you can enter directly, or you can enter an expression, which must be entered within quotation marks. + """ + return PyMenu(self.service, "/solve/patch").execute(*args, **kwargs) + def iterate(self, *args, **kwargs): + """ + Performs a specified number of iterations. This option is still available during transient simulations, since it can be used to add more iterations to the same time step after interrupting iterations within a time step. + """ + return PyMenu(self.service, "/solve/iterate").execute(*args, **kwargs) + def iterate_steady_2way_fsi(self, *args, **kwargs): + """ + Perform a specified number of steps. + """ + return PyMenu(self.service, "/solve/iterate_steady_2way_fsi").execute(*args, **kwargs) + def convergence_conditions(self, *args, **kwargs): + """ + Enters the convergence conditions menu. + """ + return PyMenu(self.service, "/solve/convergence_conditions").execute(*args, **kwargs) + def dpm_update(self, *args, **kwargs): + """ + Updates discrete phase source terms. + """ + return PyMenu(self.service, "/solve/dpm_update").execute(*args, **kwargs) + def dual_time_iterate(self, *args, **kwargs): + """ + Performs unsteady iterations for a specified number of time steps. + """ + return PyMenu(self.service, "/solve/dual_time_iterate").execute(*args, **kwargs) + def multistage_time_iterate(self, *args, **kwargs): + """ + Perform unsteady iterations. + """ + return PyMenu(self.service, "/solve/multistage_time_iterate").execute(*args, **kwargs) + def update_physical_time(self, *args, **kwargs): + """ + Advances the unsteady solution to the next physical time level. Using this command in conjunction with theiterate command allows you to manually advance the solution in time (rather than doing it automatically with the dual-time-iterate command). + """ + return PyMenu(self.service, "/solve/update_physical_time").execute(*args, **kwargs) + def mesh_motion(self, *args, **kwargs): + """ + Performs mesh motion. + """ + return PyMenu(self.service, "/solve/mesh_motion").execute(*args, **kwargs) + + class animate(TUIMenu): + """ + Enters the animation menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.define = self.__class__.define(path + [("define", None)], service) + self.playback = self.__class__.playback(path + [("playback", None)], service) + self.objects = self.__class__.objects(path + [("objects", None)], service) + self.pulse = self.__class__.pulse(path + [("pulse", None)], service) + super().__init__(path, service) + + class define(TUIMenu): + """ + Enters the animation definition menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def define_monitor(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/advanced/show_all_discretization_schemes").execute(*args, **kwargs) - def explicit_under_relaxation_value(self, *args, **kwargs): + Defines new animation. """ - Explicit under-relaxation value. + return PyMenu(self.service, "/solve/animate/define/define_monitor").execute(*args, **kwargs) + def edit_monitor(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/advanced/explicit_under_relaxation_value").execute(*args, **kwargs) - def correction_form(self, *args, **kwargs): + Changes animation monitor attributes. """ - S + return PyMenu(self.service, "/solve/animate/define/edit_monitor").execute(*args, **kwargs) + + class playback(TUIMenu): + """ + Enters the animation playback menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.video = self.__class__.video(path + [("video", None)], service) + super().__init__(path, service) + def read(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/advanced/correction_form").execute(*args, **kwargs) - def energy_reconstruction_gradient_limiting(self, *args, **kwargs): + Reads new animation from file or already defined animations. """ - Enable limiting of reconstruction gradient for the energy equation. + return PyMenu(self.service, "/solve/animate/playback/read").execute(*args, **kwargs) + def play(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/advanced/energy_reconstruction_gradient_limiting").execute(*args, **kwargs) - def bcd_boundedness(self, *args, **kwargs): + Plays the selected animation. """ - Specifies the BCD scheme parameter, which controls the boundedness strength of the BCD scheme in the pressure-based solver, as described in . + return PyMenu(self.service, "/solve/animate/playback/play").execute(*args, **kwargs) + def write(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/advanced/bcd_boundedness").execute(*args, **kwargs) - def bcd_weights_freeze(self, *args, **kwargs): + Writes animation sequence to the file. """ - Enables/disables freezing of weighting coefficients of the central differencing and the upwind components of the BCD scheme. This dialog command requires the iteration number, after which the BCD scheme weights are to be frozen at each timestep. Freezing the BCD weighting coefficients may help to improve convergence of the timestep iterations as described in . + return PyMenu(self.service, "/solve/animate/playback/write").execute(*args, **kwargs) + def delete(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/advanced/bcd_weights_freeze").execute(*args, **kwargs) - def anisotropic_heat_flux(self, *args, **kwargs): + Deletes animation sequence. """ - Select the heat flux calculation methods. + return PyMenu(self.service, "/solve/animate/playback/delete").execute(*args, **kwargs) + def stored_view(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/advanced/anisotropic_heat_flux").execute(*args, **kwargs) - def skewness_correction_enhanced(self, *args, **kwargs): + Plays the 3D animation sequence using the view stored in the sequence. """ - Enable enhanced skewness correction scheme. + return PyMenu(self.service, "/solve/animate/playback/stored_view").execute(*args, **kwargs) + def set_custom_frames(self, *args, **kwargs): """ - return PyMenu(self.service, "/solve/set/advanced/skewness_correction_enhanced").execute(*args, **kwargs) + Specify a custom start frame, increment, and end frame for video export. + """ + return PyMenu(self.service, "/solve/animate/playback/set_custom_frames").execute(*args, **kwargs) - class non_reflecting_boundary_treatment(metaclass=PyMenuMeta): + class video(TUIMenu): """ - Enter non reflecting boundary treatment using minimal pressure reflection approach menu. + Enters the video menu. """ def __init__(self, path, service): self.path = path self.service = service - def pressure_inlet(self, *args, **kwargs): + self.advance_quality = self.__class__.advance_quality(path + [("advance_quality", None)], service) + super().__init__(path, service) + def fps(self, *args, **kwargs): """ - Enabling the use of minimal pressure reflection treatment. This treatment will minimize pressure wave reflections from the boundaries on which this option is active, but not necessarily fully eliminating them. The reflections would be of an acceptable limit in order to not contaminate the solution, the simulation will gain from the robustness of the new algorithm compared to traditional non-reflecting boundary condition treatment. + Sets the target frames per second (FPS) for the saved video file. """ - return PyMenu(self.service, "/solve/set/advanced/non_reflecting_boundary_treatment/pressure_inlet").execute(*args, **kwargs) - def pressure_outlet(self, *args, **kwargs): + return PyMenu(self.service, "/solve/animate/playback/video/fps").execute(*args, **kwargs) + def format(self, *args, **kwargs): """ - Enabling the use of minimal pressure reflection treatment. This treatment will minimize pressure wave reflections from the boundaries on which this option is active, but not necessarily fully eliminating them. The reflections would be of an acceptable limit in order to not contaminate the solution, the simulation will gain from the robustness of the new algorithm compared to traditional non-reflecting boundary condition treatment. + Specifies what format the video file will be written in (MP4 | AVI | FLV | MOV | MPEG). """ - return PyMenu(self.service, "/solve/set/advanced/non_reflecting_boundary_treatment/pressure_outlet").execute(*args, **kwargs) - def velocity_inlet(self, *args, **kwargs): + return PyMenu(self.service, "/solve/animate/playback/video/format").execute(*args, **kwargs) + def quality(self, *args, **kwargs): """ - Enabling the use of minimal pressure reflection treatment. This treatment will minimize pressure wave reflections from the boundaries on which this option is active, but not necessarily fully eliminating them. The reflections would be of an acceptable limit in order to not contaminate the solution, the simulation will gain from the robustness of the new algorithm compared to traditional non-reflecting boundary condition treatment. + Set quality for exporting video file. """ - return PyMenu(self.service, "/solve/set/advanced/non_reflecting_boundary_treatment/velocity_inlet").execute(*args, **kwargs) - - class secondary_gradient_limiting(metaclass=PyMenuMeta): - """ - Enters the secondary gradient limiting menu. This menu is only available when the define/models/solver/pressure-based text command is enabled. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def energy(self, *args, **kwargs): + return PyMenu(self.service, "/solve/animate/playback/video/quality").execute(*args, **kwargs) + def name(self, *args, **kwargs): """ - Enables/disables secondary gradient limiting for the energy calculations on coupled two-sided walls. This limiting can help prevent divergence when the cells on such walls have poor orthogonality. + Sets the name of the saved video file. """ - return PyMenu(self.service, "/solve/set/advanced/secondary_gradient_limiting/energy").execute(*args, **kwargs) - def uds(self, *args, **kwargs): + return PyMenu(self.service, "/solve/animate/playback/video/name").execute(*args, **kwargs) + def use_original_resolution(self, *args, **kwargs): """ - Enables/disables secondary gradient limiting for the user-defined scalar (UDS) calculations on coupled two-sided walls. This limiting can help prevent divergence when the cells on such walls have poor orthogonality. + Controls whether the resolution of the saved video file matches that of the images used to create it. """ - return PyMenu(self.service, "/solve/set/advanced/secondary_gradient_limiting/uds").execute(*args, **kwargs) - def mesh_quality_limits(self, *args, **kwargs): + return PyMenu(self.service, "/solve/animate/playback/video/use_original_resolution").execute(*args, **kwargs) + def scale(self, *args, **kwargs): """ - Defines the mesh quality limits used when applying secondary gradient limiting to faces on coupled two-sided walls. Shifting this range closer to 1 will decrease the risk of divergence, but at the cost of accuracy. + Expands or collapses the resolution based on this scaling factor. """ - return PyMenu(self.service, "/solve/set/advanced/secondary_gradient_limiting/mesh_quality_limits").execute(*args, **kwargs) - - class turbo_solver_options(metaclass=PyMenuMeta): - """ - Enter turbo expert solver options menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable(self, *args, **kwargs): + return PyMenu(self.service, "/solve/animate/playback/video/scale").execute(*args, **kwargs) + def set_standard_resolution(self, *args, **kwargs): """ - Enable/disable turbomachinery expert solver options. + Select from pre-defined resolution list. """ - return PyMenu(self.service, "/solve/set/advanced/turbo_solver_options/enable").execute(*args, **kwargs) - def continuity_relaxation_at_walls(self, *args, **kwargs): + return PyMenu(self.service, "/solve/animate/playback/video/set_standard_resolution").execute(*args, **kwargs) + def width(self, *args, **kwargs): """ - Enable and specify options for continuity relaxation at wall boundaries. + Set the width for exporting video file. """ - return PyMenu(self.service, "/solve/set/advanced/turbo_solver_options/continuity_relaxation_at_walls").execute(*args, **kwargs) + return PyMenu(self.service, "/solve/animate/playback/video/width").execute(*args, **kwargs) + def height(self, *args, **kwargs): + """ + Set the height for exporting video file. + """ + return PyMenu(self.service, "/solve/animate/playback/video/height").execute(*args, **kwargs) - class high_speed_numerics(metaclass=PyMenuMeta): - """ - Enter high-speed-numerics menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def enable(self, *args, **kwargs): - """ - Enables/disables High Speed Numerics. - """ - return PyMenu(self.service, "/solve/set/high_speed_numerics/enable").execute(*args, **kwargs) - def expert(self, *args, **kwargs): - """ - Sets the level of stabilization used to achieve fast convergence. Enter a number 0-5 corresponding to the Mach number range that best characterizes the flow. - """ - return PyMenu(self.service, "/solve/set/high_speed_numerics/expert").execute(*args, **kwargs) - def visualize_pressure_discontinuity_sensor(self, *args, **kwargs): - """ - Makes available the Pressure Discontinuity Sensor which is a binary identifier equal to 1 if a cell is in proximity of a pressure discontinuity. - """ - return PyMenu(self.service, "/solve/set/high_speed_numerics/visualize_pressure_discontinuity_sensor").execute(*args, **kwargs) + class advance_quality(TUIMenu): + """ + Advance Quality setting. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def bitrate_scale(self, *args, **kwargs): + """ + Mp4 bitrate scale - Best-64000 High-32000 Medium-16000 Low-8000. + """ + return PyMenu(self.service, "/solve/animate/playback/video/advance_quality/bitrate_scale").execute(*args, **kwargs) + def enable_h264(self, *args, **kwargs): + """ + H264 encoding flag. + """ + return PyMenu(self.service, "/solve/animate/playback/video/advance_quality/enable_h264").execute(*args, **kwargs) + def bitrate(self, *args, **kwargs): + """ + Set video bitrate(kbits/sec) for exporting video file. + """ + return PyMenu(self.service, "/solve/animate/playback/video/advance_quality/bitrate").execute(*args, **kwargs) + def compression_method(self, *args, **kwargs): + """ + Compression methode for Microsoft AVI movie. + """ + return PyMenu(self.service, "/solve/animate/playback/video/advance_quality/compression_method").execute(*args, **kwargs) + def keyframe(self, *args, **kwargs): + """ + Set video keyframe rate for exporting video file. + """ + return PyMenu(self.service, "/solve/animate/playback/video/advance_quality/keyframe").execute(*args, **kwargs) - class previous_defaults(metaclass=PyMenuMeta): + class objects(TUIMenu): """ - Provides text commands that allow you to undo enhancements to the default solver behavior. + Enters the object manipulation menu. """ def __init__(self, path, service): self.path = path self.service = service - def undo_r19_point_0_default_changes(self, *args, **kwargs): - """ - Undo default changes introduced in R19.0. - """ - return PyMenu(self.service, "/solve/set/previous_defaults/undo_r19_point_0_default_changes").execute(*args, **kwargs) - def undo_2019r1_default_changes(self, *args, **kwargs): + super().__init__(path, service) + def create(self, *args, **kwargs): """ - Allows you to undo enhancements introduced in version 2019 R1 of ANSYS Fluent, including: + Creates new solution animation object. """ - return PyMenu(self.service, "/solve/set/previous_defaults/undo_2019r1_default_changes").execute(*args, **kwargs) - def undo_2019r3_default_changes(self, *args, **kwargs): + return PyMenu(self.service, "/solve/animate/objects/create").execute(*args, **kwargs) + def edit(self, *args, **kwargs): """ - Allows you to undo enhancements introduced in version 2019 R3 of ANSYS Fluent, including: + Edits solution animation object. """ - return PyMenu(self.service, "/solve/set/previous_defaults/undo_2019r3_default_changes").execute(*args, **kwargs) - def undo_2021r1_default_changes(self, *args, **kwargs): + return PyMenu(self.service, "/solve/animate/objects/edit").execute(*args, **kwargs) + def copy(self, *args, **kwargs): """ - Allows you to undo enhancements introduced in version 2021 R1 of ANSYS Fluent, including: + Copies solution animation object. """ - return PyMenu(self.service, "/solve/set/previous_defaults/undo_2021r1_default_changes").execute(*args, **kwargs) - def undo_2021r2_default_changes(self, *args, **kwargs): + return PyMenu(self.service, "/solve/animate/objects/copy").execute(*args, **kwargs) + def delete(self, *args, **kwargs): """ - Allows you to undo the following enhancements introduced in version 2021 R2 of ANSYS Fluent: + Deletes solution animation object. """ - return PyMenu(self.service, "/solve/set/previous_defaults/undo_2021r2_default_changes").execute(*args, **kwargs) - def undo_2022r1_default_changes(self, *args, **kwargs): + return PyMenu(self.service, "/solve/animate/objects/delete").execute(*args, **kwargs) + def clear_history(self, *args, **kwargs): """ - Allows you to undo the following enhancements introduced in version 2022 R1 of ANSYS Fluent: + Clears solution animation object history. """ - return PyMenu(self.service, "/solve/set/previous_defaults/undo_2022r1_default_changes").execute(*args, **kwargs) + return PyMenu(self.service, "/solve/animate/objects/clear_history").execute(*args, **kwargs) - class overset(metaclass=PyMenuMeta): + class pulse(TUIMenu): """ - Specifies overset meshing solver options. + Enter the pulse animation menu (only available when one or more particle track or pathline graphics objects are defined). """ def __init__(self, path, service): self.path = path self.service = service - self.expert = self.__class__.expert(path + [("expert", None)], service) - def high_order_pressure(self, *args, **kwargs): - """ - Uses the pressure gradient of the donor cell in the interpolation of pressure for its receptor cell. - """ - return PyMenu(self.service, "/solve/set/overset/high_order_pressure").execute(*args, **kwargs) - def interpolation_method(self, *args, **kwargs): + self.video = self.__class__.video(path + [("video", None)], service) + self.hardcopy = self.__class__.hardcopy(path + [("hardcopy", None)], service) + super().__init__(path, service) + def pulse_mode(self, *args, **kwargs): """ - Selects the interpolation method for overset interfaces. Note that the least squares method is recommended for sliding mesh cases. + Set whether the pulse is a single pulse or continuous. """ - return PyMenu(self.service, "/solve/set/overset/interpolation_method").execute(*args, **kwargs) - def orphan_cell_treatment(self, *args, **kwargs): + return PyMenu(self.service, "/solve/animate/pulse/pulse_mode").execute(*args, **kwargs) + def write(self, *args, **kwargs): """ - Enables/disables a numerical treatment that attempts to assign reasonable data values to orphan cells. + Select a pathline or particle track graphics object, specify whether you want to write a video file or picture files, and enter the destination directory for the files. Continuous pulse animations result in a 5 second video. Single pulse animations run for a full cycle. """ - return PyMenu(self.service, "/solve/set/overset/orphan_cell_treatment").execute(*args, **kwargs) + return PyMenu(self.service, "/solve/animate/pulse/write").execute(*args, **kwargs) - class expert(metaclass=PyMenuMeta): + class video(TUIMenu): """ - Enter overset expert solver options menu. + Enter the video window options menu. """ def __init__(self, path, service): self.path = path self.service = service - def mass_flux_correction_method(self, *args, **kwargs): + self.advance_quality = self.__class__.advance_quality(path + [("advance_quality", None)], service) + super().__init__(path, service) + def fps(self, *args, **kwargs): """ - Enter mass flux correction option at overset interfaces. + Set the Frame Per Sec(FPS) for exporting video file. """ - return PyMenu(self.service, "/solve/set/overset/expert/mass_flux_correction_method").execute(*args, **kwargs) - def hybrid_mode_selection(self, *args, **kwargs): + return PyMenu(self.service, "/solve/animate/pulse/video/fps").execute(*args, **kwargs) + def format(self, *args, **kwargs): """ - Mode for hybrid interpolation. + Set format for exporting video file. """ - return PyMenu(self.service, "/solve/set/overset/expert/hybrid_mode_selection").execute(*args, **kwargs) + return PyMenu(self.service, "/solve/animate/pulse/video/format").execute(*args, **kwargs) + def quality(self, *args, **kwargs): + """ + Set quality for exporting video file. + """ + return PyMenu(self.service, "/solve/animate/pulse/video/quality").execute(*args, **kwargs) + def name(self, *args, **kwargs): + """ + Exporting video file name. + """ + return PyMenu(self.service, "/solve/animate/pulse/video/name").execute(*args, **kwargs) + def use_original_resolution(self, *args, **kwargs): + """ + Enable original resolution. + """ + return PyMenu(self.service, "/solve/animate/pulse/video/use_original_resolution").execute(*args, **kwargs) + def scale(self, *args, **kwargs): + """ + Set scale by which video resolution will expand. + """ + return PyMenu(self.service, "/solve/animate/pulse/video/scale").execute(*args, **kwargs) + def set_standard_resolution(self, *args, **kwargs): + """ + Select from pre-defined resolution list. + """ + return PyMenu(self.service, "/solve/animate/pulse/video/set_standard_resolution").execute(*args, **kwargs) + def width(self, *args, **kwargs): + """ + Set the width for exporting video file. + """ + return PyMenu(self.service, "/solve/animate/pulse/video/width").execute(*args, **kwargs) + def height(self, *args, **kwargs): + """ + Set the height for exporting video file. + """ + return PyMenu(self.service, "/solve/animate/pulse/video/height").execute(*args, **kwargs) - class acoustics_wave_equation_controls(metaclass=PyMenuMeta): - """ - Enters the menu to specify parameters of the acoustics wave equation solver. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.expert = self.__class__.expert(path + [("expert", None)], service) - def relative_convergence_criterion(self, *args, **kwargs): - """ - Specify convergence tolerance for the timestep iterations - as the target residual reduction factor. - """ - return PyMenu(self.service, "/solve/set/acoustics_wave_equation_controls/relative_convergence_criterion").execute(*args, **kwargs) - def max_iterations_per_timestep(self, *args, **kwargs): - """ - Specify maximum number of iterations per timestep. - """ - return PyMenu(self.service, "/solve/set/acoustics_wave_equation_controls/max_iterations_per_timestep").execute(*args, **kwargs) + class advance_quality(TUIMenu): + """ + Advance Quality setting. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def bitrate_scale(self, *args, **kwargs): + """ + Mp4 bitrate scale - Best-64000 High-32000 Medium-16000 Low-8000. + """ + return PyMenu(self.service, "/solve/animate/pulse/video/advance_quality/bitrate_scale").execute(*args, **kwargs) + def enable_h264(self, *args, **kwargs): + """ + H264 encoding flag. + """ + return PyMenu(self.service, "/solve/animate/pulse/video/advance_quality/enable_h264").execute(*args, **kwargs) + def bitrate(self, *args, **kwargs): + """ + Set video bitrate(kbits/sec) for exporting video file. + """ + return PyMenu(self.service, "/solve/animate/pulse/video/advance_quality/bitrate").execute(*args, **kwargs) + def compression_method(self, *args, **kwargs): + """ + Compression methode for Microsoft AVI movie. + """ + return PyMenu(self.service, "/solve/animate/pulse/video/advance_quality/compression_method").execute(*args, **kwargs) + def keyframe(self, *args, **kwargs): + """ + Set video keyframe rate for exporting video file. + """ + return PyMenu(self.service, "/solve/animate/pulse/video/advance_quality/keyframe").execute(*args, **kwargs) - class expert(metaclass=PyMenuMeta): + class hardcopy(TUIMenu): """ - Enters the menu to specify the expert parameters. + Hardcopy options menu. """ def __init__(self, path, service): self.path = path self.service = service - def under_relaxation_factor(self, *args, **kwargs): + self.color_mode = self.__class__.color_mode(path + [("color_mode", None)], service) + self.driver = self.__class__.driver(path + [("driver", None)], service) + super().__init__(path, service) + def invert_background(self, *args, **kwargs): """ - Specifies the implicit under-relaxation factor. Should be used only with bad meshes, when the AMG linear solver does not converge. + Use a white background when the picture is saved. """ - return PyMenu(self.service, "/solve/set/acoustics_wave_equation_controls/expert/under_relaxation_factor").execute(*args, **kwargs) - def explicit_relaxation_factor(self, *args, **kwargs): + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/invert_background").execute(*args, **kwargs) + def landscape(self, *args, **kwargs): """ - Specifies the explicit relaxation factor. Should be used only with bad meshes, when iterations do not converge. + Plot hardcopies in landscape or portrait orientation. """ - return PyMenu(self.service, "/solve/set/acoustics_wave_equation_controls/expert/explicit_relaxation_factor").execute(*args, **kwargs) + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/landscape").execute(*args, **kwargs) + def preview(self, *args, **kwargs): + """ + Display a preview image of a hardcopy. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/preview").execute(*args, **kwargs) + def x_resolution(self, *args, **kwargs): + """ + Set the width of raster-formatted images in pixels (0 implies current window size). + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/x_resolution").execute(*args, **kwargs) + def y_resolution(self, *args, **kwargs): + """ + Set the height of raster-formatted images in pixels (0 implies current window size). + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/y_resolution").execute(*args, **kwargs) + def dpi(self, *args, **kwargs): + """ + Set the DPI for EPS and Postscript files, specifies the resolution in dots per inch (DPI) instead of setting the width and height. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/dpi").execute(*args, **kwargs) + def use_window_resolution(self, *args, **kwargs): + """ + Use the currently active window's resolution for hardcopy (ignores the x-resolution and y-resolution in this case). + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/use_window_resolution").execute(*args, **kwargs) + def set_standard_resolution(self, *args, **kwargs): + """ + Select from pre-defined resolution list. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/set_standard_resolution").execute(*args, **kwargs) + def jpeg_hardcopy_quality(self, *args, **kwargs): + """ + To set jpeg hardcopy quality. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/jpeg_hardcopy_quality").execute(*args, **kwargs) - class p_v_controls_advanced(metaclass=PyMenuMeta): - """ - Set advanced pressure-velocity coupling controls. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def pp_face_gradient_linearization(self, *args, **kwargs): - """ - End of pp-face-gradient-linearization. - """ - return PyMenu(self.service, "/solve/set/p_v_controls_advanced/pp_face_gradient_linearization").execute(*args, **kwargs) - def pp_face_interpolation(self, *args, **kwargs): - """ - End of pp-face-interpolation. - """ - return PyMenu(self.service, "/solve/set/p_v_controls_advanced/pp_face_interpolation").execute(*args, **kwargs) - def pp_node_based_grad(self, *args, **kwargs): - """ - End of pp-node-based-grad. - """ - return PyMenu(self.service, "/solve/set/p_v_controls_advanced/pp_node_based_grad").execute(*args, **kwargs) + class color_mode(TUIMenu): + """ + Enter the hardcopy color mode menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def color(self, *args, **kwargs): + """ + Plot hardcopies in color. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/color_mode/color").execute(*args, **kwargs) + def gray_scale(self, *args, **kwargs): + """ + Convert color to grayscale for hardcopy. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/color_mode/gray_scale").execute(*args, **kwargs) + def mono_chrome(self, *args, **kwargs): + """ + Convert color to monochrome (black and white) for hardcopy. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/color_mode/mono_chrome").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Display the current hardcopy color mode. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/color_mode/list").execute(*args, **kwargs) - class execute_commands(metaclass=PyMenuMeta): - """ - Enters the execute commands menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def add_edit(self, *args, **kwargs): - """ - Adds or edits execute commands. - """ - return PyMenu(self.service, "/solve/execute_commands/add_edit").execute(*args, **kwargs) - def enable(self, *args, **kwargs): - """ - Enables an execute command. - """ - return PyMenu(self.service, "/solve/execute_commands/enable").execute(*args, **kwargs) - def disable(self, *args, **kwargs): - """ - Disables an execute command. - """ - return PyMenu(self.service, "/solve/execute_commands/disable").execute(*args, **kwargs) - def copy(self, *args, **kwargs): - """ - Copy an execute-command. - """ - return PyMenu(self.service, "/solve/execute_commands/copy").execute(*args, **kwargs) - def delete(self, *args, **kwargs): - """ - Delete an execute-command. - """ - return PyMenu(self.service, "/solve/execute_commands/delete").execute(*args, **kwargs) - def export(self, *args, **kwargs): - """ - Export execute-commands to a TSV file. - """ - return PyMenu(self.service, "/solve/execute_commands/export").execute(*args, **kwargs) - def import_(self, *args, **kwargs): - """ - Import execute-commands from a TSV file. - """ - return PyMenu(self.service, "/solve/execute_commands/import").execute(*args, **kwargs) + class driver(TUIMenu): + """ + Enter the set hardcopy driver menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.post_format = self.__class__.post_format(path + [("post_format", None)], service) + super().__init__(path, service) + def dump_window(self, *args, **kwargs): + """ + Set the command used to dump the graphics window to a file. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/dump_window").execute(*args, **kwargs) + def eps(self, *args, **kwargs): + """ + Produce encapsulated PostScript (EPS) output for hardcopies. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/eps").execute(*args, **kwargs) + def jpeg(self, *args, **kwargs): + """ + Produce JPEG output for hardcopies. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/jpeg").execute(*args, **kwargs) + def post_script(self, *args, **kwargs): + """ + Produce PostScript output for hardcopies. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/post_script").execute(*args, **kwargs) + def ppm(self, *args, **kwargs): + """ + Produce PPM output for hardcopies. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/ppm").execute(*args, **kwargs) + def tiff(self, *args, **kwargs): + """ + Use TIFF output for hardcopies. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/tiff").execute(*args, **kwargs) + def png(self, *args, **kwargs): + """ + Use PNG output for hardcopies. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/png").execute(*args, **kwargs) + def hsf(self, *args, **kwargs): + """ + Use HSF output for hardcopies. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/hsf").execute(*args, **kwargs) + def avz(self, *args, **kwargs): + """ + Use AVZ output for hardcopies. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/avz").execute(*args, **kwargs) + def glb(self, *args, **kwargs): + """ + Use GLB output for hardcopies. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/glb").execute(*args, **kwargs) + def vrml(self, *args, **kwargs): + """ + Use VRML output for hardcopies. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/vrml").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + List the current hardcopy driver. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/list").execute(*args, **kwargs) + def options(self, *args, **kwargs): + """ + Set the hardcopy options. Available options are: + \\n "no gamma correction", disables gamma correction of colors, + \\n "physical size = (width,height)", where width and height + are the actual measurements of the printable area of the page + in centimeters. + \\n "subscreen = (left,right,bottom,top)", where left,right, + bottom, and top are numbers in [-1,1] describing a subwindow on + the page in which to place the hardcopy. + + \\n The options may be combined by separating them with commas. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/options").execute(*args, **kwargs) - class setup(metaclass=PyMenuMeta): - """ - Enter setup menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.boundary_conditions = self.__class__.boundary_conditions(path + [("boundary_conditions", None)], service) - self.dynamic_mesh = self.__class__.dynamic_mesh(path + [("dynamic_mesh", None)], service) - self.expert = self.__class__.expert(path + [("expert", None)], service) - self.gap_model = self.__class__.gap_model(path + [("gap_model", None)], service) - self.materials = self.__class__.materials(path + [("materials", None)], service) - self.mesh_interfaces = self.__class__.mesh_interfaces(path + [("mesh_interfaces", None)], service) - self.mixing_planes = self.__class__.mixing_planes(path + [("mixing_planes", None)], service) - self.models = self.__class__.models(path + [("models", None)], service) - self.named_expressions = self.__class__.named_expressions(path + [("named_expressions", None)], service) - self.operating_conditions = self.__class__.operating_conditions(path + [("operating_conditions", None)], service) - self.overset_interfaces = self.__class__.overset_interfaces(path + [("overset_interfaces", None)], service) - self.reference_frames = self.__class__.reference_frames(path + [("reference_frames", None)], service) - self.reference_values = self.__class__.reference_values(path + [("reference_values", None)], service) - self.turbo_model = self.__class__.turbo_model(path + [("turbo_model", None)], service) + class post_format(TUIMenu): + """ + Enter the PostScript driver format menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def fast_raster(self, *args, **kwargs): + """ + Use the new raster format. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/post_format/fast_raster").execute(*args, **kwargs) + def raster(self, *args, **kwargs): + """ + Use the original raster format. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/post_format/raster").execute(*args, **kwargs) + def rle_raster(self, *args, **kwargs): + """ + Use the run-length encoded raster format. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/post_format/rle_raster").execute(*args, **kwargs) + def vector(self, *args, **kwargs): + """ + Use vector format. + """ + return PyMenu(self.service, "/solve/animate/pulse/hardcopy/driver/post_format/vector").execute(*args, **kwargs) - class boundary_conditions(metaclass=PyMenuMeta): + class initialize(TUIMenu): """ - Enter the boudary conditions menu. + Enters the flow initialization menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service - self.bc_settings = self.__class__.bc_settings(path + [("bc_settings", None)], service) - self.expert = self.__class__.expert(path + [("expert", None)], service) - self.mass_flow_inlet = self.__class__.mass_flow_inlet(path + [("mass_flow_inlet", None)], None, service) - self.modify_zones = self.__class__.modify_zones(path + [("modify_zones", None)], service) - self.periodic = self.__class__.periodic(path + [("periodic", None)], None, service) - self.pressure_far_field = self.__class__.pressure_far_field(path + [("pressure_far_field", None)], None, service) - self.pressure_inlet = self.__class__.pressure_inlet(path + [("pressure_inlet", None)], None, service) - self.pressure_outlet = self.__class__.pressure_outlet(path + [("pressure_outlet", None)], None, service) - self.profiles = self.__class__.profiles(path + [("profiles", None)], service) - self.query = self.__class__.query(path + [("query", None)], service) - self.rename_zone = self.__class__.rename_zone(path + [("rename_zone", None)], service) - self.set = self.__class__.set(path + [("set", None)], service) - self.symmetry = self.__class__.symmetry(path + [("symmetry", None)], None, service) - self.velocity_inlet = self.__class__.velocity_inlet(path + [("velocity_inlet", None)], None, service) - self.wall = self.__class__.wall(path + [("wall", None)], None, service) - def axis(self, *args, **kwargs): - """ - Set boundary conditions for a zone of this type. - """ - return PyMenu(self.service, "/setup/boundary_conditions/axis").execute(*args, **kwargs) - def copy_bc(self, *args, **kwargs): - """ - Copy boundary conditions to another zone. - """ - return PyMenu(self.service, "/setup/boundary_conditions/copy_bc").execute(*args, **kwargs) - def degassing(self, *args, **kwargs): - """ - Set boundary conditions for a zone of this type. - """ - return PyMenu(self.service, "/setup/boundary_conditions/degassing").execute(*args, **kwargs) - def exhaust_fan(self, *args, **kwargs): - """ - Set boundary conditions for a zone of this type. - """ - return PyMenu(self.service, "/setup/boundary_conditions/exhaust_fan").execute(*args, **kwargs) - def fan(self, *args, **kwargs): - """ - Set boundary conditions for a zone of this type. - """ - return PyMenu(self.service, "/setup/boundary_conditions/fan").execute(*args, **kwargs) - def fluid(self, *args, **kwargs): - """ - Set boundary conditions for a zone of this type. - """ - return PyMenu(self.service, "/setup/boundary_conditions/fluid").execute(*args, **kwargs) - def geometry(self, *args, **kwargs): - """ - Set boundary conditions for a zone of this type. - """ - return PyMenu(self.service, "/setup/boundary_conditions/geometry").execute(*args, **kwargs) - def inlet_vent(self, *args, **kwargs): - """ - Set boundary conditions for a zone of this type. - """ - return PyMenu(self.service, "/setup/boundary_conditions/inlet_vent").execute(*args, **kwargs) - def intake_fan(self, *args, **kwargs): - """ - Set boundary conditions for a zone of this type. - """ - return PyMenu(self.service, "/setup/boundary_conditions/intake_fan").execute(*args, **kwargs) - def interface(self, *args, **kwargs): + self.compute_defaults = self.__class__.compute_defaults(path + [("compute_defaults", None)], service) + self.mp_localized_turb_init = self.__class__.mp_localized_turb_init(path + [("mp_localized_turb_init", None)], service) + self.vof_patch_smooth_options = self.__class__.vof_patch_smooth_options(path + [("vof_patch_smooth_options", None)], service) + self.set_fmg_options = self.__class__.set_fmg_options(path + [("set_fmg_options", None)], service) + self.set_hyb_initialization = self.__class__.set_hyb_initialization(path + [("set_hyb_initialization", None)], service) + super().__init__(path, service) + def open_channel_auto_init(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Opens channel automatic initialization. """ - return PyMenu(self.service, "/setup/boundary_conditions/interface").execute(*args, **kwargs) - def interior(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/open_channel_auto_init").execute(*args, **kwargs) + def levelset_auto_init(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Levelset function automatic initialization. """ - return PyMenu(self.service, "/setup/boundary_conditions/interior").execute(*args, **kwargs) - def list_zones(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/levelset_auto_init").execute(*args, **kwargs) + def dpm_reset(self, *args, **kwargs): """ - List zone IDs, types, kinds, and names. + Resets discrete phase source terms to zero. """ - return PyMenu(self.service, "/setup/boundary_conditions/list_zones").execute(*args, **kwargs) - def mass_flow_outlet(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/dpm_reset").execute(*args, **kwargs) + def lwf_initialization(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Deletes wall film particles and initializes wall film variables to zero. This option is available only with the wall-film DPM boundary condition. """ - return PyMenu(self.service, "/setup/boundary_conditions/mass_flow_outlet").execute(*args, **kwargs) - def network(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/lwf_initialization").execute(*args, **kwargs) + def initialize_flow(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Initializes the flow field with the current default values. """ - return PyMenu(self.service, "/setup/boundary_conditions/network").execute(*args, **kwargs) - def network_end(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/initialize_flow").execute(*args, **kwargs) + def init_acoustics_options(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Specifies the number of timesteps for ramping of sound sources and re-initializes the acoustics wave equation solution. For the initialized acoustics solution, Fluent reports the current state of the sound sources ramping. """ - return PyMenu(self.service, "/setup/boundary_conditions/network_end").execute(*args, **kwargs) - def outflow(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/init_acoustics_options").execute(*args, **kwargs) + def hyb_initialization(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Initializes using the hybrid initialization method. """ - return PyMenu(self.service, "/setup/boundary_conditions/outflow").execute(*args, **kwargs) - def outlet_vent(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/hyb_initialization").execute(*args, **kwargs) + def init_flow_statistics(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Initializes unsteady statistics. """ - return PyMenu(self.service, "/setup/boundary_conditions/outlet_vent").execute(*args, **kwargs) - def overset(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/init_flow_statistics").execute(*args, **kwargs) + def patch(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Patch a value for a flow variable in the domain. """ - return PyMenu(self.service, "/setup/boundary_conditions/overset").execute(*args, **kwargs) - def porous_jump(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/patch").execute(*args, **kwargs) + def show_time_sampled(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Displays the amount of simulated time covered by the data sampled for unsteady statistics. """ - return PyMenu(self.service, "/setup/boundary_conditions/porous_jump").execute(*args, **kwargs) - def radiator(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/show_time_sampled").execute(*args, **kwargs) + def show_iterations_sampled(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Displays the number of iterations covered by the data sampled for steady statistics. """ - return PyMenu(self.service, "/setup/boundary_conditions/radiator").execute(*args, **kwargs) - def rans_les_interface(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/show_iterations_sampled").execute(*args, **kwargs) + def init_turb_vel_fluctuations(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Initializes instantaneous velocity field out of steady state RANS results, for use before enabling a scale resolving simulation such as LES. """ - return PyMenu(self.service, "/setup/boundary_conditions/rans_les_interface").execute(*args, **kwargs) - def recirculation_inlet(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/init_turb_vel_fluctuations").execute(*args, **kwargs) + def fmg_initialization(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Initializes using the full-multigrid initialization (FMG). """ - return PyMenu(self.service, "/setup/boundary_conditions/recirculation_inlet").execute(*args, **kwargs) - def recirculation_outlet(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/fmg_initialization").execute(*args, **kwargs) + def repair_wall_distance(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Corrects wall distance at very high aspect ratio hexahedral/polyhedral cells. """ - return PyMenu(self.service, "/setup/boundary_conditions/recirculation_outlet").execute(*args, **kwargs) - def shadow(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/repair_wall_distance").execute(*args, **kwargs) + def set_defaults(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Sets default initial values. """ - return PyMenu(self.service, "/setup/boundary_conditions/shadow").execute(*args, **kwargs) - def solid(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/set_defaults").execute(*args, **kwargs) + def set_fmg_initialization(self, *args, **kwargs): """ - Set boundary conditions for a zone of this type. + Enters the set full-multigrid for initialization menu. Initial values for each variable can be set within this menu. """ - return PyMenu(self.service, "/setup/boundary_conditions/solid").execute(*args, **kwargs) - def zone_name(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/set_fmg_initialization").execute(*args, **kwargs) + def list_defaults(self, *args, **kwargs): """ - Give a zone a new name. + Lists default values. """ - return PyMenu(self.service, "/setup/boundary_conditions/zone_name").execute(*args, **kwargs) - def zone_type(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/list_defaults").execute(*args, **kwargs) + def reference_frame(self, *args, **kwargs): """ - Set a zone's type. + Sets reference frame to absolute or relative. """ - return PyMenu(self.service, "/setup/boundary_conditions/zone_type").execute(*args, **kwargs) + return PyMenu(self.service, "/solve/initialize/reference_frame").execute(*args, **kwargs) - class bc_settings(metaclass=PyMenuMeta): + class compute_defaults(TUIMenu): """ - . + Enters the compute default values menu. """ def __init__(self, path, service): self.path = path self.service = service - self.pressure_far_field = self.__class__.pressure_far_field(path + [("pressure_far_field", None)], service) - def mass_flow(self, *args, **kwargs): + super().__init__(path, service) + def axis(self, *args, **kwargs): """ - Select method for setting the mass flow rate. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/setup/boundary_conditions/bc_settings/mass_flow").execute(*args, **kwargs) - def pressure_outlet(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/compute_defaults/axis").execute(*args, **kwargs) + def degassing(self, *args, **kwargs): """ - Select pressure specification method on pressure-outlet boundaries. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/setup/boundary_conditions/bc_settings/pressure_outlet").execute(*args, **kwargs) - - class pressure_far_field(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/compute_defaults/degassing").execute(*args, **kwargs) + def dummy_entry(self, *args, **kwargs): """ - Select presure-far-field boundary-condition options. + . """ - def __init__(self, path, service): - self.path = path - self.service = service - def riemann_invariants_tangency_correction(self, *args, **kwargs): - """ - Apply a local correction where the flow is tangential to the boundary. - """ - return PyMenu(self.service, "/setup/boundary_conditions/bc_settings/pressure_far_field/riemann_invariants_tangency_correction").execute(*args, **kwargs) - def type(self, *args, **kwargs): - """ - Choose pressure-far-field boundary-condition type. - """ - return PyMenu(self.service, "/setup/boundary_conditions/bc_settings/pressure_far_field/type").execute(*args, **kwargs) - - class expert(metaclass=PyMenuMeta): - """ - Enter expert bc menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.impedance_data_fitting = self.__class__.impedance_data_fitting(path + [("impedance_data_fitting", None)], service) - self.non_reflecting_bc = self.__class__.non_reflecting_bc(path + [("non_reflecting_bc", None)], service) - self.perforated_walls = self.__class__.perforated_walls(path + [("perforated_walls", None)], service) - self.periodic_conditions = self.__class__.periodic_conditions(path + [("periodic_conditions", None)], service) - def non_overlapping_zone_name(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/compute_defaults/dummy_entry").execute(*args, **kwargs) + def all_zones(self, *args, **kwargs): """ - Get non-overlapping zone name from the associated interface zone. + Initializes the flow field with the default values. """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/non_overlapping_zone_name").execute(*args, **kwargs) - def openchannel_threads(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/compute_defaults/all_zones").execute(*args, **kwargs) + def exhaust_fan(self, *args, **kwargs): """ - List open channel group IDs, names, types, and variables. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/openchannel_threads").execute(*args, **kwargs) - def open_channel_wave_settings(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/compute_defaults/exhaust_fan").execute(*args, **kwargs) + def fan(self, *args, **kwargs): """ - Open channel wave input analysis. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/open_channel_wave_settings").execute(*args, **kwargs) - def target_mass_flow_rate_settings(self, *args, **kwargs): + return PyMenu(self.service, "/solve/initialize/compute_defaults/fan").execute(*args, **kwargs) + def fluid(self, *args, **kwargs): """ - Enter the targeted mass flow rate setting menu. + Compute flow-initialization defaults from a zone of this type. """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/target_mass_flow_rate_settings").execute(*args, **kwargs) - - class impedance_data_fitting(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/compute_defaults/fluid").execute(*args, **kwargs) + def geometry(self, *args, **kwargs): """ - Enter the impedance data fitting menu. + Compute flow-initialization defaults from a zone of this type. """ - def __init__(self, path, service): - self.path = path - self.service = service - def impedance_data(self, *args, **kwargs): - """ - Read experimental impedance data and output impedance parameters for a boundary condition. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/impedance_data_fitting/impedance_data").execute(*args, **kwargs) - def reflection_data(self, *args, **kwargs): - """ - Read experimental reflection coefficient data and output impedance parameters for a boundary condition. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/impedance_data_fitting/reflection_data").execute(*args, **kwargs) - def absorption_data(self, *args, **kwargs): - """ - Read experimental absorption coefficient data and output impedance parameters for a boundary condition. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/impedance_data_fitting/absorption_data").execute(*args, **kwargs) - def iterations(self, *args, **kwargs): - """ - Set the number of iterations for the fitting algorithm. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/impedance_data_fitting/iterations").execute(*args, **kwargs) - def convergence_tolerance(self, *args, **kwargs): - """ - Set the convergence tolerance for the fitting algorithm. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/impedance_data_fitting/convergence_tolerance").execute(*args, **kwargs) - def residue_tolerance(self, *args, **kwargs): - """ - Set the residue tolerance for the fitting algorithm. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/impedance_data_fitting/residue_tolerance").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Set verbosity level [0, 1] for fitting algorithm. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/impedance_data_fitting/verbosity").execute(*args, **kwargs) - def import_parameters(self, *args, **kwargs): - """ - Import impedance parameters into boundary condition. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/impedance_data_fitting/import_parameters").execute(*args, **kwargs) - - class non_reflecting_bc(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/compute_defaults/geometry").execute(*args, **kwargs) + def inlet_vent(self, *args, **kwargs): """ - Enter the non-reflecting b.c. menu. + Compute flow-initialization defaults from a zone of this type. """ - def __init__(self, path, service): - self.path = path - self.service = service - self.general_nrbc = self.__class__.general_nrbc(path + [("general_nrbc", None)], service) - self.turbo_specific_nrbc = self.__class__.turbo_specific_nrbc(path + [("turbo_specific_nrbc", None)], service) - - class general_nrbc(metaclass=PyMenuMeta): - """ - Enter the menu for setting general non-reflecting boundary conditions. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.set = self.__class__.set(path + [("set", None)], service) - - class set(metaclass=PyMenuMeta): - """ - Enter the general non-reflecting b.c. menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def sigma(self, *args, **kwargs): - """ - Set nrbc sigma factor (default value 0.15). - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/general_nrbc/set/sigma").execute(*args, **kwargs) - def sigma2(self, *args, **kwargs): - """ - Set nrbc sigma2 factor (default value 5.0). - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/general_nrbc/set/sigma2").execute(*args, **kwargs) - def relax(self, *args, **kwargs): - """ - Set NRBC relaxation factor (default value 0.5). - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/general_nrbc/set/relax").execute(*args, **kwargs) - def tangential_source(self, *args, **kwargs): - """ - Include or not NRBC tangential source (default value #t). - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/general_nrbc/set/tangential_source").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Print boundary equations convergence info. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/general_nrbc/set/verbosity").execute(*args, **kwargs) - - class turbo_specific_nrbc(metaclass=PyMenuMeta): - """ - Enter the turbo-specific n.r.b.c. menu. - """ - def __init__(self, path, service): - self.path = path - self.service = service - self.set = self.__class__.set(path + [("set", None)], service) - def enable(self, *args, **kwargs): - """ - Enable/disable turbo-specific non-reflecting b.c.'s. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/turbo_specific_nrbc/enable").execute(*args, **kwargs) - def initialize(self, *args, **kwargs): - """ - Initialize turbo-specific non-reflecting b.c.'s. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/turbo_specific_nrbc/initialize").execute(*args, **kwargs) - def show_status(self, *args, **kwargs): - """ - Show current status of turbo-specific non-reflecting b.c.'s. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/turbo_specific_nrbc/show_status").execute(*args, **kwargs) - - class set(metaclass=PyMenuMeta): - """ - Enter the set menu for turbo-specific non-reflecting b.c. parameters. - """ - def __init__(self, path, service): - self.path = path - self.service = service - def discretization(self, *args, **kwargs): - """ - Enable use of higher-order reconstruction at boundaries if available. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/turbo_specific_nrbc/set/discretization").execute(*args, **kwargs) - def under_relaxation(self, *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. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/turbo_specific_nrbc/set/under_relaxation").execute(*args, **kwargs) - def verbosity(self, *args, **kwargs): - """ - Set turbo-specific non-reflecting b.c. verbosity level. - 0 : silent - 1 : basic info. default - 2 : detailed info. for debugging - . - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/turbo_specific_nrbc/set/verbosity").execute(*args, **kwargs) - - class perforated_walls(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/compute_defaults/inlet_vent").execute(*args, **kwargs) + def intake_fan(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solve/initialize/compute_defaults/intake_fan").execute(*args, **kwargs) + def interface(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solve/initialize/compute_defaults/interface").execute(*args, **kwargs) + def interior(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solve/initialize/compute_defaults/interior").execute(*args, **kwargs) + def mass_flow_inlet(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solve/initialize/compute_defaults/mass_flow_inlet").execute(*args, **kwargs) + def mass_flow_outlet(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solve/initialize/compute_defaults/mass_flow_outlet").execute(*args, **kwargs) + def network(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solve/initialize/compute_defaults/network").execute(*args, **kwargs) + def network_end(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solve/initialize/compute_defaults/network_end").execute(*args, **kwargs) + def outflow(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solve/initialize/compute_defaults/outflow").execute(*args, **kwargs) + def outlet_vent(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solve/initialize/compute_defaults/outlet_vent").execute(*args, **kwargs) + def overset(self, *args, **kwargs): + """ + Compute flow-initialization defaults from a zone of this type. """ - Enter the perforated walls setting menu. + return PyMenu(self.service, "/solve/initialize/compute_defaults/overset").execute(*args, **kwargs) + def periodic(self, *args, **kwargs): """ - def __init__(self, path, service): - self.path = path - self.service = service - def read_input_file(self, *args, **kwargs): - """ - Read an input file. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/perforated_walls/read_input_file").execute(*args, **kwargs) - def model_setup(self, *args, **kwargs): - """ - Set up perforated walls. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/perforated_walls/model_setup").execute(*args, **kwargs) - - class periodic_conditions(metaclass=PyMenuMeta): + Compute flow-initialization defaults from a zone of this type. """ - Enter the periodic conditions menu. + return PyMenu(self.service, "/solve/initialize/compute_defaults/periodic").execute(*args, **kwargs) + def porous_jump(self, *args, **kwargs): """ - def __init__(self, path, service): - self.path = path - self.service = service - def massflow_rate_specification(self, *args, **kwargs): - """ - Enable/disable specification of mass flow rate at the periodic boundary. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/periodic_conditions/massflow_rate_specification").execute(*args, **kwargs) - def pressure_gradient_specification(self, *args, **kwargs): - """ - Enable/disable specification of pressure gradient at the periodic boundary. - """ - return PyMenu(self.service, "/setup/boundary_conditions/expert/periodic_conditions/pressure_gradient_specification").execute(*args, **kwargs) - - class mass_flow_inlet(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.flow_spec = self.__class__.flow_spec(path + [("flow_spec", None)], service) - self.mass_flow = self.__class__.mass_flow(path + [("mass_flow", None)], service) - self.ec_mass_flow = self.__class__.ec_mass_flow(path + [("ec_mass_flow", None)], service) - self.mass_flux = self.__class__.mass_flux(path + [("mass_flux", None)], service) - self.mass_flux_ave = self.__class__.mass_flux_ave(path + [("mass_flux_ave", None)], service) - self.tref = self.__class__.tref(path + [("tref", None)], service) - self.pref = self.__class__.pref(path + [("pref", None)], service) - self.p = self.__class__.p(path + [("p", None)], service) - self.direction_spec = self.__class__.direction_spec(path + [("direction_spec", None)], service) - self.impedance_0 = self.__class__.impedance_0(path + [("impedance_0", None)], service) - self.frame_of_reference = self.__class__.frame_of_reference(path + [("frame_of_reference", None)], service) - self.coordinate_system = self.__class__.coordinate_system(path + [("coordinate_system", None)], service) - self.ni = self.__class__.ni(path + [("ni", None)], service) - self.nj = self.__class__.nj(path + [("nj", None)], service) - self.nk = self.__class__.nk(path + [("nk", None)], service) - self.ni2 = self.__class__.ni2(path + [("ni2", None)], service) - self.nj2 = self.__class__.nj2(path + [("nj2", None)], service) - self.nk2 = self.__class__.nk2(path + [("nk2", None)], service) - self.ai = self.__class__.ai(path + [("ai", None)], service) - self.aj = self.__class__.aj(path + [("aj", None)], service) - self.ak = self.__class__.ak(path + [("ak", None)], service) - self.x_origin = self.__class__.x_origin(path + [("x_origin", None)], service) - self.y_origin = self.__class__.y_origin(path + [("y_origin", None)], service) - self.z_origin = self.__class__.z_origin(path + [("z_origin", None)], service) - self.ke_spec = self.__class__.ke_spec(path + [("ke_spec", None)], service) - self.nut = self.__class__.nut(path + [("nut", None)], service) - self.kl = self.__class__.kl(path + [("kl", None)], service) - self.intermit = self.__class__.intermit(path + [("intermit", None)], service) - self.k = self.__class__.k(path + [("k", None)], service) - self.e = self.__class__.e(path + [("e", None)], service) - self.o = self.__class__.o(path + [("o", None)], service) - self.v2 = self.__class__.v2(path + [("v2", None)], service) - self.turb_intensity = self.__class__.turb_intensity(path + [("turb_intensity", None)], service) - self.turb_length_scale = self.__class__.turb_length_scale(path + [("turb_length_scale", None)], service) - self.turb_hydraulic_diam = self.__class__.turb_hydraulic_diam(path + [("turb_hydraulic_diam", None)], service) - self.turb_viscosity_ratio = self.__class__.turb_viscosity_ratio(path + [("turb_viscosity_ratio", None)], service) - self.turb_viscosity_ratio_profile = self.__class__.turb_viscosity_ratio_profile(path + [("turb_viscosity_ratio_profile", None)], service) - self.rst_spec = self.__class__.rst_spec(path + [("rst_spec", None)], service) - self.uu = self.__class__.uu(path + [("uu", None)], service) - self.vv = self.__class__.vv(path + [("vv", None)], service) - self.ww = self.__class__.ww(path + [("ww", None)], service) - self.uv = self.__class__.uv(path + [("uv", None)], service) - self.vw = self.__class__.vw(path + [("vw", None)], service) - self.uw = self.__class__.uw(path + [("uw", None)], service) - self.ksgs_spec = self.__class__.ksgs_spec(path + [("ksgs_spec", None)], service) - self.ksgs = self.__class__.ksgs(path + [("ksgs", None)], service) - self.sgs_turb_intensity = self.__class__.sgs_turb_intensity(path + [("sgs_turb_intensity", None)], service) - self.swirl_model = self.__class__.swirl_model(path + [("swirl_model", None)], service) - self.swirl_factor = self.__class__.swirl_factor(path + [("swirl_factor", None)], service) - self.x_fan_origin = self.__class__.x_fan_origin(path + [("x_fan_origin", None)], service) - self.y_fan_origin = self.__class__.y_fan_origin(path + [("y_fan_origin", None)], service) - self.z_fan_origin = self.__class__.z_fan_origin(path + [("z_fan_origin", None)], service) - self.wsf = self.__class__.wsf(path + [("wsf", None)], service) - self.wsb = self.__class__.wsb(path + [("wsb", None)], service) - self.wsn = self.__class__.wsn(path + [("wsn", None)], service) - self.slip_velocity = self.__class__.slip_velocity(path + [("slip_velocity", None)], service) - self.velocity_ratio = self.__class__.velocity_ratio(path + [("velocity_ratio", None)], service) - self.volume_frac = self.__class__.volume_frac(path + [("volume_frac", None)], service) - self.granular_temperature = self.__class__.granular_temperature(path + [("granular_temperature", None)], service) - self.ac_options = self.__class__.ac_options(path + [("ac_options", None)], service) - self.ac_wave = self.__class__.ac_wave(path + [("ac_wave", None)], service) - self.t0 = self.__class__.t0(path + [("t0", None)], service) - - class flow_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mass_flow(metaclass=PyMenuMeta): + Compute flow-initialization defaults from a zone of this type. """ + return PyMenu(self.service, "/solve/initialize/compute_defaults/porous_jump").execute(*args, **kwargs) + def pressure_far_field(self, *args, **kwargs): """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ec_mass_flow(metaclass=PyMenuMeta): + Compute flow-initialization defaults from a zone of this type. """ + return PyMenu(self.service, "/solve/initialize/compute_defaults/pressure_far_field").execute(*args, **kwargs) + def pressure_inlet(self, *args, **kwargs): """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mass_flux(metaclass=PyMenuMeta): + Compute flow-initialization defaults from a zone of this type. + """ + return PyMenu(self.service, "/solve/initialize/compute_defaults/pressure_inlet").execute(*args, **kwargs) + def pressure_outlet(self, *args, **kwargs): """ + Compute flow-initialization defaults from a zone of this type. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class mass_flux_ave(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/compute_defaults/pressure_outlet").execute(*args, **kwargs) + def radiator(self, *args, **kwargs): """ + Compute flow-initialization defaults from a zone of this type. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class tref(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/compute_defaults/radiator").execute(*args, **kwargs) + def rans_les_interface(self, *args, **kwargs): """ + Compute flow-initialization defaults from a zone of this type. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class pref(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/compute_defaults/rans_les_interface").execute(*args, **kwargs) + def recirculation_inlet(self, *args, **kwargs): """ + Compute flow-initialization defaults from a zone of this type. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class p(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/compute_defaults/recirculation_inlet").execute(*args, **kwargs) + def recirculation_outlet(self, *args, **kwargs): """ + Compute flow-initialization defaults from a zone of this type. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class direction_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/compute_defaults/recirculation_outlet").execute(*args, **kwargs) + def shadow(self, *args, **kwargs): """ + Compute flow-initialization defaults from a zone of this type. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class impedance_0(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/compute_defaults/shadow").execute(*args, **kwargs) + def solid(self, *args, **kwargs): """ + Compute flow-initialization defaults from a zone of this type. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class frame_of_reference(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/compute_defaults/solid").execute(*args, **kwargs) + def symmetry(self, *args, **kwargs): """ + Compute flow-initialization defaults from a zone of this type. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coordinate_system(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/compute_defaults/symmetry").execute(*args, **kwargs) + def velocity_inlet(self, *args, **kwargs): """ + Compute flow-initialization defaults from a zone of this type. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ni(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/compute_defaults/velocity_inlet").execute(*args, **kwargs) + def wall(self, *args, **kwargs): """ + Compute flow-initialization defaults from a zone of this type. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/initialize/compute_defaults/wall").execute(*args, **kwargs) - class nj(metaclass=PyMenuMeta): + class mp_localized_turb_init(TUIMenu): + """ + Enters the menu for localized turbulent flow initialization. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable(self, *args, **kwargs): """ + Enables/disables localized initialization of turbulent flow variables. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nk(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/mp_localized_turb_init/enable").execute(*args, **kwargs) + def turb_init_parameters(self, *args, **kwargs): """ + Sets values for the turbulent intensity and turbulent viscosity ratio for localized initialization. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/initialize/mp_localized_turb_init/turb_init_parameters").execute(*args, **kwargs) - class ni2(metaclass=PyMenuMeta): + class vof_patch_smooth_options(TUIMenu): + """ + Enters the vof patch/smooth options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def set_options(self, *args, **kwargs): """ + Sets options for patching and smoothing volume fraction. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nj2(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/vof_patch_smooth_options/set_options").execute(*args, **kwargs) + def execute_smoothing(self, *args, **kwargs): """ + Execute volumetric smoothing for volume fraction. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/initialize/vof_patch_smooth_options/execute_smoothing").execute(*args, **kwargs) - class nk2(metaclass=PyMenuMeta): + class set_fmg_options(TUIMenu): + """ + Enter the full-multigrid option menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def viscous_terms(self, *args, **kwargs): """ + Enable/disable viscous terms during FMG initialization. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ai(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/set_fmg_options/viscous_terms").execute(*args, **kwargs) + def species_reactions(self, *args, **kwargs): """ + Enable/disable species volumetric reactions during FMG initialization. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class aj(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/set_fmg_options/species_reactions").execute(*args, **kwargs) + def set_turbulent_viscosity_ratio(self, *args, **kwargs): """ + Set turbulent viscosity ratio used during FMG initialization. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/initialize/set_fmg_options/set_turbulent_viscosity_ratio").execute(*args, **kwargs) - class ak(metaclass=PyMenuMeta): + class set_hyb_initialization(TUIMenu): + """ + Enters the hybrid initialization menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def general_settings(self, *args, **kwargs): """ + Enters the general settings menu. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class x_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/set_hyb_initialization/general_settings").execute(*args, **kwargs) + def turbulent_settings(self, *args, **kwargs): """ + Enter the turbulent settings menu. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class y_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/initialize/set_hyb_initialization/turbulent_settings").execute(*args, **kwargs) + def species_settings(self, *args, **kwargs): """ + Enters the species-settings menu. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/initialize/set_hyb_initialization/species_settings").execute(*args, **kwargs) + + class monitors(TUIMenu): + """ + Sets solution monitors. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self._ = self.__class__._(path + [("_", None)], service) + self.__ = self.__class__.__(path + [("__", None)], service) + self.report_files = self.__class__.report_files(path + [("report_files", None)], service) + self.report_plots = self.__class__.report_plots(path + [("report_plots", None)], service) + self.residual = self.__class__.residual(path + [("residual", None)], service) + super().__init__(path, service) + def convergence_conditions(self, *args, **kwargs): + """ + Manage convergence report. + """ + return PyMenu(self.service, "/solve/monitors/convergence_conditions").execute(*args, **kwargs) + def set_average_over(self, *args, **kwargs): + """ + Set the average over input for monitors. + """ + return PyMenu(self.service, "/solve/monitors/set_average_over").execute(*args, **kwargs) - class z_origin(metaclass=PyMenuMeta): + class _(TUIMenu): + """ + Enter the convergence menu to add surface, volume, drag, lift and moment monitors to convergence criteria. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add_edit(self, *args, **kwargs): """ + Add or edit convergence criterion for surface, volume, drag, lift and moment monitors. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ke_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/_/add_edit").execute(*args, **kwargs) + def frequency(self, *args, **kwargs): """ + To set how often convergence checks are done with respect to iterations or time steps. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nut(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/_/frequency").execute(*args, **kwargs) + def list(self, *args, **kwargs): """ + List defined convergence criteria for monitors. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class kl(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/_/list").execute(*args, **kwargs) + def condition(self, *args, **kwargs): """ + Option to stop the calculations. All convergence conditions are met or any convergence condition is met. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class intermit(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/_/condition").execute(*args, **kwargs) + def average_over_last_n_iterations_timesteps(self, *args, **kwargs): """ + Option to average over previous values for checking convergence. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class k(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/_/average_over_last_n_iterations_timesteps").execute(*args, **kwargs) + def delete(self, *args, **kwargs): """ + Delete a monitor from convergence criteria. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/monitors/_/delete").execute(*args, **kwargs) - class e(metaclass=PyMenuMeta): + class __(TUIMenu): + """ + Enter the statistic monitors menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def monitors(self, *args, **kwargs): """ + Choose which statistics to monitor as printed and/or plotted output. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class o(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/__/monitors").execute(*args, **kwargs) + def plot(self, *args, **kwargs): """ + Enable/disable plotting of statistics during iteration. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class v2(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/__/plot").execute(*args, **kwargs) + def print(self, *args, **kwargs): """ + Enable/disable printing of statistics during iteration. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_intensity(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/__/print").execute(*args, **kwargs) + def write(self, *args, **kwargs): """ + Enable/disable writing of statistics during iteration. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_length_scale(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/__/write").execute(*args, **kwargs) + def window(self, *args, **kwargs): """ + Specify first window in which statistics will be plotted during iteration. + Multiple statistics are plotted in separate windows, beginning with this one. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_hydraulic_diam(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/__/window").execute(*args, **kwargs) + def file_basename(self, *args, **kwargs): """ + Specify the file basename and extension. The name of the individual monitor will be insterted automatically. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_viscosity_ratio(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/__/file_basename").execute(*args, **kwargs) + def x_axis(self, *args, **kwargs): """ + Choose what quantity to use on the abscissa in the plot and in the data written to files. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/monitors/__/x_axis").execute(*args, **kwargs) - class turb_viscosity_ratio_profile(metaclass=PyMenuMeta): + class report_files(TUIMenu): + """ + Manage report files. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add(self, *args, **kwargs): """ + Add a new object. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class rst_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/report_files/add").execute(*args, **kwargs) + def clear_data(self, *args, **kwargs): """ + Delete the report file from the system. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uu(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/report_files/clear_data").execute(*args, **kwargs) + def delete_all(self, *args, **kwargs): """ + Delete all report file objects. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vv(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/report_files/delete_all").execute(*args, **kwargs) + def edit(self, *args, **kwargs): """ + Edit an object. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ww(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/report_files/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): """ + Delete an object. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uv(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/report_files/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): """ + List objects. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vw(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/report_files/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): """ + List properties of an object. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/monitors/report_files/list_properties").execute(*args, **kwargs) - class uw(metaclass=PyMenuMeta): + class report_plots(TUIMenu): + """ + Manage report plots. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add(self, *args, **kwargs): """ + Add a new object. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ksgs_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/report_plots/add").execute(*args, **kwargs) + def axes(self, *args, **kwargs): """ + Set axes options of an object. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ksgs(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/report_plots/axes").execute(*args, **kwargs) + def clear_data(self, *args, **kwargs): + """ + Clear report plot data. """ + return PyMenu(self.service, "/solve/monitors/report_plots/clear_data").execute(*args, **kwargs) + def curves(self, *args, **kwargs): """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + Set curves options of an object. + """ + return PyMenu(self.service, "/solve/monitors/report_plots/curves").execute(*args, **kwargs) + def delete_all(self, *args, **kwargs): + """ + Delete all plot objects. + """ + return PyMenu(self.service, "/solve/monitors/report_plots/delete_all").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edit an object. + """ + return PyMenu(self.service, "/solve/monitors/report_plots/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Delete an object. + """ + return PyMenu(self.service, "/solve/monitors/report_plots/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + List objects. + """ + return PyMenu(self.service, "/solve/monitors/report_plots/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + List properties of an object. + """ + return PyMenu(self.service, "/solve/monitors/report_plots/list_properties").execute(*args, **kwargs) + def plot(self, *args, **kwargs): + """ + Plot. + """ + return PyMenu(self.service, "/solve/monitors/report_plots/plot").execute(*args, **kwargs) - class sgs_turb_intensity(metaclass=PyMenuMeta): + class residual(TUIMenu): + """ + Enters the residual monitors menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def check_convergence(self, *args, **kwargs): + """ + Chooses which currently monitored residuals should be checked for convergence. + """ + return PyMenu(self.service, "/solve/monitors/residual/check_convergence").execute(*args, **kwargs) + def convergence_criteria(self, *args, **kwargs): + """ + Sets convergence criteria for residuals that are currently being both monitored and checked. + """ + return PyMenu(self.service, "/solve/monitors/residual/convergence_criteria").execute(*args, **kwargs) + def criterion_type(self, *args, **kwargs): + """ + Sets convergence criterion type. + """ + return PyMenu(self.service, "/solve/monitors/residual/criterion_type").execute(*args, **kwargs) + def monitor(self, *args, **kwargs): + """ + Chooses which residuals to monitor as printed and/or plotted output. + """ + return PyMenu(self.service, "/solve/monitors/residual/monitor").execute(*args, **kwargs) + def enhanced_continuity_residual(self, *args, **kwargs): + """ + Enables/disables an enhanced formulation for the local scaling of the continuity residuals with the pressure-based solver, so that the absolute mass flow rate at each cell is used. This text command is only available when the computing of the local scale is enabled through the solve/monitors/residual/scale-by-coefficient? text command. + """ + return PyMenu(self.service, "/solve/monitors/residual/enhanced_continuity_residual").execute(*args, **kwargs) + def n_display(self, *args, **kwargs): + """ + Sets the number of most recent residuals to display in plots. + """ + return PyMenu(self.service, "/solve/monitors/residual/n_display").execute(*args, **kwargs) + def n_maximize_norms(self, *args, **kwargs): + """ + Sets the number of iterations through which normalization factors will be maximized. + """ + return PyMenu(self.service, "/solve/monitors/residual/n_maximize_norms").execute(*args, **kwargs) + def normalization_factors(self, *args, **kwargs): + """ + Sets normalization factors for currently monitored residuals (if normalize? is set to yes). + """ + return PyMenu(self.service, "/solve/monitors/residual/normalization_factors").execute(*args, **kwargs) + def normalize(self, *args, **kwargs): + """ + Chooses whether to normalize residuals in printed and plotted output. + """ + return PyMenu(self.service, "/solve/monitors/residual/normalize").execute(*args, **kwargs) + def n_save(self, *args, **kwargs): + """ + Sets number of residuals to be saved with data. History is automatically compacted when buffer becomes full. + """ + return PyMenu(self.service, "/solve/monitors/residual/n_save").execute(*args, **kwargs) + def plot(self, *args, **kwargs): """ + Chooses whether residuals will be plotted during iteration. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class swirl_model(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/residual/plot").execute(*args, **kwargs) + def print(self, *args, **kwargs): """ + Chooses whether residuals will be printed during iteration. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class swirl_factor(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/residual/print").execute(*args, **kwargs) + def relative_conv_criteria(self, *args, **kwargs): """ + Sets relative convergence criteria for residuals that are currently being both monitored and checked. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class x_fan_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/residual/relative_conv_criteria").execute(*args, **kwargs) + def re_normalize(self, *args, **kwargs): """ + Re-normalize residuals by maximum values. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class y_fan_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/residual/re_normalize").execute(*args, **kwargs) + def reset(self, *args, **kwargs): """ + Chooses whether to delete the residual history and reset iteration counter to 1. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class z_fan_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/monitors/residual/reset").execute(*args, **kwargs) + def scale_by_coefficient(self, *args, **kwargs): """ + Chooses whether to scale residuals by coefficient sum in printed and plotted output. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/monitors/residual/scale_by_coefficient").execute(*args, **kwargs) + + class report_files(TUIMenu): + """ + Enters the report files menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add(self, *args, **kwargs): + """ + Creates a report file. + """ + return PyMenu(self.service, "/solve/report_files/add").execute(*args, **kwargs) + def clear_data(self, *args, **kwargs): + """ + Clears the data associated with a report file. + """ + return PyMenu(self.service, "/solve/report_files/clear_data").execute(*args, **kwargs) + def delete_all(self, *args, **kwargs): + """ + Deletes all of the report file objects. + """ + return PyMenu(self.service, "/solve/report_files/delete_all").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edits a report file. + """ + return PyMenu(self.service, "/solve/report_files/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes a report file object. + """ + return PyMenu(self.service, "/solve/report_files/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Lists all defined report files. + """ + return PyMenu(self.service, "/solve/report_files/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + Lists the properties of a report file. + """ + return PyMenu(self.service, "/solve/report_files/list_properties").execute(*args, **kwargs) + + class report_definitions(TUIMenu): + """ + Enters the report definitions menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add(self, *args, **kwargs): + """ + Add a new object. + """ + return PyMenu(self.service, "/solve/report_definitions/add").execute(*args, **kwargs) + def compute(self, *args, **kwargs): + """ + Computes selected report definition. + """ + return PyMenu(self.service, "/solve/report_definitions/compute").execute(*args, **kwargs) + def copy(self, *args, **kwargs): + """ + Creates a copy of a report definition. + """ + return PyMenu(self.service, "/solve/report_definitions/copy").execute(*args, **kwargs) + def delete_all(self, *args, **kwargs): + """ + Deletes all of the report definition objects. + """ + return PyMenu(self.service, "/solve/report_definitions/delete_all").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edits a report definition. + """ + return PyMenu(self.service, "/solve/report_definitions/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes a report definition. + """ + return PyMenu(self.service, "/solve/report_definitions/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Lists all defined report definitions. + """ + return PyMenu(self.service, "/solve/report_definitions/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + Lists the properties of a report definition. + """ + return PyMenu(self.service, "/solve/report_definitions/list_properties").execute(*args, **kwargs) + def rename(self, *args, **kwargs): + """ + Renames a report definition. + """ + return PyMenu(self.service, "/solve/report_definitions/rename").execute(*args, **kwargs) + + class report_plots(TUIMenu): + """ + Enters the report plots menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add(self, *args, **kwargs): + """ + Creates a report plot. + """ + return PyMenu(self.service, "/solve/report_plots/add").execute(*args, **kwargs) + def axes(self, *args, **kwargs): + """ + Defines the axes for a report plot. + """ + return PyMenu(self.service, "/solve/report_plots/axes").execute(*args, **kwargs) + def clear_data(self, *args, **kwargs): + """ + Clears the data associated with a report plot. + """ + return PyMenu(self.service, "/solve/report_plots/clear_data").execute(*args, **kwargs) + def curves(self, *args, **kwargs): + """ + Defines the curves for a report plot. + """ + return PyMenu(self.service, "/solve/report_plots/curves").execute(*args, **kwargs) + def delete_all(self, *args, **kwargs): + """ + Deletes all of the report plot objects. + """ + return PyMenu(self.service, "/solve/report_plots/delete_all").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edits a report plot. + """ + return PyMenu(self.service, "/solve/report_plots/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes a report plot object. + """ + return PyMenu(self.service, "/solve/report_plots/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Lists all defined report plots. + """ + return PyMenu(self.service, "/solve/report_plots/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + Lists the properties of a report plot. + """ + return PyMenu(self.service, "/solve/report_plots/list_properties").execute(*args, **kwargs) + def plot(self, *args, **kwargs): + """ + Plots the specified report plot. + """ + return PyMenu(self.service, "/solve/report_plots/plot").execute(*args, **kwargs) + + class cell_registers(TUIMenu): + """ + Enters the cell registers menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def adapt(self, *args, **kwargs): + """ + Adapt cell register objects. + """ + return PyMenu(self.service, "/solve/cell_registers/adapt").execute(*args, **kwargs) + def add(self, *args, **kwargs): + """ + Creates a new cell register. + """ + return PyMenu(self.service, "/solve/cell_registers/add").execute(*args, **kwargs) + def apply_poor_mesh_numerics(self, *args, **kwargs): + """ + Applies poor mesh numerics to the mesh of a cell register. + """ + return PyMenu(self.service, "/solve/cell_registers/apply_poor_mesh_numerics").execute(*args, **kwargs) + def coarsen(self, *args, **kwargs): + """ + Coarsen the mesh based on a cell register. + """ + return PyMenu(self.service, "/solve/cell_registers/coarsen").execute(*args, **kwargs) + def display(self, *args, **kwargs): + """ + Displays a cell register. + """ + return PyMenu(self.service, "/solve/cell_registers/display").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edits an existing cell register. + """ + return PyMenu(self.service, "/solve/cell_registers/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes a cell register. + """ + return PyMenu(self.service, "/solve/cell_registers/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Lists all of the currently defined cell registers. + """ + return PyMenu(self.service, "/solve/cell_registers/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + Lists the properties of a cell register. + """ + return PyMenu(self.service, "/solve/cell_registers/list_properties").execute(*args, **kwargs) + def refine(self, *args, **kwargs): + """ + Refine the mesh based on a cell register. + """ + return PyMenu(self.service, "/solve/cell_registers/refine").execute(*args, **kwargs) + + class cell_register_operations(TUIMenu): + """ + Enters the cell register operations menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add(self, *args, **kwargs): + """ + Creates a new cell register operation. + """ + return PyMenu(self.service, "/solve/cell_register_operations/add").execute(*args, **kwargs) + def edit(self, *args, **kwargs): + """ + Edits an existing cell register operation. + """ + return PyMenu(self.service, "/solve/cell_register_operations/edit").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Deletes a cell register operation. + """ + return PyMenu(self.service, "/solve/cell_register_operations/delete").execute(*args, **kwargs) + def list(self, *args, **kwargs): + """ + Lists the currently defined cell register operations. + """ + return PyMenu(self.service, "/solve/cell_register_operations/list").execute(*args, **kwargs) + def list_properties(self, *args, **kwargs): + """ + Lists the properties of a report register operation. + """ + return PyMenu(self.service, "/solve/cell_register_operations/list_properties").execute(*args, **kwargs) + + class set(TUIMenu): + """ + Enters the set solution parameters menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.contact_solution_controls = self.__class__.contact_solution_controls(path + [("contact_solution_controls", None)], service) + self.transient_controls = self.__class__.transient_controls(path + [("transient_controls", None)], service) + self.data_sampling_options = self.__class__.data_sampling_options(path + [("data_sampling_options", None)], service) + self.pseudo_time_method = self.__class__.pseudo_time_method(path + [("pseudo_time_method", None)], service) + self.nita_expert_controls = self.__class__.nita_expert_controls(path + [("nita_expert_controls", None)], service) + self.multiphase_numerics = self.__class__.multiphase_numerics(path + [("multiphase_numerics", None)], service) + self.open_channel_wave_options = self.__class__.open_channel_wave_options(path + [("open_channel_wave_options", None)], service) + self.high_order_term_relaxation = self.__class__.high_order_term_relaxation(path + [("high_order_term_relaxation", None)], service) + self.poor_mesh_numerics = self.__class__.poor_mesh_numerics(path + [("poor_mesh_numerics", None)], service) + self.amg_options = self.__class__.amg_options(path + [("amg_options", None)], service) + self.warped_face_gradient_correction = self.__class__.warped_face_gradient_correction(path + [("warped_face_gradient_correction", None)], service) + self.fast_transient_settings = self.__class__.fast_transient_settings(path + [("fast_transient_settings", None)], service) + self.divergence_prevention = self.__class__.divergence_prevention(path + [("divergence_prevention", None)], service) + self.advanced = self.__class__.advanced(path + [("advanced", None)], service) + self.high_speed_numerics = self.__class__.high_speed_numerics(path + [("high_speed_numerics", None)], service) + self.previous_defaults = self.__class__.previous_defaults(path + [("previous_defaults", None)], service) + self.overset = self.__class__.overset(path + [("overset", None)], service) + self.acoustics_wave_equation_controls = self.__class__.acoustics_wave_equation_controls(path + [("acoustics_wave_equation_controls", None)], service) + self.p_v_controls_advanced = self.__class__.p_v_controls_advanced(path + [("p_v_controls_advanced", None)], service) + super().__init__(path, service) + def adaptive_time_stepping(self, *args, **kwargs): + """ + Set Error-based adaptive time-stepping parameters. + """ + return PyMenu(self.service, "/solve/set/adaptive_time_stepping").execute(*args, **kwargs) + def cfl_based_adaptive_time_stepping(self, *args, **kwargs): + """ + Set CFL-based adaptive time-stepping parameters. + """ + return PyMenu(self.service, "/solve/set/cfl_based_adaptive_time_stepping").execute(*args, **kwargs) + def variable_time_stepping(self, *args, **kwargs): + """ + Set Multiphase-Specific Adaptive time stepping parameters. + """ + return PyMenu(self.service, "/solve/set/variable_time_stepping").execute(*args, **kwargs) + def bc_pressure_extrapolations(self, *args, **kwargs): + """ + Sets pressure extrapolations schemes on boundaries. + """ + return PyMenu(self.service, "/solve/set/bc_pressure_extrapolations").execute(*args, **kwargs) + def correction_tolerance(self, *args, **kwargs): + """ + Enters the correction tolerance menu. + """ + return PyMenu(self.service, "/solve/set/correction_tolerance").execute(*args, **kwargs) + def courant_number(self, *args, **kwargs): + """ + Sets the fine-grid Courant number (time step factor). This command is available only for the coupled solvers. + """ + return PyMenu(self.service, "/solve/set/courant_number").execute(*args, **kwargs) + def data_sampling(self, *args, **kwargs): + """ + Enables data sampling for steady or unsteady flow statistics. + """ + return PyMenu(self.service, "/solve/set/data_sampling").execute(*args, **kwargs) + def disable_reconstruction(self, *args, **kwargs): + """ + Completely disables reconstruction, resulting in totally first-order accuracy. + """ + return PyMenu(self.service, "/solve/set/disable_reconstruction").execute(*args, **kwargs) + def discretization_scheme(self, *args, **kwargs): + """ + Enters the discretization scheme menu. This allows you to select the discretization scheme for the convection terms in the solution equations. The following text commands can make a selection from a subset of the models in the following table: + """ + return PyMenu(self.service, "/solve/set/discretization_scheme").execute(*args, **kwargs) + def flux_type(self, *args, **kwargs): + """ + Sets the flux type. Note that for the pressure-based solver, you can enable the Auto Select option that automatically selects the flux interpolation type based on the setup of the case. + """ + return PyMenu(self.service, "/solve/set/flux_type").execute(*args, **kwargs) + def equations(self, *args, **kwargs): + """ + Selects the equations to be solved. + """ + return PyMenu(self.service, "/solve/set/equations").execute(*args, **kwargs) + def expert(self, *args, **kwargs): + """ + Sets expert options. + """ + return PyMenu(self.service, "/solve/set/expert").execute(*args, **kwargs) + def flow_warnings(self, *args, **kwargs): + """ + Specifies whether or not to print warning messages when reversed flow occurs at inlets and outlets, and when mass-flow inlets develop supersonic regions. By default, flow warnings are printed. + """ + return PyMenu(self.service, "/solve/set/flow_warnings").execute(*args, **kwargs) + def gradient_scheme(self, *args, **kwargs): + """ + Sets gradient options. + """ + return PyMenu(self.service, "/solve/set/gradient_scheme").execute(*args, **kwargs) + def nb_gradient_boundary_option(self, *args, **kwargs): + """ + Switches between the modified treatment of node-based gradients at boundary cells and the legacy treatment (R14.5.7 and earlier). If using the density-based solver, you can also specify the extended treatment. For details, see . + """ + return PyMenu(self.service, "/solve/set/nb_gradient_boundary_option").execute(*args, **kwargs) + def limits(self, *args, **kwargs): + """ + Sets solver limits for various solution variables, in order to improve the stability of the solution. + """ + return PyMenu(self.service, "/solve/set/limits").execute(*args, **kwargs) + def limiter_warnings(self, *args, **kwargs): + """ + Specifies whether or not to print warning messages when quantities are being limited. By default, limiter warnings are printed. + """ + return PyMenu(self.service, "/solve/set/limiter_warnings").execute(*args, **kwargs) + def mp_mfluid_aniso_drag(self, *args, **kwargs): + """ + Sets anisotropic drag parameters for the Eulerian multiphase model. + """ + return PyMenu(self.service, "/solve/set/mp_mfluid_aniso_drag").execute(*args, **kwargs) + def material_property_warnings(self, *args, **kwargs): + """ + Control the display of material property warning diagnostics: + 0 - off (no messages) + 1 - messages per material + 2 - messages per material and per property. + """ + return PyMenu(self.service, "/solve/set/material_property_warnings").execute(*args, **kwargs) + def mp_reference_density(self, *args, **kwargs): + """ + Sets the reference density method for the Eulerian multiphase model. The following options are available: + + + + 0 (default): Averaged density of the phase + + + + 1: Cell density of the phase + + + + 1: Constant value of 1 + + + + 1: Cell density of the phase + + + See for more information. + """ + return PyMenu(self.service, "/solve/set/mp_reference_density").execute(*args, **kwargs) + def max_corrections(self, *args, **kwargs): + """ + Enters the max-corrections menu. + """ + return PyMenu(self.service, "/solve/set/max_corrections").execute(*args, **kwargs) + def multi_grid_amg(self, *args, **kwargs): + """ + Sets the parameters that govern the algebraic multigrid procedure. + """ + return PyMenu(self.service, "/solve/set/multi_grid_amg").execute(*args, **kwargs) + def multi_grid_fas(self, *args, **kwargs): + """ + Sets the parameters that control the FAS multigrid solver. This command appears only when the explicit coupled solver is used. + """ + return PyMenu(self.service, "/solve/set/multi_grid_fas").execute(*args, **kwargs) + def multi_grid_controls(self, *args, **kwargs): + """ + Sets multigrid parameters and termination criteria. + """ + return PyMenu(self.service, "/solve/set/multi_grid_controls").execute(*args, **kwargs) + def multi_stage(self, *args, **kwargs): + """ + Sets the multi-stage coefficients and the dissipation and viscous evaluation stages. This command appears only when the explicit coupled solver is used. + """ + return PyMenu(self.service, "/solve/set/multi_stage").execute(*args, **kwargs) + def number_of_iterations(self, *args, **kwargs): + """ + Sets the number of iterations for a steady-state simulation without starting the calculation. + """ + return PyMenu(self.service, "/solve/set/number_of_iterations").execute(*args, **kwargs) + def numerics(self, *args, **kwargs): + """ + Sets numerics options. + """ + return PyMenu(self.service, "/solve/set/numerics").execute(*args, **kwargs) + def second_order_time_options(self, *args, **kwargs): + """ + Enables / disables the variable time step size formulation for second-order implicit transient formulations. If you disable the variable time step size formulation, note that any change in the time step size will introduce an error proportional to the change in the time step size ratio. + """ + return PyMenu(self.service, "/solve/set/second_order_time_options").execute(*args, **kwargs) + def solution_steering(self, *args, **kwargs): + """ + Enables solution steering for the density-based solver. + """ + return PyMenu(self.service, "/solve/set/solution_steering").execute(*args, **kwargs) + def set_solution_steering(self, *args, **kwargs): + """ + Sets solution steering parameters. + """ + return PyMenu(self.service, "/solve/set/set_solution_steering").execute(*args, **kwargs) + def p_v_coupling(self, *args, **kwargs): + """ + Selects which pressure-velocity coupling scheme is to be used. Five schemes are available: + """ + return PyMenu(self.service, "/solve/set/p_v_coupling").execute(*args, **kwargs) + def p_v_controls(self, *args, **kwargs): + """ + Sets pressure-velocity controls. + """ + return PyMenu(self.service, "/solve/set/p_v_controls").execute(*args, **kwargs) + def phase_based_vof_discretization(self, *args, **kwargs): + """ + Sets phase based slope limiter for VOF compressive scheme. + """ + return PyMenu(self.service, "/solve/set/phase_based_vof_discretization").execute(*args, **kwargs) + def accelerated_non_iterative_time_marching(self, *args, **kwargs): + """ + Enables a modified NITA scheme and other setting changes that can speed up the simulation. This option is only available with the Large Eddy Simulation (LES) turbulence model, and is intended for unreacting flow simulations that use a constant-density fluid. + """ + return PyMenu(self.service, "/solve/set/accelerated_non_iterative_time_marching").execute(*args, **kwargs) + def relaxation_method(self, *args, **kwargs): + """ + Sets the solver relaxation method. + """ + return PyMenu(self.service, "/solve/set/relaxation_method").execute(*args, **kwargs) + def reactions(self, *args, **kwargs): + """ + Enables the species reaction sources and sets relaxation factor. + """ + return PyMenu(self.service, "/solve/set/reactions").execute(*args, **kwargs) + def relaxation_factor(self, *args, **kwargs): + """ + Enters the relaxation-factor menu. + """ + return PyMenu(self.service, "/solve/set/relaxation_factor").execute(*args, **kwargs) + def reporting_interval(self, *args, **kwargs): + """ + Sets the number of iterations for which convergence monitors are reported. The default is 1 (after every iteration). + """ + return PyMenu(self.service, "/solve/set/reporting_interval").execute(*args, **kwargs) + def residual_smoothing(self, *args, **kwargs): + """ + Sets the implicit residual smoothing parameters. This command is available only for the explicit coupled solver. + """ + return PyMenu(self.service, "/solve/set/residual_smoothing").execute(*args, **kwargs) + def residual_tolerance(self, *args, **kwargs): + """ + Enters the residual tolerance menu. + """ + return PyMenu(self.service, "/solve/set/residual_tolerance").execute(*args, **kwargs) + def residual_verbosity(self, *args, **kwargs): + """ + Sets the amount of residual information to be printed. A value of 0 (the default) prints residuals at the end of each fine grid iteration. A value of 1 prints residuals after every stage of the fine grid iteration. A value of 2 prints residuals after every stage on every grid level. + """ + return PyMenu(self.service, "/solve/set/residual_verbosity").execute(*args, **kwargs) + def set_solution_methods_to_default(self, *args, **kwargs): + """ + Sets the solution methods to the default settings. + """ + return PyMenu(self.service, "/solve/set/set_solution_methods_to_default").execute(*args, **kwargs) + def set_controls_to_default(self, *args, **kwargs): + """ + Sets controls to default values. + """ + return PyMenu(self.service, "/solve/set/set_controls_to_default").execute(*args, **kwargs) + def set_all_species_together(self, *args, **kwargs): + """ + Sets all species discretizations and URFs together. + """ + return PyMenu(self.service, "/solve/set/set_all_species_together").execute(*args, **kwargs) + def slope_limiter_set(self, *args, **kwargs): + """ + Selects a new Fluent solver slope limiter. + """ + return PyMenu(self.service, "/solve/set/slope_limiter_set").execute(*args, **kwargs) + def vof_numerics(self, *args, **kwargs): + """ + Sets VOF numeric options. + """ + return PyMenu(self.service, "/solve/set/vof_numerics").execute(*args, **kwargs) + def vof_explicit_controls(self, *args, **kwargs): + """ + Sets the sub time step calculation method for VOF calculations. + """ + return PyMenu(self.service, "/solve/set/vof_explicit_controls").execute(*args, **kwargs) + def surface_tension(self, *args, **kwargs): + """ + Sets surface-tension calculation options. + """ + return PyMenu(self.service, "/solve/set/surface_tension").execute(*args, **kwargs) + def surface_tension_expert(self, *args, **kwargs): + """ + Set surface-tension expert options. + """ + return PyMenu(self.service, "/solve/set/surface_tension_expert").execute(*args, **kwargs) + def open_channel_controls(self, *args, **kwargs): + """ + For flows that do not transition from sub-critical to super-critical, or vice-versa, you can speed-up the solution calculation by updating the frequency of Froude number during run time. + """ + return PyMenu(self.service, "/solve/set/open_channel_controls").execute(*args, **kwargs) + def numerical_beach_controls(self, *args, **kwargs): + """ + Sets damping function in flow direction. This command appears only when the VOF model is enabled. Select the damping function to be used: + + + + + + Index + Damping Function + + + + + 0 + Linear + + + 1 + Quadratic + + + 2 + Cubic + + + 3 + Cosine + + + + + + """ + return PyMenu(self.service, "/solve/set/numerical_beach_controls").execute(*args, **kwargs) + def heterogeneous_stiff_chemistry(self, *args, **kwargs): + """ + Sets the heterogeneous stiff-chemistry solver. + """ + return PyMenu(self.service, "/solve/set/heterogeneous_stiff_chemistry").execute(*args, **kwargs) + def stiff_chemistry(self, *args, **kwargs): + """ + Sets solver options for stiff chemistry solutions. + """ + return PyMenu(self.service, "/solve/set/stiff_chemistry").execute(*args, **kwargs) + def time_step(self, *args, **kwargs): + """ + Set the time step. + """ + return PyMenu(self.service, "/solve/set/time_step").execute(*args, **kwargs) + def under_relaxation(self, *args, **kwargs): + """ + Enters the under-relaxation menu, which allows you to set the under-relaxation factor for each equation that is being solved in a segregated manner. + """ + return PyMenu(self.service, "/solve/set/under_relaxation").execute(*args, **kwargs) + def convergence_acceleration_for_stretched_meshes(self, *args, **kwargs): + """ + Enables convergence acceleration for stretched meshes to improve the convergence of the implicit density based solver on meshes with high cell stretching. + """ + return PyMenu(self.service, "/solve/set/convergence_acceleration_for_stretched_meshes").execute(*args, **kwargs) + def reduced_rank_extrapolation(self, *args, **kwargs): + """ + Enable Reduced Rank Extrapolation method to accelerate solution time. + """ + return PyMenu(self.service, "/solve/set/reduced_rank_extrapolation").execute(*args, **kwargs) + def reduced_rank_extrapolation_options(self, *args, **kwargs): + """ + Reduced Rank Extrapolation options. + """ + return PyMenu(self.service, "/solve/set/reduced_rank_extrapolation_options").execute(*args, **kwargs) + def moving_mesh_numerics(self, *args, **kwargs): + """ + Transient options for sliding, moving, and/or dynamic mesh. + """ + return PyMenu(self.service, "/solve/set/moving_mesh_numerics").execute(*args, **kwargs) + def lock_solid_temperature(self, *args, **kwargs): + """ + Specifies whether you want to lock (or “freeze”) the temperature values for all the cells in solid zones (including those to which you have a hooked an energy source through a UDF) and in walls that have shell conduction enabled, so that the values do not change during further solver iterations. + """ + return PyMenu(self.service, "/solve/set/lock_solid_temperature").execute(*args, **kwargs) + def enable_output_dp_dt(self, *args, **kwargs): + """ + Controls whether the output field variabledp-dt will be available for transient simulation postprocessing. If you select no, pressure fields at the previous time steps will not be stored in memory which reduces memory usage. + """ + return PyMenu(self.service, "/solve/set/enable_output_dp_dt").execute(*args, **kwargs) + def equation_ordering(self, *args, **kwargs): + """ + Sets the order in which the model equations are solved, which can affect the convergence speed when you are using the pressure-based solver. The standard method is enabled by default and corresponds to the ordering shown in and in the Theory Guide; alternatively, you can select theoptimized-for-volumetric-expansion method, which is recommended for flows in which the density is strongly dependent on thermal effects, chemical composition, and so on (such as combustion simulations). This text command is not available for steady simulations and/or when a multiphase model is enabled. + """ + return PyMenu(self.service, "/solve/set/equation_ordering").execute(*args, **kwargs) - class wsf(metaclass=PyMenuMeta): + class contact_solution_controls(TUIMenu): + """ + Solver controls for contact marks method. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.parameters = self.__class__.parameters(path + [("parameters", None)], service) + self.spatial = self.__class__.spatial(path + [("spatial", None)], service) + self.transient = self.__class__.transient(path + [("transient", None)], service) + self.amg = self.__class__.amg(path + [("amg", None)], service) + self.models = self.__class__.models(path + [("models", None)], service) + self.methods = self.__class__.methods(path + [("methods", None)], service) + self.miscellaneous = self.__class__.miscellaneous(path + [("miscellaneous", None)], service) + super().__init__(path, service) + def solution_stabilization(self, *args, **kwargs): """ + Automatic solver settings adjustment for solution stabilization during contact process. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wsb(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/contact_solution_controls/solution_stabilization").execute(*args, **kwargs) + def set_settings_to_default(self, *args, **kwargs): """ + Set contact solution stabilization to default. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wsn(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/contact_solution_controls/set_settings_to_default").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): """ + Specify verbosity level for contact solution controls. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/contact_solution_controls/verbosity").execute(*args, **kwargs) - class slip_velocity(metaclass=PyMenuMeta): + class parameters(TUIMenu): """ + Parameters used in stabilization strategy. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def iterations(self, *args, **kwargs): + """ + Specify additional iterations to accomodate contact solution stabilization. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/parameters/iterations").execute(*args, **kwargs) + def solution_stabilization_persistence(self, *args, **kwargs): + """ + Persistence of the solution stabilization based on events [0-contact based, 1-always on]. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/parameters/solution_stabilization_persistence").execute(*args, **kwargs) + def persistence_fixed_time_steps(self, *args, **kwargs): + """ + Specify fixed time-steps for solution stabilization persistence after trigger. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/parameters/persistence_fixed_time_steps").execute(*args, **kwargs) + def persistence_fixed_duration(self, *args, **kwargs): + """ + Specify fixed time for solution stabilization persistence after trigger. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/parameters/persistence_fixed_duration").execute(*args, **kwargs) + def extrapolation_method(self, *args, **kwargs): + """ + Solution extrapolation method for cells changing status from contact to non-contact [0-none, 1-local extrapolation]. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/parameters/extrapolation_method").execute(*args, **kwargs) - class velocity_ratio(metaclass=PyMenuMeta): + class spatial(TUIMenu): """ + Spatial discretization control options. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def first_to_second_order_blending(self, *args, **kwargs): + """ + Set factor to control first order to second order blending. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/spatial/first_to_second_order_blending").execute(*args, **kwargs) + def first_to_second_order_blending_list(self, *args, **kwargs): + """ + List set factor to control first order to second order blending. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/spatial/first_to_second_order_blending_list").execute(*args, **kwargs) + def scheme(self, *args, **kwargs): + """ + Set advection scheme for contact event stability. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/spatial/scheme").execute(*args, **kwargs) + def flow_skew_diffusion_exclude(self, *args, **kwargs): + """ + Exclude skew diffusion discretization contribution for momentum. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/spatial/flow_skew_diffusion_exclude").execute(*args, **kwargs) + def scalars_skew_diffusion_exclude(self, *args, **kwargs): + """ + Exclude skew diffusion discretization contribution for scalars. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/spatial/scalars_skew_diffusion_exclude").execute(*args, **kwargs) + def rhie_chow_flux_specify(self, *args, **kwargs): + """ + Allow specification of the the rhie-chow flux method. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/spatial/rhie_chow_flux_specify").execute(*args, **kwargs) + def rhie_chow_method(self, *args, **kwargs): + """ + Enter the rhie-chow flux method. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/spatial/rhie_chow_method").execute(*args, **kwargs) - class volume_frac(metaclass=PyMenuMeta): + class transient(TUIMenu): """ + Transient discretization control options . """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def transient_parameters_specify(self, *args, **kwargs): + """ + Allow transient parameter specification. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/transient/transient_parameters_specify").execute(*args, **kwargs) + def transient_scheme(self, *args, **kwargs): + """ + Specify temporal scheme to be used. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/transient/transient_scheme").execute(*args, **kwargs) + def time_scale_modification_method(self, *args, **kwargs): + """ + Enter time scale modification method. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/transient/time_scale_modification_method").execute(*args, **kwargs) + def time_scale_modification_factor(self, *args, **kwargs): + """ + Specify time-scale modification factor. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/transient/time_scale_modification_factor").execute(*args, **kwargs) - class granular_temperature(metaclass=PyMenuMeta): + class amg(TUIMenu): """ + AMG control options. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def enforce_laplace_coarsening(self, *args, **kwargs): + """ + Enforce the use of laplace coarsening in AMG. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/amg/enforce_laplace_coarsening").execute(*args, **kwargs) + def increase_pre_sweeps(self, *args, **kwargs): + """ + Allow increase in AMG pre-sweep. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/amg/increase_pre_sweeps").execute(*args, **kwargs) + def pre_sweeps(self, *args, **kwargs): + """ + Specify the number of AMG pre-sweeps. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/amg/pre_sweeps").execute(*args, **kwargs) + def specify_coarsening_rate(self, *args, **kwargs): + """ + Modify AMG coarsening rate. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/amg/specify_coarsening_rate").execute(*args, **kwargs) + def coarsen_rate(self, *args, **kwargs): + """ + Specify AMG coarsening rate. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/amg/coarsen_rate").execute(*args, **kwargs) - class ac_options(metaclass=PyMenuMeta): + class models(TUIMenu): """ + Model control options. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def model_ramping(self, *args, **kwargs): + """ + Activate model ramping for solver stability and accuracy. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/models/model_ramping").execute(*args, **kwargs) + def ramp_flow(self, *args, **kwargs): + """ + Ramp flow for solver stability and accuracy. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/models/ramp_flow").execute(*args, **kwargs) + def ramp_turbulence(self, *args, **kwargs): + """ + Ramp turbulence for solver stability and accuracy. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/models/ramp_turbulence").execute(*args, **kwargs) + def ramp_scalars(self, *args, **kwargs): + """ + Ramp all scalar transport equations for solver stability and accuracy. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/models/ramp_scalars").execute(*args, **kwargs) - class ac_wave(metaclass=PyMenuMeta): + class methods(TUIMenu): """ + Methods control options. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def pressure_velocity_coupling_controls(self, *args, **kwargs): + """ + Enable pressure-velocity coupling method change for solver stability and accuracy. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/methods/pressure_velocity_coupling_controls").execute(*args, **kwargs) + def pressure_velocity_coupling_method(self, *args, **kwargs): + """ + Specify pressure-velocity coupling method change for solver stability and accuracy. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/methods/pressure_velocity_coupling_method").execute(*args, **kwargs) + def gradient_controls(self, *args, **kwargs): + """ + Modify gradient method for solver stability and accuracy. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/methods/gradient_controls").execute(*args, **kwargs) + def specify_gradient_method(self, *args, **kwargs): + """ + Specify gradient method for solver stability and accuracy. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/methods/specify_gradient_method").execute(*args, **kwargs) - class t0(metaclass=PyMenuMeta): + class miscellaneous(TUIMenu): """ + Miscellaneous. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def compute_statistics(self, *args, **kwargs): + """ + Compute solution statistics for contact updates. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/miscellaneous/compute_statistics").execute(*args, **kwargs) + def statistics_level(self, *args, **kwargs): + """ + Solution statistics level for contact updates. + """ + return PyMenu(self.service, "/solve/set/contact_solution_controls/miscellaneous/statistics_level").execute(*args, **kwargs) - class modify_zones(metaclass=PyMenuMeta): + class transient_controls(TUIMenu): """ - Enter the modify zones menu. + Enters the transient controls menu, which allows you to define settings related to time advancement for transient flow calculations. """ def __init__(self, path, service): self.path = path self.service = service - def activate_cell_zone(self, *args, **kwargs): - """ - Activate a cell thread. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/activate_cell_zone").execute(*args, **kwargs) - def append_mesh(self, *args, **kwargs): - """ - Append new mesh. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/append_mesh").execute(*args, **kwargs) - def append_mesh_data(self, *args, **kwargs): - """ - Append new mesh with data. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/append_mesh_data").execute(*args, **kwargs) - def copy_move_cell_zone(self, *args, **kwargs): - """ - Copy and translate or rotate a cell zone. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/copy_move_cell_zone").execute(*args, **kwargs) - def create_all_shell_threads(self, *args, **kwargs): - """ - Mark all finite thickness wall for shell creation. Shell zones will be created at the start of iterations. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/create_all_shell_threads").execute(*args, **kwargs) - def deactivate_cell_zone(self, *args, **kwargs): - """ - Deactivate cell thread. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/deactivate_cell_zone").execute(*args, **kwargs) - def recreate_all_shells(self, *args, **kwargs): - """ - Create shell on all the walls where which were deleted using the command delete-all-shells. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/recreate_all_shells").execute(*args, **kwargs) - def delete_all_shells(self, *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. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/delete_all_shells").execute(*args, **kwargs) - def delete_cell_zone(self, *args, **kwargs): - """ - Delete a cell thread. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/delete_cell_zone").execute(*args, **kwargs) - def extrude_face_zone_delta(self, *args, **kwargs): - """ - Extrude a face thread a specified distance based on a list of deltas. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/extrude_face_zone_delta").execute(*args, **kwargs) - def extrude_face_zone_para(self, *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). - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/extrude_face_zone_para").execute(*args, **kwargs) - def fuse_face_zones(self, *args, **kwargs): - """ - Attempt to fuse zones by removing duplicate faces and nodes. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/fuse_face_zones").execute(*args, **kwargs) - def list_zones(self, *args, **kwargs): - """ - List zone IDs, types, kinds, and names. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/list_zones").execute(*args, **kwargs) - def make_periodic(self, *args, **kwargs): - """ - Attempt to establish periodic/shadow face zone connectivity. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/make_periodic").execute(*args, **kwargs) - def create_periodic_interface(self, *args, **kwargs): - """ - Create a conformal or non-conformal periodic interface. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/create_periodic_interface").execute(*args, **kwargs) - def scale_zone(self, *args, **kwargs): - """ - Scale nodal coordinates of input cell zones. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/scale_zone").execute(*args, **kwargs) - def rotate_zone(self, *args, **kwargs): - """ - Rotate nodal coordinates of input cell zones. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/rotate_zone").execute(*args, **kwargs) - def translate_zone(self, *args, **kwargs): - """ - Translate nodal coordinates of input cell zones. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/translate_zone").execute(*args, **kwargs) - def matching_tolerance(self, *args, **kwargs): - """ - Set the normalized tolerance used for finding coincident nodes. - """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/matching_tolerance").execute(*args, **kwargs) - def merge_zones(self, *args, **kwargs): + self.multiphase_specific_time_constraints = self.__class__.multiphase_specific_time_constraints(path + [("multiphase_specific_time_constraints", None)], service) + super().__init__(path, service) + def specified_time_step(self, *args, **kwargs): """ - Merge zones of the same type and condition into one. + Specifies whether to define the transient advancement either directly by entering a time step size / period / frequency (using the text commands available in thesolve/set/transient-controls menu) or indirectly by entering a Courant number value (using the solve/set/courant-number text command). This text command is only available for the density-based solver when both the explicit formulation and explicit transient formulation are used. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/merge_zones").execute(*args, **kwargs) - def mrf_to_sliding_mesh(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/specified_time_step").execute(*args, **kwargs) + def fixed_user_specified(self, *args, **kwargs): """ - Change motion specification from MRF to moving mesh. + Allows you to specify that a fixed time stepping method is used in which you directly specify the time step size and number of time steps. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/mrf_to_sliding_mesh").execute(*args, **kwargs) - def convert_all_solid_mrf_to_solid_motion(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/fixed_user_specified").execute(*args, **kwargs) + def fixed_periodic(self, *args, **kwargs): """ - Change all solid zones motion specification from MRF to solid motion. + Allows you to specify that a fixed time stepping method is used in which a specified period or frequency is the basis for determining the time step size and number of time steps. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/convert_all_solid_mrf_to_solid_motion").execute(*args, **kwargs) - def orient_face_zone(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/fixed_periodic").execute(*args, **kwargs) + def duration_specification_method(self, *args, **kwargs): """ - Orient the face zone. + Sets the method by which you will specify the duration of the calculation. The duration can be defined by the total time, the total number of time steps, the incremental time, or the number of incremental time steps. In this context, "total" indicates that Fluent will consider the amount of time / steps that have already been solved and stop appropriately, whereas "incremental" indicates that the solution will proceed for a specified amount of time / steps regardless of what has previously been calculated. This text command is only available when the time stepping is adaptive or based on a user-defined function. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/orient_face_zone").execute(*args, **kwargs) - def replace_zone(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/duration_specification_method").execute(*args, **kwargs) + def incremental_time(self, *args, **kwargs): """ - Replace a cell zone. + Sets the amount of incremental (that is, additional) time to run the simulation, regardless of how much time has already been run in previous calculations. This text command is only available when the solve/set/transient-controls/duration-specification-method is set to3. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/replace_zone").execute(*args, **kwargs) - def sep_cell_zone_mark(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/incremental_time").execute(*args, **kwargs) + def max_iterations_per_time_step(self, *args, **kwargs): """ - Separate a cell zone based on cell marking. + Sets the number of time steps for a transient simulation. This option is available when automatic initialization and case modification is enabled. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/sep_cell_zone_mark").execute(*args, **kwargs) - def sep_cell_zone_region(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/max_iterations_per_time_step").execute(*args, **kwargs) + def number_of_time_steps(self, *args, **kwargs): """ - Separate a cell zone based on contiguous regions. + Sets the number of time steps for a transient simulation without starting the calculation. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/sep_cell_zone_region").execute(*args, **kwargs) - def sep_face_zone_angle(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/number_of_time_steps").execute(*args, **kwargs) + def total_number_of_time_steps(self, *args, **kwargs): """ - Separate a face zone based on significant angle. + Sets the total number of time steps that the simulation will run (which includes any time steps that have already been run in previous calculations). This text command is only available when the solve/set/transient-controls/duration-specification-method is set to1. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/sep_face_zone_angle").execute(*args, **kwargs) - def sep_face_zone_face(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/total_number_of_time_steps").execute(*args, **kwargs) + def total_time(self, *args, **kwargs): """ - Separate each face in a zone into unique zone. + Sets the total amount of time that the simulation will be run (which includes any time that has already been run in previous calculations). This text command is only available when the solve/set/transient-controls/duration-specification-method is set to2. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/sep_face_zone_face").execute(*args, **kwargs) - def sep_face_zone_mark(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/total_time").execute(*args, **kwargs) + def time_step_size(self, *args, **kwargs): """ - Separate a face zone based on cell marking. + Sets the magnitude of the (physical) time step . This text command is only available when the solve/set/transient-controls/fixed-user-specified text command is set toyes. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/sep_face_zone_mark").execute(*args, **kwargs) - def sep_face_zone_region(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/time_step_size").execute(*args, **kwargs) + def solution_status(self, *args, **kwargs): """ - Separate a face zone based on contiguous regions. + Allows you to open theSimulation Status dialog box, which reports details about the simulation. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/sep_face_zone_region").execute(*args, **kwargs) - def slit_periodic(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/solution_status").execute(*args, **kwargs) + def extrapolate_vars(self, *args, **kwargs): """ - Slit a periodic zone into two symmetry zones. + Applies a predictor algorithm for computing initial conditions at time step n+1. The predictor algorithm is a computation that sets a better initial condition for the time step. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/slit_periodic").execute(*args, **kwargs) - def slit_face_zone(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/extrapolate_vars").execute(*args, **kwargs) + def extrapolate_eqn_vars(self, *args, **kwargs): """ - Slit a two-sided wall into two connected wall zones. + Enters the extrapolation menu. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/slit_face_zone").execute(*args, **kwargs) - def slit_interior_between_diff_solids(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/extrapolate_eqn_vars").execute(*args, **kwargs) + def max_flow_time(self, *args, **kwargs): """ - Slit interior created between different solids into coupled walls. + Sets the maximum flow time. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/slit_interior_between_diff_solids").execute(*args, **kwargs) - def zone_name(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/max_flow_time").execute(*args, **kwargs) + def cfl_based_time_stepping_advanced_options(self, *args, **kwargs): """ - Give a zone a new name. + Set CFL-based adaptive time-stepping advanced parameters. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/zone_name").execute(*args, **kwargs) - def zone_type(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/cfl_based_time_stepping_advanced_options").execute(*args, **kwargs) + def cfl_based_time_stepping(self, *args, **kwargs): """ - Set a zone's type. + Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent as the calculation proceeds such that the Courant–Friedrichs–Lewy (CFL) condition is satisfied, using the specified Courant number. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/zone_type").execute(*args, **kwargs) - def copy_mrf_to_mesh_motion(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/cfl_based_time_stepping").execute(*args, **kwargs) + def multiphase_specific_time_stepping(self, *args, **kwargs): """ - Copy motion variable values for origin, axis and velocities from Frame Motion to Mesh Motion. + Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent based on the convective time scale (global Courant number): the time-step-size calculation depends on the mesh density and velocity in interfacial cells. This method is available for all multiphase models using the implicit or explicit volume fraction formulation, except for the wet steam model. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/copy_mrf_to_mesh_motion").execute(*args, **kwargs) - def copy_mesh_to_mrf_motion(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/multiphase_specific_time_stepping").execute(*args, **kwargs) + def udf_based_time_stepping(self, *args, **kwargs): """ - Copy motion variable values for origin, axis and velocities from Mesh Motion to Frame Motion. + Allows you to specify that the time step size is defined by a user-defined function (UDF) that uses theDEFINE_DELTAT macro. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/copy_mesh_to_mrf_motion").execute(*args, **kwargs) - def change_zone_state(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/udf_based_time_stepping").execute(*args, **kwargs) + def error_based_time_stepping(self, *args, **kwargs): """ - Change the realgas material state for a zone. + Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent based on the specified truncation error tolerance. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/change_zone_state").execute(*args, **kwargs) - def change_zone_phase(self, *args, **kwargs): + return PyMenu(self.service, "/solve/set/transient_controls/error_based_time_stepping").execute(*args, **kwargs) + def undo_timestep(self, *args, **kwargs): """ - Change the realgas phase for a zone. + When enabled, if the truncation error within a time step exceeds the specified tolerance Fluent will automatically undo the current calculation and make another attempt with the time step reduced by 1/2. This will be attempted up to 5 times after which Fluent will accept the result and proceed to the next time step. """ - return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/change_zone_phase").execute(*args, **kwargs) - - class periodic(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class pressure_far_field(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.p = self.__class__.p(path + [("p", None)], service) - self.m = self.__class__.m(path + [("m", None)], service) - self.coordinate_system = self.__class__.coordinate_system(path + [("coordinate_system", None)], service) - self.ni = self.__class__.ni(path + [("ni", None)], service) - self.nj = self.__class__.nj(path + [("nj", None)], service) - self.nk = self.__class__.nk(path + [("nk", None)], service) - self.ai = self.__class__.ai(path + [("ai", None)], service) - self.aj = self.__class__.aj(path + [("aj", None)], service) - self.ak = self.__class__.ak(path + [("ak", None)], service) - self.x_origin = self.__class__.x_origin(path + [("x_origin", None)], service) - self.y_origin = self.__class__.y_origin(path + [("y_origin", None)], service) - self.z_origin = self.__class__.z_origin(path + [("z_origin", None)], service) - self.ke_spec = self.__class__.ke_spec(path + [("ke_spec", None)], service) - self.nut = self.__class__.nut(path + [("nut", None)], service) - self.kl = self.__class__.kl(path + [("kl", None)], service) - self.intermit = self.__class__.intermit(path + [("intermit", None)], service) - self.k = self.__class__.k(path + [("k", None)], service) - self.e = self.__class__.e(path + [("e", None)], service) - self.o = self.__class__.o(path + [("o", None)], service) - self.v2 = self.__class__.v2(path + [("v2", None)], service) - self.turb_intensity = self.__class__.turb_intensity(path + [("turb_intensity", None)], service) - self.turb_length_scale = self.__class__.turb_length_scale(path + [("turb_length_scale", None)], service) - self.turb_hydraulic_diam = self.__class__.turb_hydraulic_diam(path + [("turb_hydraulic_diam", None)], service) - self.turb_viscosity_ratio = self.__class__.turb_viscosity_ratio(path + [("turb_viscosity_ratio", None)], service) - self.turb_viscosity_ratio_profile = self.__class__.turb_viscosity_ratio_profile(path + [("turb_viscosity_ratio_profile", None)], service) - self.rst_spec = self.__class__.rst_spec(path + [("rst_spec", None)], service) - self.uu = self.__class__.uu(path + [("uu", None)], service) - self.vv = self.__class__.vv(path + [("vv", None)], service) - self.ww = self.__class__.ww(path + [("ww", None)], service) - self.uv = self.__class__.uv(path + [("uv", None)], service) - self.vw = self.__class__.vw(path + [("vw", None)], service) - self.uw = self.__class__.uw(path + [("uw", None)], service) - self.ksgs_spec = self.__class__.ksgs_spec(path + [("ksgs_spec", None)], service) - self.ksgs = self.__class__.ksgs(path + [("ksgs", None)], service) - self.sgs_turb_intensity = self.__class__.sgs_turb_intensity(path + [("sgs_turb_intensity", None)], service) - self.geom_disable = self.__class__.geom_disable(path + [("geom_disable", None)], service) - self.geom_dir_spec = self.__class__.geom_dir_spec(path + [("geom_dir_spec", None)], service) - self.geom_dir_x = self.__class__.geom_dir_x(path + [("geom_dir_x", None)], service) - self.geom_dir_y = self.__class__.geom_dir_y(path + [("geom_dir_y", None)], service) - self.geom_dir_z = self.__class__.geom_dir_z(path + [("geom_dir_z", None)], service) - self.geom_levels = self.__class__.geom_levels(path + [("geom_levels", None)], service) - self.geom_bgthread = self.__class__.geom_bgthread(path + [("geom_bgthread", None)], service) - self.t = self.__class__.t(path + [("t", None)], service) - self.non_equil_boundary = self.__class__.non_equil_boundary(path + [("non_equil_boundary", None)], service) - self.tve = self.__class__.tve(path + [("tve", None)], service) - - class p(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class m(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/transient_controls/undo_timestep").execute(*args, **kwargs) + def predict_next_time(self, *args, **kwargs): """ + Applies a predictor algorithm for computing the next time step. The predictor algorithm is a computation that sets a better initial condition for the time step. It uses the rate of change between the prediction and the correction as an indicator for whether the next time step should be larger, smaller, or the same as the current one. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coordinate_system(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/transient_controls/predict_next_time").execute(*args, **kwargs) + def rotating_mesh_flow_predictor(self, *args, **kwargs): """ + Enables / disables an option that allows for better prediction of the flow field in rotating fluid zones at every time step, in order to speed up the calculation. This text command is only available for transient simulations. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ni(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/transient_controls/rotating_mesh_flow_predictor").execute(*args, **kwargs) + def solid_time_step_size(self, *args, **kwargs): """ + Allows you to specify that the time step size used for solid zones is independent from that used for fluid zones. This text command is only available when both a solid zone exists and energy is enabled. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nj(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/transient_controls/solid_time_step_size").execute(*args, **kwargs) + def time_step_size_for_acoustic_export(self, *args, **kwargs): """ + Specifies the time interval for acoustic data sampling. This text command is only available when both the Ffowcs Williams and Hawkings model is selected and the density-based solver is used with the explicit formulation and explicit transient formulation. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/transient_controls/time_step_size_for_acoustic_export").execute(*args, **kwargs) - class nk(metaclass=PyMenuMeta): + class multiphase_specific_time_constraints(TUIMenu): """ + Enters the menu for setting multiphase-specific time constraints. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + self.time_scale_options = self.__class__.time_scale_options(path + [("time_scale_options", None)], service) + super().__init__(path, service) + def moving_mesh_cfl_constraint(self, *args, **kwargs): + """ + Enable time step size constraints based on moving mesh courant number. + """ + return PyMenu(self.service, "/solve/set/transient_controls/multiphase_specific_time_constraints/moving_mesh_cfl_constraint").execute(*args, **kwargs) + def physics_based_constraint(self, *args, **kwargs): + """ + Enables/disables the physics-driven time-step constraints. + """ + return PyMenu(self.service, "/solve/set/transient_controls/multiphase_specific_time_constraints/physics_based_constraint").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + When enabled, various time scales (depending on the selection) are printed to the console window at every time step. This text command is available with the moving mesh CFL constraint and with the physics-based constraint. + """ + return PyMenu(self.service, "/solve/set/transient_controls/multiphase_specific_time_constraints/verbosity").execute(*args, **kwargs) + + class time_scale_options(TUIMenu): + """ + Enters the menu for choosing the time-scale options. This menu becomes available after you enable the physics-driven time-step constraints using the solve/set/transient-controls/multiphase-specific-time-constraints/physics-based-constraint? text command. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def viscous_scale(self, *args, **kwargs): + """ + Allows you to Include the viscous time scale. This option is disabled by default. This command is not available with inviscid flows. + """ + return PyMenu(self.service, "/solve/set/transient_controls/multiphase_specific_time_constraints/time_scale_options/viscous_scale").execute(*args, **kwargs) + def gravity_scale(self, *args, **kwargs): + """ + Allows you to Include the gravitational time scale. This option is available only if gravity is enabled. + """ + return PyMenu(self.service, "/solve/set/transient_controls/multiphase_specific_time_constraints/time_scale_options/gravity_scale").execute(*args, **kwargs) + def surface_tension_scale(self, *args, **kwargs): + """ + Allows you to Include the surface-tension-driven time scale. This option is available only if the surface tension force modeling is enabled. + """ + return PyMenu(self.service, "/solve/set/transient_controls/multiphase_specific_time_constraints/time_scale_options/surface_tension_scale").execute(*args, **kwargs) + def acoustic_scale(self, *args, **kwargs): + """ + Allows you to Include the acoustic time scale. This option is available only for compressible flows. + """ + return PyMenu(self.service, "/solve/set/transient_controls/multiphase_specific_time_constraints/time_scale_options/acoustic_scale").execute(*args, **kwargs) - class ai(metaclass=PyMenuMeta): + class data_sampling_options(TUIMenu): + """ + Enter the menu for specifying quantities and zones for steady and unsteady flow statistics. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add_datasets(self, *args, **kwargs): """ + Add a dataset. After providing the zones for a dataset, press [Enter] to move onto selecting quantities. Enter () to complete the quantity selection for this dataset. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class aj(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/data_sampling_options/add_datasets").execute(*args, **kwargs) + def add_rtdft_datasets(self, *args, **kwargs): """ + Specify zone and quantity combinations for sampling Fourier coefficients of unsteady flows. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ak(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/data_sampling_options/add_rtdft_datasets").execute(*args, **kwargs) + def remove_dataset(self, *args, **kwargs): """ + Remove dataset. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class x_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/data_sampling_options/remove_dataset").execute(*args, **kwargs) + def list_datasets(self, *args, **kwargs): """ + Lists the combinations of zones and quantities that are defined for sampling steady and unsteady flow statistics. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/data_sampling_options/list_datasets").execute(*args, **kwargs) - class y_origin(metaclass=PyMenuMeta): + class pseudo_time_method(TUIMenu): + """ + Enters the pseudo time method menu. This menu is only available for cases that use a pressure-based segregated solver (SIMPLE, SIMPLEC, or PISO) or for steady-state cases that use the pressure-based coupled solver or the density-based implicit solver. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def formulation(self, *args, **kwargs): """ + Enables and sets the pseudo time step size formulation or disables the pseudo time method option. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class z_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/pseudo_time_method/formulation").execute(*args, **kwargs) + def local_time_step_settings(self, *args, **kwargs): """ + Defines the pseudo time Courant number when the local time step formulation is selected. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ke_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/pseudo_time_method/local_time_step_settings").execute(*args, **kwargs) + def global_time_step_settings(self, *args, **kwargs): """ + Defines the pseudo time settings for the calculation when the global time step formulation is selected. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nut(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/pseudo_time_method/global_time_step_settings").execute(*args, **kwargs) + def advanced_options(self, *args, **kwargs): """ + Enters the advanced options menu, which allows you to enable / disable the pseudo time method for individual equations and define their pseudo time scale factors or under-relaxation factors, respectively. These settings only apply when the global time step formulation is selected. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class kl(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/pseudo_time_method/advanced_options").execute(*args, **kwargs) + def relaxation_factors(self, *args, **kwargs): """ + Enters the relaxation factors menu, where you can set the pseudo time explicit relaxation factors for individual equations. These factors only apply when the global time step formulation is selected. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class intermit(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/pseudo_time_method/relaxation_factors").execute(*args, **kwargs) + def relaxation_method(self, *args, **kwargs): """ + Select relaxation definition for pseudo time method. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class k(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/pseudo_time_method/relaxation_method").execute(*args, **kwargs) + def relaxation_bounds(self, *args, **kwargs): """ + Select relaxation bounding scheme for pseudo time method. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class e(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/pseudo_time_method/relaxation_bounds").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): """ + Sets the verbosity of the messages related to the pseudo time method. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/pseudo_time_method/verbosity").execute(*args, **kwargs) - class o(metaclass=PyMenuMeta): + class nita_expert_controls(TUIMenu): + """ + Enters the NITA expert control menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def set_verbosity(self, *args, **kwargs): """ + Setting this to 1, enables the verbosity for NITA diagnostics. The default value of 0 disables verbosity output for NITA diagnostics. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class v2(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/nita_expert_controls/set_verbosity").execute(*args, **kwargs) + def skewness_neighbor_coupling(self, *args, **kwargs): """ + Enables/disables coupling of the neighbor and skewness corrections. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_intensity(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/nita_expert_controls/skewness_neighbor_coupling").execute(*args, **kwargs) + def hybrid_nita_settings(self, *args, **kwargs): """ + Enables and sets hybrid NITA options. For more details, see . """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/nita_expert_controls/hybrid_nita_settings").execute(*args, **kwargs) + + class multiphase_numerics(TUIMenu): + """ + Sets multiphase numerics options. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.porous_media = self.__class__.porous_media(path + [("porous_media", None)], service) + self.compressible_flow = self.__class__.compressible_flow(path + [("compressible_flow", None)], service) + self.boiling_parameters = self.__class__.boiling_parameters(path + [("boiling_parameters", None)], service) + self.viscous_flow = self.__class__.viscous_flow(path + [("viscous_flow", None)], service) + self.heat_mass_transfer = self.__class__.heat_mass_transfer(path + [("heat_mass_transfer", None)], service) + self.advanced_stability_controls = self.__class__.advanced_stability_controls(path + [("advanced_stability_controls", None)], service) + self.default_controls = self.__class__.default_controls(path + [("default_controls", None)], service) + self.face_pressure_controls = self.__class__.face_pressure_controls(path + [("face_pressure_controls", None)], service) + self.solution_stabilization = self.__class__.solution_stabilization(path + [("solution_stabilization", None)], service) + super().__init__(path, service) - class turb_length_scale(metaclass=PyMenuMeta): + class porous_media(TUIMenu): """ + Enters the porous media numerics menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def relative_permeability(self, *args, **kwargs): + """ + Allows you to fix the saturation (volume fraction) of the phase at its user-specified residual saturation value. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/porous_media/relative_permeability").execute(*args, **kwargs) - class turb_hydraulic_diam(metaclass=PyMenuMeta): + class compressible_flow(TUIMenu): """ + Enters the compressible multiphase flow numerics menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def enhanced_numerics(self, *args, **kwargs): + """ + Enables an enhanced numerical treatment that provides better stability at startup and during calculation of compressible flows. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/compressible_flow/enhanced_numerics").execute(*args, **kwargs) + def alternate_bc_formulation(self, *args, **kwargs): + """ + Enables an alternative formulation for compressible phases at an inlet boundary. This formulation calculates static temperature and pressure using an iterative method based on fundamental thermodynamic relations. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/compressible_flow/alternate_bc_formulation").execute(*args, **kwargs) - class turb_viscosity_ratio(metaclass=PyMenuMeta): + class boiling_parameters(TUIMenu): """ + Enters the menu for the multiphase boiling model parameters. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def thin_film(self, *args, **kwargs): + """ + When enabled, includes multiphase boiling thin film effects using . + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/boiling_parameters/thin_film").execute(*args, **kwargs) + def liquid_vof_factor(self, *args, **kwargs): + """ + When enabled, considers liquid volume fraction effects by multiplying the heat transfer coefficients by the local liquid volume fraction. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/boiling_parameters/liquid_vof_factor").execute(*args, **kwargs) - class turb_viscosity_ratio_profile(metaclass=PyMenuMeta): + class viscous_flow(TUIMenu): """ + Enters the viscous multiphase flow numerics menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def viscosity_averaging(self, *args, **kwargs): + """ + Forces harmonic averaging of cell viscosities to calculate face viscosity used in momentum equation. This can improve convergence for highly viscous flow applications (the VOF model only). + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/viscous_flow/viscosity_averaging").execute(*args, **kwargs) + def turb_visc_based_damping(self, *args, **kwargs): + """ + Turbulence viscosity based damping controls. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/viscous_flow/turb_visc_based_damping").execute(*args, **kwargs) + def interfacial_artificial_viscosity(self, *args, **kwargs): + """ + Interfacial artifical viscosity controls. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/viscous_flow/interfacial_artificial_viscosity").execute(*args, **kwargs) - class rst_spec(metaclass=PyMenuMeta): + class heat_mass_transfer(TUIMenu): """ + Enters the menu for the multiphase heat mass transfer parameters. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + self.cavitation = self.__class__.cavitation(path + [("cavitation", None)], service) + self.evaporation_condensation = self.__class__.evaporation_condensation(path + [("evaporation_condensation", None)], service) + self.boiling = self.__class__.boiling(path + [("boiling", None)], service) + self.area_density = self.__class__.area_density(path + [("area_density", None)], service) + super().__init__(path, service) + def alternative_energy_treatment(self, *args, **kwargs): + """ + Enables the alternative treatment of the energy sources. For more information, see . + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/alternative_energy_treatment").execute(*args, **kwargs) + + class cavitation(TUIMenu): + """ + Enters the cavitation heat mass transfer menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def schnerr_evap_coeff(self, *args, **kwargs): + """ + Sets the evaporation coefficient for the Schnerr-Sauer model ( in ). The default and recommended value of 1. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/cavitation/schnerr_evap_coeff").execute(*args, **kwargs) + def schnerr_cond_coeff(self, *args, **kwargs): + """ + Sets the condensation coefficient for the Schnerr-Sauer model ( in ). The default and recommended value of 0.2. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/cavitation/schnerr_cond_coeff").execute(*args, **kwargs) + def max_vapor_pressure_ratio(self, *args, **kwargs): + """ + Sets the maximum limit on the vapor pressure after the turbulence and thermal correction. The default value is five times the vapor pressure, with consideration of turbulent and thermal effects for each cell and phase. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/cavitation/max_vapor_pressure_ratio").execute(*args, **kwargs) + def min_vapor_pressure(self, *args, **kwargs): + """ + Sets the minimum vapor pressure limit for the cavitation mass-transfer model. The default value is 1 Pa. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/cavitation/min_vapor_pressure").execute(*args, **kwargs) + def display_clipped_pressure(self, *args, **kwargs): + """ + Clipped pressure is just used for the properties evaluation. Mass Transfer Rate uses unclipped pressure. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/cavitation/display_clipped_pressure").execute(*args, **kwargs) + def turbulent_diffusion(self, *args, **kwargs): + """ + Enables/disables the turbulent diffusion treatment for a cavitating turbulent flow. See for details. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/cavitation/turbulent_diffusion").execute(*args, **kwargs) + + class evaporation_condensation(TUIMenu): + """ + Evaporation-condensation advanced options menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def vof_from_min_limit(self, *args, **kwargs): + """ + Minimum volume fraction below which mass transfer rate is set to zero. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/evaporation_condensation/vof_from_min_limit").execute(*args, **kwargs) + def vof_from_max_limit(self, *args, **kwargs): + """ + Maximum volume fraction above which mass transfer rate is set to zero. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/evaporation_condensation/vof_from_max_limit").execute(*args, **kwargs) + def vof_to_min_limit(self, *args, **kwargs): + """ + Minimum volume fraction below which mass transfer rate is set to zero. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/evaporation_condensation/vof_to_min_limit").execute(*args, **kwargs) + def vof_to_max_limit(self, *args, **kwargs): + """ + Maximum volume fraction above which mass transfer rate is set to zero. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/evaporation_condensation/vof_to_max_limit").execute(*args, **kwargs) + def ia_norm_min_limit(self, *args, **kwargs): + """ + Minimum normalized area density below which mass transfer rate is set to zero. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/evaporation_condensation/ia_norm_min_limit").execute(*args, **kwargs) + def max_rel_humidity(self, *args, **kwargs): + """ + Maximum value of relative humidity to limit condensation rate. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/evaporation_condensation/max_rel_humidity").execute(*args, **kwargs) + + class boiling(TUIMenu): + """ + Enters the menu for the advanced boiling options for the semi-mechanistic boiling model. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def heat_flux_relaxation_factor(self, *args, **kwargs): + """ + Sets the under-relaxation factor for boiling heat flux. See for details. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/boiling/heat_flux_relaxation_factor").execute(*args, **kwargs) + def show_expert_options(self, *args, **kwargs): + """ + Exposes the expert options for the semi-mechanistic boiling model. For more information about these options, see . + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/boiling/show_expert_options").execute(*args, **kwargs) + def two_resistance_boiling_framework(self, *args, **kwargs): + """ + Enables/disables the two-resistance boiling framework to improve the robustness and accuracy of the solution of cases with multiple boiling mechanisms. For more information about this item, see . + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/boiling/two_resistance_boiling_framework").execute(*args, **kwargs) + + class area_density(TUIMenu): + """ + Enters the menu for the area density. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def vof_min_seeding(self, *args, **kwargs): + """ + Sets the minimum volume fraction for the area density and cavitation. This may be useful, for example, in cases when a species mass transfer model (such as the Symmetric model or Particle model) do not consider evaporation or condensation if the volume fraction of one of the phases is zero. The seeding allows for a phase change to occur in the fluid flow. The default value is 1e-6. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/area_density/vof_min_seeding").execute(*args, **kwargs) + def ia_grad_sym(self, *args, **kwargs): + """ + Enables/disables the interfacial area density Gradient-Symmetric model. For more information about this model, see . + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/heat_mass_transfer/area_density/ia_grad_sym").execute(*args, **kwargs) - class uu(metaclass=PyMenuMeta): + class advanced_stability_controls(TUIMenu): """ + Enters the menu for the stability controls for multiphase flows. For more information about the below option, see and . """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + self.pseudo_time = self.__class__.pseudo_time(path + [("pseudo_time", None)], service) + self.p_v_coupling = self.__class__.p_v_coupling(path + [("p_v_coupling", None)], service) + self.hybrid_nita = self.__class__.hybrid_nita(path + [("hybrid_nita", None)], service) + self.equation_order = self.__class__.equation_order(path + [("equation_order", None)], service) + self.anti_diffusion = self.__class__.anti_diffusion(path + [("anti_diffusion", None)], service) + super().__init__(path, service) + + class pseudo_time(TUIMenu): + """ + Pseudo-Time stability controls for multiphase flow. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.auto_dt_advanced_controls = self.__class__.auto_dt_advanced_controls(path + [("auto_dt_advanced_controls", None)], service) + super().__init__(path, service) + def smoothed_density_stabilization_method(self, *args, **kwargs): + """ + Set smoothed density stabilization method. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/pseudo_time/smoothed_density_stabilization_method").execute(*args, **kwargs) + def false_time_step_linearization(self, *args, **kwargs): + """ + Set false time-step linearization for added stability. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/pseudo_time/false_time_step_linearization").execute(*args, **kwargs) + + class auto_dt_advanced_controls(TUIMenu): + """ + Set automatic time-stepping controls for better solution stability. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable(self, *args, **kwargs): + """ + Enable advanced automatic time stepping for better stability. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/enable").execute(*args, **kwargs) + def dt_init_limit(self, *args, **kwargs): + """ + Set maximum value for pseudo time step size during first iteration. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/dt_init_limit").execute(*args, **kwargs) + def dt_max(self, *args, **kwargs): + """ + Set maximum value for pseudo time step size. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/dt_max").execute(*args, **kwargs) + def dt_factor_min(self, *args, **kwargs): + """ + Set minimum limit for reduction in pseudo time step size. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/dt_factor_min").execute(*args, **kwargs) + def dt_factor_max(self, *args, **kwargs): + """ + Set maximum limit for increase in pseudo time step size. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/dt_factor_max").execute(*args, **kwargs) + def max_velocity_ratio(self, *args, **kwargs): + """ + Set velocity ratio to freeze the time step size for better solution stability. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/pseudo_time/auto_dt_advanced_controls/max_velocity_ratio").execute(*args, **kwargs) + + class p_v_coupling(TUIMenu): + """ + Enters the menu for the pressure-velocity coupling controls. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.coupled_vof = self.__class__.coupled_vof(path + [("coupled_vof", None)], service) + self.rhie_chow_flux = self.__class__.rhie_chow_flux(path + [("rhie_chow_flux", None)], service) + self.skewness_correction = self.__class__.skewness_correction(path + [("skewness_correction", None)], service) + super().__init__(path, service) + + class coupled_vof(TUIMenu): + """ + Enters the stability control menu for VOF cases that involve the Coupled pressure-velocity coupling scheme. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def buoyancy_force_linearization(self, *args, **kwargs): + """ + Allows you to use the linearized buoyancy force and the blended treatment for the buoyancy force. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/p_v_coupling/coupled_vof/buoyancy_force_linearization").execute(*args, **kwargs) - class vv(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class rhie_chow_flux(TUIMenu): + """ + Enters the stability controls menu for the Rhie-Chow interpolation. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def low_order_rhie_chow(self, *args, **kwargs): + """ + Enables/disables the low-order velocity interpolation in the flux calculation. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/p_v_coupling/rhie_chow_flux/low_order_rhie_chow").execute(*args, **kwargs) - class ww(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class skewness_correction(TUIMenu): + """ + Enters the skewness correction menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def limit_pressure_correction_gradient(self, *args, **kwargs): + """ + Enables/disables the limited pressure correction gradient in skewness terms for the PISO, SIMPLEC, or fractional step pressure-coupling schemes. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/p_v_coupling/skewness_correction/limit_pressure_correction_gradient").execute(*args, **kwargs) - class uv(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class hybrid_nita(TUIMenu): + """ + Enters the equation order menu for homogeneous multiphase flow models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.instability_detector = self.__class__.instability_detector(path + [("instability_detector", None)], service) + super().__init__(path, service) + def outer_iterations(self, *args, **kwargs): + """ + Sets the number of outer iterations. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/hybrid_nita/outer_iterations").execute(*args, **kwargs) + def initial_outer_iterations(self, *args, **kwargs): + """ + Allows you to change the number of initial time-steps and the number of initial outer iterations to control solution stability. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/hybrid_nita/initial_outer_iterations").execute(*args, **kwargs) - class vw(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class instability_detector(TUIMenu): + """ + Enters the menu for the instability detector controls. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable_instability_detector(self, *args, **kwargs): + """ + Enables/disables the instability detector to deal with possible instability problems. Once this option is enabled, additional instability detection options become available. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/enable_instability_detector").execute(*args, **kwargs) + def set_cfl_limit(self, *args, **kwargs): + """ + Sets the Courant number limit for detecting unstable events. This command becomes available once the enable-instability-detector? text option has been enabled. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/set_cfl_limit").execute(*args, **kwargs) + def set_cfl_type(self, *args, **kwargs): + """ + Selects the CFL number type for detection of an unstable event. This command becomes available once the enable-instability-detector? text option has been enabled. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/set_cfl_type").execute(*args, **kwargs) + def set_velocity_limit(self, *args, **kwargs): + """ + Sets the velocity limit for detecting unstable events. This command becomes available once the enable-instability-detector? text option has been enabled. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/set_velocity_limit").execute(*args, **kwargs) + def unstable_event_outer_iterations(self, *args, **kwargs): + """ + Sets the number of outer iterations for an unstable event. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/hybrid_nita/instability_detector/unstable_event_outer_iterations").execute(*args, **kwargs) - class uw(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class equation_order(TUIMenu): + """ + Enters the equation order menu for homogeneous multiphase flow models. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def solve_flow_last(self, *args, **kwargs): + """ + When enabled, solves the flow equation at the end of the iteration. This improves the behavior at the start of new time-step if the solution does not converge properly. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/equation_order/solve_flow_last").execute(*args, **kwargs) + def solve_exp_vof_at_end(self, *args, **kwargs): + """ + Solve Explicit VOF at the end of time-step as an alternative. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/equation_order/solve_exp_vof_at_end").execute(*args, **kwargs) - class ksgs_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class anti_diffusion(TUIMenu): + """ + Enters the anti-diffusion menu. This item is available for VOF cases with the Interfacial Anti-Diffusion option enabled. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable_dynamic_strength(self, *args, **kwargs): + """ + Enables dynamic strength to reduce compression in the direction tangential to the interface. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/anti_diffusion/enable_dynamic_strength").execute(*args, **kwargs) + def set_dynamic_strength_exponent(self, *args, **kwargs): + """ + Sets the cosine exponent in the dynamic strength treatment in ). + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/anti_diffusion/set_dynamic_strength_exponent").execute(*args, **kwargs) + def set_maximum_dynamic_strength(self, *args, **kwargs): + """ + Sets the maximum value of dynamic anti-diffusion strength in ). + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/advanced_stability_controls/anti_diffusion/set_maximum_dynamic_strength").execute(*args, **kwargs) - class ksgs(metaclass=PyMenuMeta): + class default_controls(TUIMenu): """ + Enters the default controls menu. This menu is available only for multiphase flows. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def recommended_defaults_for_existing_cases(self, *args, **kwargs): + """ + Applies the multiphase defaults (version 2020 R1) to the loaded case file. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/default_controls/recommended_defaults_for_existing_cases").execute(*args, **kwargs) + def revert_to_pre_r20_point_1_default_settings(self, *args, **kwargs): + """ + Revert to pre-R20.1 multiphase flow default settings. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/default_controls/revert_to_pre_r20_point_1_default_settings").execute(*args, **kwargs) - class sgs_turb_intensity(metaclass=PyMenuMeta): + class face_pressure_controls(TUIMenu): """ + Enter the face pressure expert controls menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def face_pressure_options(self, *args, **kwargs): + """ + Set face pressure options. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/face_pressure_controls/face_pressure_options").execute(*args, **kwargs) - class geom_disable(metaclass=PyMenuMeta): + class solution_stabilization(TUIMenu): """ + Enters the solution-stabilization numerics menu. This item is available only for the VOF model. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + self.additional_stabilization_controls = self.__class__.additional_stabilization_controls(path + [("additional_stabilization_controls", None)], service) + self.velocity_limiting_treatment = self.__class__.velocity_limiting_treatment(path + [("velocity_limiting_treatment", None)], service) + super().__init__(path, service) + def execute_settings_optimization(self, *args, **kwargs): + """ + Execute optimized settings for VOF. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/execute_settings_optimization").execute(*args, **kwargs) + def execute_advanced_stabilization(self, *args, **kwargs): + """ + When enabled, modifies solver settings for improved solution stability. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/execute_advanced_stabilization").execute(*args, **kwargs) + def execute_additional_stability_controls(self, *args, **kwargs): + """ + When enabled, uses additional controls for improved solution stability. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/execute_additional_stability_controls").execute(*args, **kwargs) - class geom_dir_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class additional_stabilization_controls(TUIMenu): + """ + Enters the menu for additional advanced stability controls. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def blended_compressive_scheme(self, *args, **kwargs): + """ + Enables/disables the blended compressive discretization scheme. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/additional_stabilization_controls/blended_compressive_scheme").execute(*args, **kwargs) + def pseudo_time_stabilization(self, *args, **kwargs): + """ + Pseudo-Time Momentum stabilization and False Time Step Linearization methods for VOF. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/additional_stabilization_controls/pseudo_time_stabilization").execute(*args, **kwargs) - class geom_dir_x(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class velocity_limiting_treatment(TUIMenu): + """ + Enters the menu for the velocity-limiting-treatment. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable_velocity_limiting(self, *args, **kwargs): + """ + Enables/disables the velocity limiting treatment. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/enable_velocity_limiting").execute(*args, **kwargs) + def set_velocity_and_vof_cutoffs(self, *args, **kwargs): + """ + Set phase based velocity limiting controls. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/set_velocity_and_vof_cutoffs").execute(*args, **kwargs) + def set_damping_strengths(self, *args, **kwargs): + """ + Set phase based damping strength. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/set_damping_strengths").execute(*args, **kwargs) + def set_velocity_cutoff(self, *args, **kwargs): + """ + Specifies the maximum velocity magnitude. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/set_velocity_cutoff").execute(*args, **kwargs) + def set_damping_strength(self, *args, **kwargs): + """ + Enter damping strength. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/set_damping_strength").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + When enabled, the solver prints the number of velocity limited cells at each iteration. + """ + return PyMenu(self.service, "/solve/set/multiphase_numerics/solution_stabilization/velocity_limiting_treatment/verbosity").execute(*args, **kwargs) - class geom_dir_y(metaclass=PyMenuMeta): + class open_channel_wave_options(TUIMenu): + """ + Sets buffer layer height, verbosity, and open channel wave theory formulation. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def set_verbosity(self, *args, **kwargs): """ + Sets the open channel wave verbosity. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geom_dir_z(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/open_channel_wave_options/set_verbosity").execute(*args, **kwargs) + def stokes_wave_variants(self, *args, **kwargs): """ + Specifies which open channel wave theory formulation Fluent uses. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class geom_levels(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/open_channel_wave_options/stokes_wave_variants").execute(*args, **kwargs) + def set_buffer_layer_ht(self, *args, **kwargs): """ + Sets the buffer layer height. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/open_channel_wave_options/set_buffer_layer_ht").execute(*args, **kwargs) - class geom_bgthread(metaclass=PyMenuMeta): + class high_order_term_relaxation(TUIMenu): + """ + Enter High Order Relaxation Menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.options = self.__class__.options(path + [("options", None)], service) + super().__init__(path, service) + def enable(self, *args, **kwargs): """ + Enables/disables High Order Term Relaxation. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/high_order_term_relaxation/enable").execute(*args, **kwargs) - class t(metaclass=PyMenuMeta): + class options(TUIMenu): """ + High Order Term Relaxation Options. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + self.variables = self.__class__.variables(path + [("variables", None)], service) + super().__init__(path, service) + def relaxation_factor(self, *args, **kwargs): + """ + Sets the relaxation factor. + """ + return PyMenu(self.service, "/solve/set/high_order_term_relaxation/options/relaxation_factor").execute(*args, **kwargs) + def expert(self, *args, **kwargs): + """ + Enter high order relaxation option with respect to diffusion gradient. + """ + return PyMenu(self.service, "/solve/set/high_order_term_relaxation/options/expert").execute(*args, **kwargs) - class non_equil_boundary(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class variables(TUIMenu): + """ + Selects the variables. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def select(self, *args, **kwargs): + """ + Select variables for high order term relaxation. + """ + return PyMenu(self.service, "/solve/set/high_order_term_relaxation/options/variables/select").execute(*args, **kwargs) - class tve(metaclass=PyMenuMeta): + class poor_mesh_numerics(TUIMenu): + """ + Enters the poor mesh numerics menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.solution_based_pmn = self.__class__.solution_based_pmn(path + [("solution_based_pmn", None)], service) + super().__init__(path, service) + def enable(self, *args, **kwargs): """ + Enables/disables the application of poor mesh numerics on cells (those with an orthogonal quality of 0, as well as those identified by other enabled criteria), and defines whether the local solution correction is 0th, 1st, or 2nd order. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class pressure_inlet(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.frame_of_reference = self.__class__.frame_of_reference(path + [("frame_of_reference", None)], service) - self.p0 = self.__class__.p0(path + [("p0", None)], service) - self.p = self.__class__.p(path + [("p", None)], service) - self.direction_spec = self.__class__.direction_spec(path + [("direction_spec", None)], service) - self.coordinate_system = self.__class__.coordinate_system(path + [("coordinate_system", None)], service) - self.ni = self.__class__.ni(path + [("ni", None)], service) - self.nj = self.__class__.nj(path + [("nj", None)], service) - self.nk = self.__class__.nk(path + [("nk", None)], service) - self.ni2 = self.__class__.ni2(path + [("ni2", None)], service) - self.nj2 = self.__class__.nj2(path + [("nj2", None)], service) - self.nk2 = self.__class__.nk2(path + [("nk2", None)], service) - self.ai = self.__class__.ai(path + [("ai", None)], service) - self.aj = self.__class__.aj(path + [("aj", None)], service) - self.ak = self.__class__.ak(path + [("ak", None)], service) - self.x_origin = self.__class__.x_origin(path + [("x_origin", None)], service) - self.y_origin = self.__class__.y_origin(path + [("y_origin", None)], service) - self.z_origin = self.__class__.z_origin(path + [("z_origin", None)], service) - self.vm_number_of_vortices = self.__class__.vm_number_of_vortices(path + [("vm_number_of_vortices", None)], service) - self.vm_streamwise_fluct = self.__class__.vm_streamwise_fluct(path + [("vm_streamwise_fluct", None)], service) - self.vm_mass_conservation = self.__class__.vm_mass_conservation(path + [("vm_mass_conservation", None)], service) - self.volumetric_synthetic_turbulence_generator = self.__class__.volumetric_synthetic_turbulence_generator(path + [("volumetric_synthetic_turbulence_generator", None)], service) - self.volumetric_synthetic_turbulence_generator_option = self.__class__.volumetric_synthetic_turbulence_generator_option(path + [("volumetric_synthetic_turbulence_generator_option", None)], service) - self.volumetric_synthetic_turbulence_generator_option_thickness = self.__class__.volumetric_synthetic_turbulence_generator_option_thickness(path + [("volumetric_synthetic_turbulence_generator_option_thickness", None)], service) - self.prevent_reverse_flow = self.__class__.prevent_reverse_flow(path + [("prevent_reverse_flow", None)], service) - self.ke_spec = self.__class__.ke_spec(path + [("ke_spec", None)], service) - self.nut = self.__class__.nut(path + [("nut", None)], service) - self.kl = self.__class__.kl(path + [("kl", None)], service) - self.intermit = self.__class__.intermit(path + [("intermit", None)], service) - self.k = self.__class__.k(path + [("k", None)], service) - self.e = self.__class__.e(path + [("e", None)], service) - self.o = self.__class__.o(path + [("o", None)], service) - self.v2 = self.__class__.v2(path + [("v2", None)], service) - self.turb_intensity = self.__class__.turb_intensity(path + [("turb_intensity", None)], service) - self.turb_length_scale = self.__class__.turb_length_scale(path + [("turb_length_scale", None)], service) - self.turb_hydraulic_diam = self.__class__.turb_hydraulic_diam(path + [("turb_hydraulic_diam", None)], service) - self.turb_viscosity_ratio = self.__class__.turb_viscosity_ratio(path + [("turb_viscosity_ratio", None)], service) - self.turb_viscosity_ratio_profile = self.__class__.turb_viscosity_ratio_profile(path + [("turb_viscosity_ratio_profile", None)], service) - self.rst_spec = self.__class__.rst_spec(path + [("rst_spec", None)], service) - self.uu = self.__class__.uu(path + [("uu", None)], service) - self.vv = self.__class__.vv(path + [("vv", None)], service) - self.ww = self.__class__.ww(path + [("ww", None)], service) - self.uv = self.__class__.uv(path + [("uv", None)], service) - self.vw = self.__class__.vw(path + [("vw", None)], service) - self.uw = self.__class__.uw(path + [("uw", None)], service) - self.ksgs_spec = self.__class__.ksgs_spec(path + [("ksgs_spec", None)], service) - self.ksgs = self.__class__.ksgs(path + [("ksgs", None)], service) - self.sgs_turb_intensity = self.__class__.sgs_turb_intensity(path + [("sgs_turb_intensity", None)], service) - self.les_spec_name = self.__class__.les_spec_name(path + [("les_spec_name", None)], service) - self.wsf = self.__class__.wsf(path + [("wsf", None)], service) - self.wsb = self.__class__.wsb(path + [("wsb", None)], service) - self.wsn = self.__class__.wsn(path + [("wsn", None)], service) - self.ac_options = self.__class__.ac_options(path + [("ac_options", None)], service) - self.ac_wave = self.__class__.ac_wave(path + [("ac_wave", None)], service) - self.impedance_0 = self.__class__.impedance_0(path + [("impedance_0", None)], service) - self.t0 = self.__class__.t0(path + [("t0", None)], service) - - class frame_of_reference(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class p0(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/poor_mesh_numerics/enable").execute(*args, **kwargs) + def cell_quality_based(self, *args, **kwargs): """ + Enables/disables the application of poor mesh numerics on cells with an orthogonal quality that is equal to or less than the threshold defined by the solve/set/poor-mesh-numerics/set-quality-threshold text command (which by default is set to 0.05). """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class p(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/poor_mesh_numerics/cell_quality_based").execute(*args, **kwargs) + def set_quality_threshold(self, *args, **kwargs): """ + Sets the orthogonal quality threshold used for applying poor mesh numerics when the solve/set/poor-mesh-numerics/cell-quality-based? text command is enabled. By default, cells with an orthogonal quality of 0.05 or lower are corrected. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class direction_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/poor_mesh_numerics/set_quality_threshold").execute(*args, **kwargs) + def solution_and_quality_based(self, *args, **kwargs): """ + Enables/disables the detection and treatment of poor cells using a criterion based on the solution and cell quality. Poor mesh numerics are applied when the criterion value is equal to or less than a threshold value defined as part of this text command, and at a specified frequency (of iterations or time steps). This criterion is only available with the pressure-based solver. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coordinate_system(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/poor_mesh_numerics/solution_and_quality_based").execute(*args, **kwargs) + def gradient_quality_based(self, *args, **kwargs): """ + Enables/disables the detection and treatment of poor cells using a criterion based on the cell gradient quality. Poor mesh numerics are applied when the criterion value is equal to or less than a threshold value defined as part of this text command. This criterion is only available with the pressure-based solver, and is not supported for cases that have periodic boundaries. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ni(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/poor_mesh_numerics/gradient_quality_based").execute(*args, **kwargs) + def orthogonality_enhancing_cell_centroids(self, *args, **kwargs): """ + Enables/disables the relocation of select cell centroids, to improve the orthogonality metrics and solution stability. It is applied to cells when the criterion value is equal to or less than a threshold value defined as part of the text command. Note that the enhanced metrics are only apparent when reporting the quality in the solution mode of Fluent, and not in the meshing mode. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nj(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/poor_mesh_numerics/orthogonality_enhancing_cell_centroids").execute(*args, **kwargs) + def user_defined_on_register(self, *args, **kwargs): """ + Includes a register for the poor mesh numerics or not. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nk(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/poor_mesh_numerics/user_defined_on_register").execute(*args, **kwargs) + def reset_poor_elements(self, *args, **kwargs): """ + Resets the list of poor cells included by the default, cell quality, user-defined, cell gradient quality, and solution and cell quality criteria. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ni2(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/poor_mesh_numerics/reset_poor_elements").execute(*args, **kwargs) + def print_poor_elements_count(self, *args, **kwargs): """ + Prints out a listing of the poor cells for each criterion: default, cell quality, and user-defined, and (if enabled) cell gradient quality and solution and cell quality. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nj2(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/poor_mesh_numerics/print_poor_elements_count").execute(*args, **kwargs) + def enhanced_pmn(self, *args, **kwargs): """ + This option is available with the density-based solver. When enabled, it will apply quality-based poor-mesh-numerics order=1 on any cells with a quality-measure below 0.2. In addition, their CFL number is limited to 1.0. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/poor_mesh_numerics/enhanced_pmn").execute(*args, **kwargs) - class nk2(metaclass=PyMenuMeta): + class solution_based_pmn(TUIMenu): """ + Solution based poor-mesh numerics menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def enable(self, *args, **kwargs): + """ + Enable solution based treatment. + """ + return PyMenu(self.service, "/solve/set/poor_mesh_numerics/solution_based_pmn/enable").execute(*args, **kwargs) + def mark_primary_solution_limits(self, *args, **kwargs): + """ + Mark cells violating solution limits. + """ + return PyMenu(self.service, "/solve/set/poor_mesh_numerics/solution_based_pmn/mark_primary_solution_limits").execute(*args, **kwargs) + def mark_velocity_limit(self, *args, **kwargs): + """ + Mark cells exceeding velocity limit. + """ + return PyMenu(self.service, "/solve/set/poor_mesh_numerics/solution_based_pmn/mark_velocity_limit").execute(*args, **kwargs) + def mark_cfl_limit(self, *args, **kwargs): + """ + Mark cells exceeding cfl limit. + """ + return PyMenu(self.service, "/solve/set/poor_mesh_numerics/solution_based_pmn/mark_cfl_limit").execute(*args, **kwargs) + def mark_cfl_jump(self, *args, **kwargs): + """ + Mark cells exceeding cfl jump in neighborhood. + """ + return PyMenu(self.service, "/solve/set/poor_mesh_numerics/solution_based_pmn/mark_cfl_jump").execute(*args, **kwargs) - class ai(metaclass=PyMenuMeta): + class amg_options(TUIMenu): + """ + Enters the AMG options menu + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def laplace_coarsening(self, *args, **kwargs): """ + Enables / disables Laplace coarsening for scalar and/or coupled equations. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class aj(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/amg_options/laplace_coarsening").execute(*args, **kwargs) + def conservative_amg_coarsening(self, *args, **kwargs): """ + Enables / disables the use of conservative coarsening techniques for scalar and/or coupled equations that can improve parallel performance and/or convergence for some difficult cases. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ak(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/amg_options/conservative_amg_coarsening").execute(*args, **kwargs) + def aggressive_amg_coarsening(self, *args, **kwargs): """ + Enables / disables the use of a version of the AMG solver that is optimized for high coarsening rates. This option is recommended if the AMG solver diverges with the default settings. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class x_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/amg_options/aggressive_amg_coarsening").execute(*args, **kwargs) + def amg_gpgpu_options(self, *args, **kwargs): """ + Set GPGPU AMG solver options. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/amg_options/amg_gpgpu_options").execute(*args, **kwargs) - class y_origin(metaclass=PyMenuMeta): + class warped_face_gradient_correction(TUIMenu): + """ + Enters the warped-face gradient correction menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable(self, *args, **kwargs): """ + Enables/disables gradient enhancement computations and specifies whether Fluent uses fast or memory saving mode. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class z_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/warped_face_gradient_correction/enable").execute(*args, **kwargs) + def turbulence_options(self, *args, **kwargs): """ + Set turbulence Warped Face Gradient Correction. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/warped_face_gradient_correction/turbulence_options").execute(*args, **kwargs) - class vm_number_of_vortices(metaclass=PyMenuMeta): + class fast_transient_settings(TUIMenu): + """ + Enters the fast transient settings menu. This menu is only available for transient cases that use the density-based solver. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def rk2(self, *args, **kwargs): """ + Allows you to enable the use of a two-stage Runge-Kutta scheme for time integration, or revert to the default multi-stage Runge-Kutta scheme. This text command is only available for transient cases that use the density-based explicit formulation. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/fast_transient_settings/rk2").execute(*args, **kwargs) - class vm_streamwise_fluct(metaclass=PyMenuMeta): + class divergence_prevention(TUIMenu): + """ + Enters the divergence prevention menu. This menu is only available for the density-based solver. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable(self, *args, **kwargs): """ + Enables a divergence prevention option so that Fluent applies under-relaxation to the variables in select cells where the temperature and/or pressure values are approaching the minimum and/or maximum limits. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/divergence_prevention/enable").execute(*args, **kwargs) - class vm_mass_conservation(metaclass=PyMenuMeta): + class advanced(TUIMenu): + """ + Enters the advanced settings menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.non_reflecting_boundary_treatment = self.__class__.non_reflecting_boundary_treatment(path + [("non_reflecting_boundary_treatment", None)], service) + self.secondary_gradient_limiting = self.__class__.secondary_gradient_limiting(path + [("secondary_gradient_limiting", None)], service) + self.turbo_solver_options = self.__class__.turbo_solver_options(path + [("turbo_solver_options", None)], service) + super().__init__(path, service) + def energy_numerical_noise_filter(self, *args, **kwargs): """ + Enables/disables a filter to eliminate non-physical numerical noise in the energy field. Numerical noise can appear in solution fields where large variations in specific heat or combustion with phase change are present. Using the energy equation numerical noise filter increases robustness, but may make the solution slightly more diffusive. This text command is only available with the pressure-based solver. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class volumetric_synthetic_turbulence_generator(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/advanced/energy_numerical_noise_filter").execute(*args, **kwargs) + def linearized_mass_transfer_udf(self, *args, **kwargs): """ + Enables/disables the use of a linearized mass transfer user-defined function (that is, the DEFINE_LINEARIZED_MASS_TRANSFER macro), as opposed to a mass transfer user-defined function (that is, the DEFINE_MASS_TRANSFER macro). """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class volumetric_synthetic_turbulence_generator_option(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/advanced/linearized_mass_transfer_udf").execute(*args, **kwargs) + def singhal_et_al_cavitation_model(self, *args, **kwargs): """ + Enables/disables the availability of the Singhal et al. cavitation model option, which can then be enabled in the Multiphase Model dialog box or by using the following text command: define/phases/set-domain-properties/interaction-domain/heat-mass-reaction/cavitation/cavitation?. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class volumetric_synthetic_turbulence_generator_option_thickness(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/advanced/singhal_et_al_cavitation_model").execute(*args, **kwargs) + def alternate_wall_temp_formulation(self, *args, **kwargs): """ + Enables/disables an alternate formulation for wall temperatures. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class prevent_reverse_flow(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/advanced/alternate_wall_temp_formulation").execute(*args, **kwargs) + def retain_cell_residuals(self, *args, **kwargs): """ + Enables/disables the retention of cell residuals for postprocessing. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ke_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/advanced/retain_cell_residuals").execute(*args, **kwargs) + def retain_temporary_solver_mem(self, *args, **kwargs): """ + Enables/disables the retention of temporary solver memory, which retains gradient data and makes some advanced options available for postprocessing. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nut(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/advanced/retain_temporary_solver_mem").execute(*args, **kwargs) + def show_all_discretization_schemes(self, *args, **kwargs): """ + Enables/disables the availability of all applicable discretization schemes. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class kl(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/advanced/show_all_discretization_schemes").execute(*args, **kwargs) + def explicit_under_relaxation_value(self, *args, **kwargs): """ + Explicit under-relaxation value. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class intermit(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/advanced/explicit_under_relaxation_value").execute(*args, **kwargs) + def correction_form(self, *args, **kwargs): """ + S """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class k(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/advanced/correction_form").execute(*args, **kwargs) + def energy_reconstruction_gradient_limiting(self, *args, **kwargs): """ + Enable limiting of reconstruction gradient for the energy equation. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class e(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/advanced/energy_reconstruction_gradient_limiting").execute(*args, **kwargs) + def bcd_boundedness(self, *args, **kwargs): """ + Specifies the BCD scheme parameter, which controls the boundedness strength of the BCD scheme in the pressure-based solver, as described in . """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class o(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/advanced/bcd_boundedness").execute(*args, **kwargs) + def bcd_weights_freeze(self, *args, **kwargs): """ + Enables/disables freezing of weighting coefficients of the central differencing and the upwind components of the BCD scheme. This dialog command requires the iteration number, after which the BCD scheme weights are to be frozen at each timestep. Freezing the BCD weighting coefficients may help to improve convergence of the timestep iterations as described in . """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class v2(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/advanced/bcd_weights_freeze").execute(*args, **kwargs) + def anisotropic_heat_flux(self, *args, **kwargs): """ + Select the heat flux calculation methods. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_intensity(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/advanced/anisotropic_heat_flux").execute(*args, **kwargs) + def skewness_correction_enhanced(self, *args, **kwargs): """ + Enable enhanced skewness correction scheme. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/advanced/skewness_correction_enhanced").execute(*args, **kwargs) - class turb_length_scale(metaclass=PyMenuMeta): + class non_reflecting_boundary_treatment(TUIMenu): """ + Enter non reflecting boundary treatment using minimal pressure reflection approach menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def pressure_inlet(self, *args, **kwargs): + """ + Enabling the use of minimal pressure reflection treatment. This treatment will minimize pressure wave reflections from the boundaries on which this option is active, but not necessarily fully eliminating them. The reflections would be of an acceptable limit in order to not contaminate the solution, the simulation will gain from the robustness of the new algorithm compared to traditional non-reflecting boundary condition treatment. + """ + return PyMenu(self.service, "/solve/set/advanced/non_reflecting_boundary_treatment/pressure_inlet").execute(*args, **kwargs) + def pressure_outlet(self, *args, **kwargs): + """ + Enabling the use of minimal pressure reflection treatment. This treatment will minimize pressure wave reflections from the boundaries on which this option is active, but not necessarily fully eliminating them. The reflections would be of an acceptable limit in order to not contaminate the solution, the simulation will gain from the robustness of the new algorithm compared to traditional non-reflecting boundary condition treatment. + """ + return PyMenu(self.service, "/solve/set/advanced/non_reflecting_boundary_treatment/pressure_outlet").execute(*args, **kwargs) + def velocity_inlet(self, *args, **kwargs): + """ + Enabling the use of minimal pressure reflection treatment. This treatment will minimize pressure wave reflections from the boundaries on which this option is active, but not necessarily fully eliminating them. The reflections would be of an acceptable limit in order to not contaminate the solution, the simulation will gain from the robustness of the new algorithm compared to traditional non-reflecting boundary condition treatment. + """ + return PyMenu(self.service, "/solve/set/advanced/non_reflecting_boundary_treatment/velocity_inlet").execute(*args, **kwargs) - class turb_hydraulic_diam(metaclass=PyMenuMeta): + class secondary_gradient_limiting(TUIMenu): """ + Enters the secondary gradient limiting menu. This menu is only available when the define/models/solver/pressure-based text command is enabled. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def energy(self, *args, **kwargs): + """ + Enables/disables secondary gradient limiting for the energy calculations on coupled two-sided walls. This limiting can help prevent divergence when the cells on such walls have poor orthogonality. + """ + return PyMenu(self.service, "/solve/set/advanced/secondary_gradient_limiting/energy").execute(*args, **kwargs) + def uds(self, *args, **kwargs): + """ + Enables/disables secondary gradient limiting for the user-defined scalar (UDS) calculations on coupled two-sided walls. This limiting can help prevent divergence when the cells on such walls have poor orthogonality. + """ + return PyMenu(self.service, "/solve/set/advanced/secondary_gradient_limiting/uds").execute(*args, **kwargs) + def mesh_quality_limits(self, *args, **kwargs): + """ + Defines the mesh quality limits used when applying secondary gradient limiting to faces on coupled two-sided walls. Shifting this range closer to 1 will decrease the risk of divergence, but at the cost of accuracy. + """ + return PyMenu(self.service, "/solve/set/advanced/secondary_gradient_limiting/mesh_quality_limits").execute(*args, **kwargs) - class turb_viscosity_ratio(metaclass=PyMenuMeta): + class turbo_solver_options(TUIMenu): """ + Enter turbo expert solver options menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def enable(self, *args, **kwargs): + """ + Enable/disable turbomachinery expert solver options. + """ + return PyMenu(self.service, "/solve/set/advanced/turbo_solver_options/enable").execute(*args, **kwargs) + def continuity_relaxation_at_walls(self, *args, **kwargs): + """ + Enable and specify options for continuity relaxation at wall boundaries. + """ + return PyMenu(self.service, "/solve/set/advanced/turbo_solver_options/continuity_relaxation_at_walls").execute(*args, **kwargs) - class turb_viscosity_ratio_profile(metaclass=PyMenuMeta): + class high_speed_numerics(TUIMenu): + """ + Enter high-speed-numerics menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def enable(self, *args, **kwargs): """ + Enables/disables High Speed Numerics. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class rst_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/high_speed_numerics/enable").execute(*args, **kwargs) + def expert(self, *args, **kwargs): """ + Sets the level of stabilization used to achieve fast convergence. Enter a number 0-5 corresponding to the Mach number range that best characterizes the flow. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uu(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/high_speed_numerics/expert").execute(*args, **kwargs) + def visualize_pressure_discontinuity_sensor(self, *args, **kwargs): """ + Makes available the Pressure Discontinuity Sensor which is a binary identifier equal to 1 if a cell is in proximity of a pressure discontinuity. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/high_speed_numerics/visualize_pressure_discontinuity_sensor").execute(*args, **kwargs) - class vv(metaclass=PyMenuMeta): + class previous_defaults(TUIMenu): + """ + Provides text commands that allow you to undo enhancements to the default solver behavior. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def undo_r19_point_0_default_changes(self, *args, **kwargs): """ + Undo default changes introduced in R19.0. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ww(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/previous_defaults/undo_r19_point_0_default_changes").execute(*args, **kwargs) + def undo_2019r1_default_changes(self, *args, **kwargs): """ + Allows you to undo enhancements introduced in version 2019 R1 of ANSYS Fluent, including: """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uv(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/previous_defaults/undo_2019r1_default_changes").execute(*args, **kwargs) + def undo_2019r3_default_changes(self, *args, **kwargs): """ + Allows you to undo enhancements introduced in version 2019 R3 of ANSYS Fluent, including: """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vw(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/previous_defaults/undo_2019r3_default_changes").execute(*args, **kwargs) + def undo_2021r1_default_changes(self, *args, **kwargs): """ + Allows you to undo enhancements introduced in version 2021 R1 of ANSYS Fluent, including: """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uw(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/previous_defaults/undo_2021r1_default_changes").execute(*args, **kwargs) + def undo_2021r2_default_changes(self, *args, **kwargs): """ + Allows you to undo the following enhancements introduced in version 2021 R2 of ANSYS Fluent: """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ksgs_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/previous_defaults/undo_2021r2_default_changes").execute(*args, **kwargs) + def undo_2022r1_default_changes(self, *args, **kwargs): """ + Allows you to undo the following enhancements introduced in version 2022 R1 of ANSYS Fluent: """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/previous_defaults/undo_2022r1_default_changes").execute(*args, **kwargs) - class ksgs(metaclass=PyMenuMeta): + class overset(TUIMenu): + """ + Specifies overset meshing solver options. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.expert = self.__class__.expert(path + [("expert", None)], service) + super().__init__(path, service) + def high_order_pressure(self, *args, **kwargs): """ + Uses the pressure gradient of the donor cell in the interpolation of pressure for its receptor cell. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sgs_turb_intensity(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/overset/high_order_pressure").execute(*args, **kwargs) + def interpolation_method(self, *args, **kwargs): """ + Selects the interpolation method for overset interfaces. Note that the least squares method is recommended for sliding mesh cases. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class les_spec_name(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/overset/interpolation_method").execute(*args, **kwargs) + def orphan_cell_treatment(self, *args, **kwargs): """ + Enables/disables a numerical treatment that attempts to assign reasonable data values to orphan cells. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/overset/orphan_cell_treatment").execute(*args, **kwargs) - class wsf(metaclass=PyMenuMeta): + class expert(TUIMenu): """ + Enter overset expert solver options menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def mass_flux_correction_method(self, *args, **kwargs): + """ + Enter mass flux correction option at overset interfaces. + """ + return PyMenu(self.service, "/solve/set/overset/expert/mass_flux_correction_method").execute(*args, **kwargs) + def hybrid_mode_selection(self, *args, **kwargs): + """ + Mode for hybrid interpolation. + """ + return PyMenu(self.service, "/solve/set/overset/expert/hybrid_mode_selection").execute(*args, **kwargs) - class wsb(metaclass=PyMenuMeta): + class acoustics_wave_equation_controls(TUIMenu): + """ + Enters the menu to specify parameters of the acoustics wave equation solver. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.expert = self.__class__.expert(path + [("expert", None)], service) + super().__init__(path, service) + def relative_convergence_criterion(self, *args, **kwargs): """ + Specify convergence tolerance for the timestep iterations + as the target residual reduction factor. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wsn(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/acoustics_wave_equation_controls/relative_convergence_criterion").execute(*args, **kwargs) + def max_iterations_per_timestep(self, *args, **kwargs): """ + Specify maximum number of iterations per timestep. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/acoustics_wave_equation_controls/max_iterations_per_timestep").execute(*args, **kwargs) - class ac_options(metaclass=PyMenuMeta): + class expert(TUIMenu): """ + Enters the menu to specify the expert parameters. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def under_relaxation_factor(self, *args, **kwargs): + """ + Specifies the implicit under-relaxation factor. Should be used only with bad meshes, when the AMG linear solver does not converge. + """ + return PyMenu(self.service, "/solve/set/acoustics_wave_equation_controls/expert/under_relaxation_factor").execute(*args, **kwargs) + def explicit_relaxation_factor(self, *args, **kwargs): + """ + Specifies the explicit relaxation factor. Should be used only with bad meshes, when iterations do not converge. + """ + return PyMenu(self.service, "/solve/set/acoustics_wave_equation_controls/expert/explicit_relaxation_factor").execute(*args, **kwargs) - class ac_wave(metaclass=PyMenuMeta): + class p_v_controls_advanced(TUIMenu): + """ + Set advanced pressure-velocity coupling controls. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def pp_face_gradient_linearization(self, *args, **kwargs): """ + End of pp-face-gradient-linearization. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class impedance_0(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/p_v_controls_advanced/pp_face_gradient_linearization").execute(*args, **kwargs) + def pp_face_interpolation(self, *args, **kwargs): """ + End of pp-face-interpolation. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class t0(metaclass=PyMenuMeta): + return PyMenu(self.service, "/solve/set/p_v_controls_advanced/pp_face_interpolation").execute(*args, **kwargs) + def pp_node_based_grad(self, *args, **kwargs): """ + End of pp-node-based-grad. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/solve/set/p_v_controls_advanced/pp_node_based_grad").execute(*args, **kwargs) - class pressure_outlet(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.prevent_reverse_flow = self.__class__.prevent_reverse_flow(path + [("prevent_reverse_flow", None)], service) - self.radial = self.__class__.radial(path + [("radial", None)], service) - self.gen_nrbc_spec = self.__class__.gen_nrbc_spec(path + [("gen_nrbc_spec", None)], service) - self.avg_press_spec = self.__class__.avg_press_spec(path + [("avg_press_spec", None)], service) - self.avg_option = self.__class__.avg_option(path + [("avg_option", None)], service) - self.targeted_mf_boundary = self.__class__.targeted_mf_boundary(path + [("targeted_mf_boundary", None)], service) - self.targeted_mf = self.__class__.targeted_mf(path + [("targeted_mf", None)], service) - self.targeted_mf_pmax = self.__class__.targeted_mf_pmax(path + [("targeted_mf_pmax", None)], service) - self.targeted_mf_pmin = self.__class__.targeted_mf_pmin(path + [("targeted_mf_pmin", None)], service) - self.press_spec_gen = self.__class__.press_spec_gen(path + [("press_spec_gen", None)], service) - self.p_backflow_spec = self.__class__.p_backflow_spec(path + [("p_backflow_spec", None)], service) - self.p_backflow_spec_gen = self.__class__.p_backflow_spec_gen(path + [("p_backflow_spec_gen", None)], service) - self.ac_options = self.__class__.ac_options(path + [("ac_options", None)], service) - self.ac_wave = self.__class__.ac_wave(path + [("ac_wave", None)], service) - self.impedance_0 = self.__class__.impedance_0(path + [("impedance_0", None)], service) - self.p = self.__class__.p(path + [("p", None)], service) - self.p_profile_multiplier = self.__class__.p_profile_multiplier(path + [("p_profile_multiplier", None)], service) - self.direction_spec = self.__class__.direction_spec(path + [("direction_spec", None)], service) - self.frame_of_reference = self.__class__.frame_of_reference(path + [("frame_of_reference", None)], service) - self.coordinate_system = self.__class__.coordinate_system(path + [("coordinate_system", None)], service) - self.ni = self.__class__.ni(path + [("ni", None)], service) - self.nj = self.__class__.nj(path + [("nj", None)], service) - self.nk = self.__class__.nk(path + [("nk", None)], service) - self.ai = self.__class__.ai(path + [("ai", None)], service) - self.aj = self.__class__.aj(path + [("aj", None)], service) - self.ak = self.__class__.ak(path + [("ak", None)], service) - self.x_origin = self.__class__.x_origin(path + [("x_origin", None)], service) - self.y_origin = self.__class__.y_origin(path + [("y_origin", None)], service) - self.z_origin = self.__class__.z_origin(path + [("z_origin", None)], service) - self.ke_spec = self.__class__.ke_spec(path + [("ke_spec", None)], service) - self.nut = self.__class__.nut(path + [("nut", None)], service) - self.kl = self.__class__.kl(path + [("kl", None)], service) - self.intermit = self.__class__.intermit(path + [("intermit", None)], service) - self.k = self.__class__.k(path + [("k", None)], service) - self.e = self.__class__.e(path + [("e", None)], service) - self.o = self.__class__.o(path + [("o", None)], service) - self.v2 = self.__class__.v2(path + [("v2", None)], service) - self.turb_intensity = self.__class__.turb_intensity(path + [("turb_intensity", None)], service) - self.turb_length_scale = self.__class__.turb_length_scale(path + [("turb_length_scale", None)], service) - self.turb_hydraulic_diam = self.__class__.turb_hydraulic_diam(path + [("turb_hydraulic_diam", None)], service) - self.turb_viscosity_ratio = self.__class__.turb_viscosity_ratio(path + [("turb_viscosity_ratio", None)], service) - self.turb_viscosity_ratio_profile = self.__class__.turb_viscosity_ratio_profile(path + [("turb_viscosity_ratio_profile", None)], service) - self.rst_spec = self.__class__.rst_spec(path + [("rst_spec", None)], service) - self.uu = self.__class__.uu(path + [("uu", None)], service) - self.vv = self.__class__.vv(path + [("vv", None)], service) - self.ww = self.__class__.ww(path + [("ww", None)], service) - self.uv = self.__class__.uv(path + [("uv", None)], service) - self.vw = self.__class__.vw(path + [("vw", None)], service) - self.uw = self.__class__.uw(path + [("uw", None)], service) - self.ksgs_spec = self.__class__.ksgs_spec(path + [("ksgs_spec", None)], service) - self.ksgs = self.__class__.ksgs(path + [("ksgs", None)], service) - self.sgs_turb_intensity = self.__class__.sgs_turb_intensity(path + [("sgs_turb_intensity", None)], service) - self.wsf = self.__class__.wsf(path + [("wsf", None)], service) - self.wsb = self.__class__.wsb(path + [("wsb", None)], service) - self.wsn = self.__class__.wsn(path + [("wsn", None)], service) - self.t0 = self.__class__.t0(path + [("t0", None)], service) - - class prevent_reverse_flow(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class execute_commands(TUIMenu): + """ + Enters the execute commands menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def add_edit(self, *args, **kwargs): + """ + Adds or edits execute commands. + """ + return PyMenu(self.service, "/solve/execute_commands/add_edit").execute(*args, **kwargs) + def enable(self, *args, **kwargs): + """ + Enables an execute command. + """ + return PyMenu(self.service, "/solve/execute_commands/enable").execute(*args, **kwargs) + def disable(self, *args, **kwargs): + """ + Disables an execute command. + """ + return PyMenu(self.service, "/solve/execute_commands/disable").execute(*args, **kwargs) + def copy(self, *args, **kwargs): + """ + Copy an execute-command. + """ + return PyMenu(self.service, "/solve/execute_commands/copy").execute(*args, **kwargs) + def delete(self, *args, **kwargs): + """ + Delete an execute-command. + """ + return PyMenu(self.service, "/solve/execute_commands/delete").execute(*args, **kwargs) + def export(self, *args, **kwargs): + """ + Export execute-commands to a TSV file. + """ + return PyMenu(self.service, "/solve/execute_commands/export").execute(*args, **kwargs) + def import_(self, *args, **kwargs): + """ + Import execute-commands from a TSV file. + """ + return PyMenu(self.service, "/solve/execute_commands/import").execute(*args, **kwargs) - class radial(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class setup(TUIMenu): + """ + Enter setup menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.boundary_conditions = self.__class__.boundary_conditions(path + [("boundary_conditions", None)], service) + self.dynamic_mesh = self.__class__.dynamic_mesh(path + [("dynamic_mesh", None)], service) + self.expert = self.__class__.expert(path + [("expert", None)], service) + self.gap_model = self.__class__.gap_model(path + [("gap_model", None)], service) + self.materials = self.__class__.materials(path + [("materials", None)], service) + self.mesh_interfaces = self.__class__.mesh_interfaces(path + [("mesh_interfaces", None)], service) + self.mixing_planes = self.__class__.mixing_planes(path + [("mixing_planes", None)], service) + self.models = self.__class__.models(path + [("models", None)], service) + self.named_expressions = self.__class__.named_expressions(path + [("named_expressions", None)], service) + self.operating_conditions = self.__class__.operating_conditions(path + [("operating_conditions", None)], service) + self.overset_interfaces = self.__class__.overset_interfaces(path + [("overset_interfaces", None)], service) + self.reference_frames = self.__class__.reference_frames(path + [("reference_frames", None)], service) + self.reference_values = self.__class__.reference_values(path + [("reference_values", None)], service) + self.turbo_model = self.__class__.turbo_model(path + [("turbo_model", None)], service) + super().__init__(path, service) + + class boundary_conditions(TUIMenu): + """ + Enter the boudary conditions menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.bc_settings = self.__class__.bc_settings(path + [("bc_settings", None)], service) + self.expert = self.__class__.expert(path + [("expert", None)], service) + self.modify_zones = self.__class__.modify_zones(path + [("modify_zones", None)], service) + self.profiles = self.__class__.profiles(path + [("profiles", None)], service) + self.query = self.__class__.query(path + [("query", None)], service) + self.rename_zone = self.__class__.rename_zone(path + [("rename_zone", None)], service) + self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) + def axis(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/axis").execute(*args, **kwargs) + def copy_bc(self, *args, **kwargs): + """ + Copy boundary conditions to another zone. + """ + return PyMenu(self.service, "/setup/boundary_conditions/copy_bc").execute(*args, **kwargs) + def degassing(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/degassing").execute(*args, **kwargs) + def exhaust_fan(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/exhaust_fan").execute(*args, **kwargs) + def fan(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/fan").execute(*args, **kwargs) + def fluid(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/fluid").execute(*args, **kwargs) + def geometry(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/geometry").execute(*args, **kwargs) + def inlet_vent(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/inlet_vent").execute(*args, **kwargs) + def intake_fan(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/intake_fan").execute(*args, **kwargs) + def interface(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/interface").execute(*args, **kwargs) + def interior(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/interior").execute(*args, **kwargs) + def list_zones(self, *args, **kwargs): + """ + List zone IDs, types, kinds, and names. + """ + return PyMenu(self.service, "/setup/boundary_conditions/list_zones").execute(*args, **kwargs) + def mass_flow_inlet(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/mass_flow_inlet").execute(*args, **kwargs) + def mass_flow_outlet(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/mass_flow_outlet").execute(*args, **kwargs) + def network(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/network").execute(*args, **kwargs) + def network_end(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/network_end").execute(*args, **kwargs) + def outflow(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/outflow").execute(*args, **kwargs) + def outlet_vent(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/outlet_vent").execute(*args, **kwargs) + def overset(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/overset").execute(*args, **kwargs) + def periodic(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/periodic").execute(*args, **kwargs) + def porous_jump(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/porous_jump").execute(*args, **kwargs) + def pressure_far_field(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/pressure_far_field").execute(*args, **kwargs) + def pressure_inlet(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/pressure_inlet").execute(*args, **kwargs) + def pressure_outlet(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/pressure_outlet").execute(*args, **kwargs) + def radiator(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/radiator").execute(*args, **kwargs) + def rans_les_interface(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/rans_les_interface").execute(*args, **kwargs) + def recirculation_inlet(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/recirculation_inlet").execute(*args, **kwargs) + def recirculation_outlet(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/recirculation_outlet").execute(*args, **kwargs) + def shadow(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/shadow").execute(*args, **kwargs) + def solid(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/solid").execute(*args, **kwargs) + def symmetry(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/symmetry").execute(*args, **kwargs) + def velocity_inlet(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/velocity_inlet").execute(*args, **kwargs) + def wall(self, *args, **kwargs): + """ + Set boundary conditions for a zone of this type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/wall").execute(*args, **kwargs) + def zone_name(self, *args, **kwargs): + """ + Give a zone a new name. + """ + return PyMenu(self.service, "/setup/boundary_conditions/zone_name").execute(*args, **kwargs) + def zone_type(self, *args, **kwargs): + """ + Set a zone's type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/zone_type").execute(*args, **kwargs) - class gen_nrbc_spec(metaclass=PyMenuMeta): + class bc_settings(TUIMenu): + """ + . + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.pressure_far_field = self.__class__.pressure_far_field(path + [("pressure_far_field", None)], service) + super().__init__(path, service) + def mass_flow(self, *args, **kwargs): """ + Select method for setting the mass flow rate. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class avg_press_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/bc_settings/mass_flow").execute(*args, **kwargs) + def pressure_outlet(self, *args, **kwargs): """ + Select pressure specification method on pressure-outlet boundaries. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/setup/boundary_conditions/bc_settings/pressure_outlet").execute(*args, **kwargs) - class avg_option(metaclass=PyMenuMeta): + class pressure_far_field(TUIMenu): """ + Select presure-far-field boundary-condition options. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def riemann_invariants_tangency_correction(self, *args, **kwargs): + """ + Apply a local correction where the flow is tangential to the boundary. + """ + return PyMenu(self.service, "/setup/boundary_conditions/bc_settings/pressure_far_field/riemann_invariants_tangency_correction").execute(*args, **kwargs) + def type(self, *args, **kwargs): + """ + Choose pressure-far-field boundary-condition type. + """ + return PyMenu(self.service, "/setup/boundary_conditions/bc_settings/pressure_far_field/type").execute(*args, **kwargs) - class targeted_mf_boundary(metaclass=PyMenuMeta): + class expert(TUIMenu): + """ + Enter expert bc menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.impedance_data_fitting = self.__class__.impedance_data_fitting(path + [("impedance_data_fitting", None)], service) + self.non_reflecting_bc = self.__class__.non_reflecting_bc(path + [("non_reflecting_bc", None)], service) + self.perforated_walls = self.__class__.perforated_walls(path + [("perforated_walls", None)], service) + self.periodic_conditions = self.__class__.periodic_conditions(path + [("periodic_conditions", None)], service) + super().__init__(path, service) + def non_overlapping_zone_name(self, *args, **kwargs): """ + Get non-overlapping zone name from the associated interface zone. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class targeted_mf(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/expert/non_overlapping_zone_name").execute(*args, **kwargs) + def openchannel_threads(self, *args, **kwargs): """ + List open channel group IDs, names, types, and variables. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class targeted_mf_pmax(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/expert/openchannel_threads").execute(*args, **kwargs) + def open_channel_wave_settings(self, *args, **kwargs): """ + Open channel wave input analysis. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class targeted_mf_pmin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/expert/open_channel_wave_settings").execute(*args, **kwargs) + def target_mass_flow_rate_settings(self, *args, **kwargs): """ + Enter the targeted mass flow rate setting menu. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/setup/boundary_conditions/expert/target_mass_flow_rate_settings").execute(*args, **kwargs) - class press_spec_gen(metaclass=PyMenuMeta): + class impedance_data_fitting(TUIMenu): """ + Enter the impedance data fitting menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def impedance_data(self, *args, **kwargs): + """ + Read experimental impedance data and output impedance parameters for a boundary condition. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/impedance_data_fitting/impedance_data").execute(*args, **kwargs) + def reflection_data(self, *args, **kwargs): + """ + Read experimental reflection coefficient data and output impedance parameters for a boundary condition. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/impedance_data_fitting/reflection_data").execute(*args, **kwargs) + def absorption_data(self, *args, **kwargs): + """ + Read experimental absorption coefficient data and output impedance parameters for a boundary condition. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/impedance_data_fitting/absorption_data").execute(*args, **kwargs) + def iterations(self, *args, **kwargs): + """ + Set the number of iterations for the fitting algorithm. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/impedance_data_fitting/iterations").execute(*args, **kwargs) + def convergence_tolerance(self, *args, **kwargs): + """ + Set the convergence tolerance for the fitting algorithm. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/impedance_data_fitting/convergence_tolerance").execute(*args, **kwargs) + def residue_tolerance(self, *args, **kwargs): + """ + Set the residue tolerance for the fitting algorithm. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/impedance_data_fitting/residue_tolerance").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Set verbosity level [0, 1] for fitting algorithm. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/impedance_data_fitting/verbosity").execute(*args, **kwargs) + def import_parameters(self, *args, **kwargs): + """ + Import impedance parameters into boundary condition. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/impedance_data_fitting/import_parameters").execute(*args, **kwargs) - class p_backflow_spec(metaclass=PyMenuMeta): + class non_reflecting_bc(TUIMenu): """ + Enter the non-reflecting b.c. menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + self.general_nrbc = self.__class__.general_nrbc(path + [("general_nrbc", None)], service) + self.turbo_specific_nrbc = self.__class__.turbo_specific_nrbc(path + [("turbo_specific_nrbc", None)], service) + super().__init__(path, service) - class p_backflow_spec_gen(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class general_nrbc(TUIMenu): + """ + Enter the menu for setting general non-reflecting boundary conditions. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) - class ac_options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class set(TUIMenu): + """ + Enter the general non-reflecting b.c. menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def sigma(self, *args, **kwargs): + """ + Set nrbc sigma factor (default value 0.15). + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/general_nrbc/set/sigma").execute(*args, **kwargs) + def sigma2(self, *args, **kwargs): + """ + Set nrbc sigma2 factor (default value 5.0). + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/general_nrbc/set/sigma2").execute(*args, **kwargs) + def relax(self, *args, **kwargs): + """ + Set NRBC relaxation factor (default value 0.5). + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/general_nrbc/set/relax").execute(*args, **kwargs) + def tangential_source(self, *args, **kwargs): + """ + Include or not NRBC tangential source (default value #t). + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/general_nrbc/set/tangential_source").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Print boundary equations convergence info. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/general_nrbc/set/verbosity").execute(*args, **kwargs) - class ac_wave(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class turbo_specific_nrbc(TUIMenu): + """ + Enter the turbo-specific n.r.b.c. menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) + def enable(self, *args, **kwargs): + """ + Enable/disable turbo-specific non-reflecting b.c.'s. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/turbo_specific_nrbc/enable").execute(*args, **kwargs) + def initialize(self, *args, **kwargs): + """ + Initialize turbo-specific non-reflecting b.c.'s. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/turbo_specific_nrbc/initialize").execute(*args, **kwargs) + def show_status(self, *args, **kwargs): + """ + Show current status of turbo-specific non-reflecting b.c.'s. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/turbo_specific_nrbc/show_status").execute(*args, **kwargs) - class impedance_0(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + class set(TUIMenu): + """ + Enter the set menu for turbo-specific non-reflecting b.c. parameters. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def discretization(self, *args, **kwargs): + """ + Enable use of higher-order reconstruction at boundaries if available. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/turbo_specific_nrbc/set/discretization").execute(*args, **kwargs) + def under_relaxation(self, *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. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/turbo_specific_nrbc/set/under_relaxation").execute(*args, **kwargs) + def verbosity(self, *args, **kwargs): + """ + Set turbo-specific non-reflecting b.c. verbosity level. + 0 : silent + 1 : basic info. default + 2 : detailed info. for debugging + . + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/non_reflecting_bc/turbo_specific_nrbc/set/verbosity").execute(*args, **kwargs) - class p(metaclass=PyMenuMeta): + class perforated_walls(TUIMenu): """ + Enter the perforated walls setting menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def read_input_file(self, *args, **kwargs): + """ + Read an input file. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/perforated_walls/read_input_file").execute(*args, **kwargs) + def model_setup(self, *args, **kwargs): + """ + Set up perforated walls. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/perforated_walls/model_setup").execute(*args, **kwargs) - class p_profile_multiplier(metaclass=PyMenuMeta): + class periodic_conditions(TUIMenu): """ + Enter the periodic conditions menu. """ - is_extended_tui = True def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) + def massflow_rate_specification(self, *args, **kwargs): + """ + Enable/disable specification of mass flow rate at the periodic boundary. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/periodic_conditions/massflow_rate_specification").execute(*args, **kwargs) + def pressure_gradient_specification(self, *args, **kwargs): + """ + Enable/disable specification of pressure gradient at the periodic boundary. + """ + return PyMenu(self.service, "/setup/boundary_conditions/expert/periodic_conditions/pressure_gradient_specification").execute(*args, **kwargs) - class direction_spec(metaclass=PyMenuMeta): + class modify_zones(TUIMenu): + """ + Enter the modify zones menu. + """ + def __init__(self, path, service): + self.path = path + self.service = service + super().__init__(path, service) + def activate_cell_zone(self, *args, **kwargs): """ + Activate a cell thread. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class frame_of_reference(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/activate_cell_zone").execute(*args, **kwargs) + def append_mesh(self, *args, **kwargs): """ + Append new mesh. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coordinate_system(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/append_mesh").execute(*args, **kwargs) + def append_mesh_data(self, *args, **kwargs): """ + Append new mesh with data. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ni(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/append_mesh_data").execute(*args, **kwargs) + def copy_move_cell_zone(self, *args, **kwargs): """ + Copy and translate or rotate a cell zone. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nj(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/copy_move_cell_zone").execute(*args, **kwargs) + def create_all_shell_threads(self, *args, **kwargs): """ + Mark all finite thickness wall for shell creation. Shell zones will be created at the start of iterations. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nk(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/create_all_shell_threads").execute(*args, **kwargs) + def deactivate_cell_zone(self, *args, **kwargs): """ + Deactivate cell thread. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ai(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/deactivate_cell_zone").execute(*args, **kwargs) + def recreate_all_shells(self, *args, **kwargs): """ + Create shell on all the walls where which were deleted using the command delete-all-shells. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class aj(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/recreate_all_shells").execute(*args, **kwargs) + def delete_all_shells(self, *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. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ak(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/delete_all_shells").execute(*args, **kwargs) + def delete_cell_zone(self, *args, **kwargs): """ + Delete a cell thread. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class x_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/delete_cell_zone").execute(*args, **kwargs) + def extrude_face_zone_delta(self, *args, **kwargs): """ + Extrude a face thread a specified distance based on a list of deltas. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class y_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/extrude_face_zone_delta").execute(*args, **kwargs) + def extrude_face_zone_para(self, *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). """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class z_origin(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/extrude_face_zone_para").execute(*args, **kwargs) + def fuse_face_zones(self, *args, **kwargs): """ + Attempt to fuse zones by removing duplicate faces and nodes. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ke_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/fuse_face_zones").execute(*args, **kwargs) + def list_zones(self, *args, **kwargs): """ + List zone IDs, types, kinds, and names. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nut(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/list_zones").execute(*args, **kwargs) + def make_periodic(self, *args, **kwargs): """ + Attempt to establish periodic/shadow face zone connectivity. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class kl(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/make_periodic").execute(*args, **kwargs) + def create_periodic_interface(self, *args, **kwargs): """ + Create a conformal or non-conformal periodic interface. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class intermit(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/create_periodic_interface").execute(*args, **kwargs) + def scale_zone(self, *args, **kwargs): """ + Scale nodal coordinates of input cell zones. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class k(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/scale_zone").execute(*args, **kwargs) + def rotate_zone(self, *args, **kwargs): """ + Rotate nodal coordinates of input cell zones. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class e(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/rotate_zone").execute(*args, **kwargs) + def translate_zone(self, *args, **kwargs): """ + Translate nodal coordinates of input cell zones. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class o(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/translate_zone").execute(*args, **kwargs) + def matching_tolerance(self, *args, **kwargs): """ + Set the normalized tolerance used for finding coincident nodes. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class v2(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/matching_tolerance").execute(*args, **kwargs) + def merge_zones(self, *args, **kwargs): """ + Merge zones of the same type and condition into one. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_intensity(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/merge_zones").execute(*args, **kwargs) + def mrf_to_sliding_mesh(self, *args, **kwargs): """ + Change motion specification from MRF to moving mesh. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_length_scale(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/mrf_to_sliding_mesh").execute(*args, **kwargs) + def convert_all_solid_mrf_to_solid_motion(self, *args, **kwargs): """ + Change all solid zones motion specification from MRF to solid motion. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_hydraulic_diam(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/convert_all_solid_mrf_to_solid_motion").execute(*args, **kwargs) + def orient_face_zone(self, *args, **kwargs): """ + Orient the face zone. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_viscosity_ratio(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/orient_face_zone").execute(*args, **kwargs) + def replace_zone(self, *args, **kwargs): """ + Replace a cell zone. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_viscosity_ratio_profile(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/replace_zone").execute(*args, **kwargs) + def sep_cell_zone_mark(self, *args, **kwargs): """ + Separate a cell zone based on cell marking. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class rst_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/sep_cell_zone_mark").execute(*args, **kwargs) + def sep_cell_zone_region(self, *args, **kwargs): """ + Separate a cell zone based on contiguous regions. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uu(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/sep_cell_zone_region").execute(*args, **kwargs) + def sep_face_zone_angle(self, *args, **kwargs): """ + Separate a face zone based on significant angle. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vv(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/sep_face_zone_angle").execute(*args, **kwargs) + def sep_face_zone_face(self, *args, **kwargs): """ + Separate each face in a zone into unique zone. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ww(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/sep_face_zone_face").execute(*args, **kwargs) + def sep_face_zone_mark(self, *args, **kwargs): """ + Separate a face zone based on cell marking. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uv(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/sep_face_zone_mark").execute(*args, **kwargs) + def sep_face_zone_region(self, *args, **kwargs): """ + Separate a face zone based on contiguous regions. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vw(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/sep_face_zone_region").execute(*args, **kwargs) + def slit_periodic(self, *args, **kwargs): """ + Slit a periodic zone into two symmetry zones. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uw(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/slit_periodic").execute(*args, **kwargs) + def slit_face_zone(self, *args, **kwargs): """ + Slit a two-sided wall into two connected wall zones. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ksgs_spec(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/slit_face_zone").execute(*args, **kwargs) + def slit_interior_between_diff_solids(self, *args, **kwargs): """ + Slit interior created between different solids into coupled walls. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ksgs(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/slit_interior_between_diff_solids").execute(*args, **kwargs) + def zone_name(self, *args, **kwargs): """ + Give a zone a new name. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sgs_turb_intensity(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/zone_name").execute(*args, **kwargs) + def zone_type(self, *args, **kwargs): """ + Set a zone's type. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wsf(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/zone_type").execute(*args, **kwargs) + def copy_mrf_to_mesh_motion(self, *args, **kwargs): """ + Copy motion variable values for origin, axis and velocities from Frame Motion to Mesh Motion. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wsb(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/copy_mrf_to_mesh_motion").execute(*args, **kwargs) + def copy_mesh_to_mrf_motion(self, *args, **kwargs): """ + Copy motion variable values for origin, axis and velocities from Mesh Motion to Frame Motion. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wsn(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/copy_mesh_to_mrf_motion").execute(*args, **kwargs) + def change_zone_state(self, *args, **kwargs): """ + Change the realgas material state for a zone. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class t0(metaclass=PyMenuMeta): + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/change_zone_state").execute(*args, **kwargs) + def change_zone_phase(self, *args, **kwargs): """ + Change the realgas phase for a zone. """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service + return PyMenu(self.service, "/setup/boundary_conditions/modify_zones/change_zone_phase").execute(*args, **kwargs) - class profiles(metaclass=PyMenuMeta): + class profiles(TUIMenu): """ Enter the boundary profiles menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def display_profile_surface(self, *args, **kwargs): """ Display a profile. @@ -43958,13 +34914,14 @@ def orient_profile(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/boundary_conditions/profiles/orient_profile").execute(*args, **kwargs) - class query(metaclass=PyMenuMeta): + class query(TUIMenu): """ Enter zone query menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def axis(self, *args, **kwargs): """ Show boundary conditions for a zone of this type. @@ -44151,13 +35108,14 @@ def wall(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/boundary_conditions/query/wall").execute(*args, **kwargs) - class rename_zone(metaclass=PyMenuMeta): + class rename_zone(TUIMenu): """ Enter zone rename menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def rename_by_adjacency(self, *args, **kwargs): """ Rename zone to adjacent zones. @@ -44174,13 +35132,14 @@ def add_suffix_or_prefix(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/boundary_conditions/rename_zone/add_suffix_or_prefix").execute(*args, **kwargs) - class set(metaclass=PyMenuMeta): + class set(TUIMenu): """ Enter the set boundary conditions menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def axis(self, *args, **kwargs): """ Set boundary conditions for a zone or multiple zones of this type. @@ -44337,742 +35296,7 @@ def wall(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/boundary_conditions/set/wall").execute(*args, **kwargs) - class symmetry(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class velocity_inlet(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - self.vmag = self.__class__.vmag(path + [("vmag", None)], service) - self.p_sup = self.__class__.p_sup(path + [("p_sup", None)], service) - self.velocity_spec = self.__class__.velocity_spec(path + [("velocity_spec", None)], service) - self.wave_velocity_spec = self.__class__.wave_velocity_spec(path + [("wave_velocity_spec", None)], service) - self.wave_vmag = self.__class__.wave_vmag(path + [("wave_vmag", None)], service) - self.wave_u = self.__class__.wave_u(path + [("wave_u", None)], service) - self.wave_v = self.__class__.wave_v(path + [("wave_v", None)], service) - self.wave_w = self.__class__.wave_w(path + [("wave_w", None)], service) - self.ocw_ship_vel_spec = self.__class__.ocw_ship_vel_spec(path + [("ocw_ship_vel_spec", None)], service) - self.ocw_ship_vmag = self.__class__.ocw_ship_vmag(path + [("ocw_ship_vmag", None)], service) - self.ocw_ship_ni = self.__class__.ocw_ship_ni(path + [("ocw_ship_ni", None)], service) - self.ocw_ship_nj = self.__class__.ocw_ship_nj(path + [("ocw_ship_nj", None)], service) - self.ocw_ship_nk = self.__class__.ocw_ship_nk(path + [("ocw_ship_nk", None)], service) - self.ocw_sp_vel_spec = self.__class__.ocw_sp_vel_spec(path + [("ocw_sp_vel_spec", None)], service) - self.ocw_sp_vmag = self.__class__.ocw_sp_vmag(path + [("ocw_sp_vmag", None)], service) - self.ocw_sp_ni = self.__class__.ocw_sp_ni(path + [("ocw_sp_ni", None)], service) - self.ocw_sp_nj = self.__class__.ocw_sp_nj(path + [("ocw_sp_nj", None)], service) - self.ocw_sp_nk = self.__class__.ocw_sp_nk(path + [("ocw_sp_nk", None)], service) - self.ocw_pp_vel_spec = self.__class__.ocw_pp_vel_spec(path + [("ocw_pp_vel_spec", None)], service) - self.ocw_pp_vmag = self.__class__.ocw_pp_vmag(path + [("ocw_pp_vmag", None)], service) - self.ocw_pp_vmag_ref = self.__class__.ocw_pp_vmag_ref(path + [("ocw_pp_vmag_ref", None)], service) - self.ocw_pp_ref_ht = self.__class__.ocw_pp_ref_ht(path + [("ocw_pp_ref_ht", None)], service) - self.ocw_pp_power_coeff = self.__class__.ocw_pp_power_coeff(path + [("ocw_pp_power_coeff", None)], service) - self.ocw_pp_ni = self.__class__.ocw_pp_ni(path + [("ocw_pp_ni", None)], service) - self.ocw_pp_nj = self.__class__.ocw_pp_nj(path + [("ocw_pp_nj", None)], service) - self.ocw_pp_nk = self.__class__.ocw_pp_nk(path + [("ocw_pp_nk", None)], service) - self.p = self.__class__.p(path + [("p", None)], service) - self.omega_swirl = self.__class__.omega_swirl(path + [("omega_swirl", None)], service) - self.turb_intensity = self.__class__.turb_intensity(path + [("turb_intensity", None)], service) - self.turb_length_scale = self.__class__.turb_length_scale(path + [("turb_length_scale", None)], service) - self.turb_hydraulic_diam = self.__class__.turb_hydraulic_diam(path + [("turb_hydraulic_diam", None)], service) - self.turb_viscosity_ratio = self.__class__.turb_viscosity_ratio(path + [("turb_viscosity_ratio", None)], service) - self.turb_viscosity_ratio_profile = self.__class__.turb_viscosity_ratio_profile(path + [("turb_viscosity_ratio_profile", None)], service) - self.frame_of_reference = self.__class__.frame_of_reference(path + [("frame_of_reference", None)], service) - self.coordinate_system = self.__class__.coordinate_system(path + [("coordinate_system", None)], service) - self.ni = self.__class__.ni(path + [("ni", None)], service) - self.nj = self.__class__.nj(path + [("nj", None)], service) - self.nk = self.__class__.nk(path + [("nk", None)], service) - self.u = self.__class__.u(path + [("u", None)], service) - self.v = self.__class__.v(path + [("v", None)], service) - self.w = self.__class__.w(path + [("w", None)], service) - self.ai = self.__class__.ai(path + [("ai", None)], service) - self.aj = self.__class__.aj(path + [("aj", None)], service) - self.ak = self.__class__.ak(path + [("ak", None)], service) - self.x_origin = self.__class__.x_origin(path + [("x_origin", None)], service) - self.y_origin = self.__class__.y_origin(path + [("y_origin", None)], service) - self.z_origin = self.__class__.z_origin(path + [("z_origin", None)], service) - self.vm_number_of_vortices = self.__class__.vm_number_of_vortices(path + [("vm_number_of_vortices", None)], service) - self.vm_streamwise_fluct = self.__class__.vm_streamwise_fluct(path + [("vm_streamwise_fluct", None)], service) - self.vm_mass_conservation = self.__class__.vm_mass_conservation(path + [("vm_mass_conservation", None)], service) - self.volumetric_synthetic_turbulence_generator = self.__class__.volumetric_synthetic_turbulence_generator(path + [("volumetric_synthetic_turbulence_generator", None)], service) - self.volumetric_synthetic_turbulence_generator_option = self.__class__.volumetric_synthetic_turbulence_generator_option(path + [("volumetric_synthetic_turbulence_generator_option", None)], service) - self.volumetric_synthetic_turbulence_generator_option_thickness = self.__class__.volumetric_synthetic_turbulence_generator_option_thickness(path + [("volumetric_synthetic_turbulence_generator_option_thickness", None)], service) - self.ke_spec = self.__class__.ke_spec(path + [("ke_spec", None)], service) - self.nut = self.__class__.nut(path + [("nut", None)], service) - self.kl = self.__class__.kl(path + [("kl", None)], service) - self.intermit = self.__class__.intermit(path + [("intermit", None)], service) - self.k = self.__class__.k(path + [("k", None)], service) - self.e = self.__class__.e(path + [("e", None)], service) - self.o = self.__class__.o(path + [("o", None)], service) - self.v2 = self.__class__.v2(path + [("v2", None)], service) - self.rst_spec = self.__class__.rst_spec(path + [("rst_spec", None)], service) - self.uu = self.__class__.uu(path + [("uu", None)], service) - self.vv = self.__class__.vv(path + [("vv", None)], service) - self.ww = self.__class__.ww(path + [("ww", None)], service) - self.uv = self.__class__.uv(path + [("uv", None)], service) - self.vw = self.__class__.vw(path + [("vw", None)], service) - self.uw = self.__class__.uw(path + [("uw", None)], service) - self.ksgs_spec = self.__class__.ksgs_spec(path + [("ksgs_spec", None)], service) - self.ksgs = self.__class__.ksgs(path + [("ksgs", None)], service) - self.sgs_turb_intensity = self.__class__.sgs_turb_intensity(path + [("sgs_turb_intensity", None)], service) - self.les_spec_name = self.__class__.les_spec_name(path + [("les_spec_name", None)], service) - self.granular_temperature = self.__class__.granular_temperature(path + [("granular_temperature", None)], service) - self.ac_options = self.__class__.ac_options(path + [("ac_options", None)], service) - self.ac_wave = self.__class__.ac_wave(path + [("ac_wave", None)], service) - self.impedance_0 = self.__class__.impedance_0(path + [("impedance_0", None)], service) - self.t = self.__class__.t(path + [("t", None)], service) - self.non_equil_boundary = self.__class__.non_equil_boundary(path + [("non_equil_boundary", None)], service) - self.tve = self.__class__.tve(path + [("tve", None)], service) - - class vmag(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class p_sup(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class velocity_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wave_velocity_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wave_vmag(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wave_u(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wave_v(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wave_w(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_ship_vel_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_ship_vmag(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_ship_ni(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_ship_nj(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_ship_nk(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_sp_vel_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_sp_vmag(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_sp_ni(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_sp_nj(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_sp_nk(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_pp_vel_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_pp_vmag(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_pp_vmag_ref(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_pp_ref_ht(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_pp_power_coeff(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_pp_ni(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_pp_nj(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ocw_pp_nk(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class p(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class omega_swirl(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_intensity(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_length_scale(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_hydraulic_diam(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_viscosity_ratio(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class turb_viscosity_ratio_profile(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class frame_of_reference(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class coordinate_system(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ni(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nj(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nk(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class u(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class v(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class w(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ai(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class aj(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ak(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class x_origin(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class y_origin(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class z_origin(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vm_number_of_vortices(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vm_streamwise_fluct(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vm_mass_conservation(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class volumetric_synthetic_turbulence_generator(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class volumetric_synthetic_turbulence_generator_option(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class volumetric_synthetic_turbulence_generator_option_thickness(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ke_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class nut(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class kl(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class intermit(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class k(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class e(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class o(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class v2(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class rst_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uu(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vv(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ww(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uv(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class vw(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class uw(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ksgs_spec(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ksgs(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class sgs_turb_intensity(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class les_spec_name(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class granular_temperature(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ac_options(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class ac_wave(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class impedance_0(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class t(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class non_equil_boundary(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class tve(metaclass=PyMenuMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class wall(metaclass=PyNamedObjectMeta): - """ - """ - is_extended_tui = True - def __init__(self, path, service): - self.path = path - self.service = service - - class dynamic_mesh(metaclass=PyMenuMeta): + class dynamic_mesh(TUIMenu): """ Enter the dynamic mesh menu. """ @@ -45084,13 +35308,14 @@ def __init__(self, path, service): self.zones = self.__class__.zones(path + [("zones", None)], service) self.actions = self.__class__.actions(path + [("actions", None)], service) self.transient_settings = self.__class__.transient_settings(path + [("transient_settings", None)], service) + super().__init__(path, service) def dynamic_mesh(self, *args, **kwargs): """ Enable/disable the dynamic mesh solver and options. """ return PyMenu(self.service, "/setup/dynamic_mesh/dynamic_mesh").execute(*args, **kwargs) - class controls(metaclass=PyMenuMeta): + class controls(TUIMenu): """ Enter the dynamic mesh control menu. """ @@ -45105,6 +35330,7 @@ def __init__(self, path, service): self.six_dof_parameters = self.__class__.six_dof_parameters(path + [("six_dof_parameters", None)], service) self.periodic_displacement_parameters = self.__class__.periodic_displacement_parameters(path + [("periodic_displacement_parameters", None)], service) self.contact_parameters = self.__class__.contact_parameters(path + [("contact_parameters", None)], service) + super().__init__(path, service) def in_cylinder_output(self, *args, **kwargs): """ Enable/disable in-cylinder output. @@ -45131,13 +35357,14 @@ def steady_pseudo_time_control(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/dynamic_mesh/controls/steady_pseudo_time_control").execute(*args, **kwargs) - class smoothing_parameters(metaclass=PyMenuMeta): + class smoothing_parameters(TUIMenu): """ Enter the dynamic mesh smoothing menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def smoothing_method(self, *args, **kwargs): """ Specify the smoothing method used by the dynamic mesh model. @@ -45255,13 +35482,14 @@ def boundary_distance_method(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/dynamic_mesh/controls/smoothing_parameters/boundary_distance_method").execute(*args, **kwargs) - class layering_parameters(metaclass=PyMenuMeta): + class layering_parameters(TUIMenu): """ Enter the dynamic mesh layering menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def split_factor(self, *args, **kwargs): """ Set the factor determining when to split dynamic layers. @@ -45278,7 +35506,7 @@ def constant_height(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/dynamic_mesh/controls/layering_parameters/constant_height").execute(*args, **kwargs) - class remeshing_parameters(metaclass=PyMenuMeta): + class remeshing_parameters(TUIMenu): """ Enter the dynamic mesh remeshing menu. """ @@ -45288,6 +35516,7 @@ def __init__(self, path, service): self.prism_controls = self.__class__.prism_controls(path + [("prism_controls", None)], service) self.sizing_controls = self.__class__.sizing_controls(path + [("sizing_controls", None)], service) self.prism_layer_parameters = self.__class__.prism_layer_parameters(path + [("prism_layer_parameters", None)], service) + super().__init__(path, service) def unified_remeshing(self, *args, **kwargs): """ Enable/disable unified remeshing. @@ -45375,13 +35604,14 @@ def remeshing_after_moving(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/dynamic_mesh/controls/remeshing_parameters/remeshing_after_moving").execute(*args, **kwargs) - class prism_controls(metaclass=PyMenuMeta): + class prism_controls(TUIMenu): """ Specify optional prism controls. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def add(self, *args, **kwargs): """ Add a new object. @@ -45408,13 +35638,14 @@ def list_properties(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/dynamic_mesh/controls/remeshing_parameters/prism_controls/list_properties").execute(*args, **kwargs) - class sizing_controls(metaclass=PyMenuMeta): + class sizing_controls(TUIMenu): """ Specify optional sizing controls. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def add(self, *args, **kwargs): """ Add a new object. @@ -45441,13 +35672,14 @@ def list_properties(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/dynamic_mesh/controls/remeshing_parameters/sizing_controls/list_properties").execute(*args, **kwargs) - class prism_layer_parameters(metaclass=PyMenuMeta): + class prism_layer_parameters(TUIMenu): """ Enter the dynamic mesh prism remeshing menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def first_height(self, *args, **kwargs): """ Set first cell height in the prism layer. @@ -45464,13 +35696,14 @@ def number_of_layers(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/dynamic_mesh/controls/remeshing_parameters/prism_layer_parameters/number_of_layers").execute(*args, **kwargs) - class in_cylinder_parameters(metaclass=PyMenuMeta): + class in_cylinder_parameters(TUIMenu): """ Enter the dynamic mesh in-cylinder menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def starting_crank_angle(self, *args, **kwargs): """ Specify the starting crank angle. @@ -45522,13 +35755,14 @@ def position_starting_mesh(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/dynamic_mesh/controls/in_cylinder_parameters/position_starting_mesh").execute(*args, **kwargs) - class implicit_update_parameters(metaclass=PyMenuMeta): + class implicit_update_parameters(TUIMenu): """ Enter the dynamic mesh implicit update menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def update_interval(self, *args, **kwargs): """ Specify update interval of implicit update. @@ -45545,13 +35779,14 @@ def residual_criteria(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/dynamic_mesh/controls/implicit_update_parameters/residual_criteria").execute(*args, **kwargs) - class six_dof_parameters(metaclass=PyMenuMeta): + class six_dof_parameters(TUIMenu): """ Enter the dynamic mesh six-dof menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def create_properties(self, *args, **kwargs): """ Create a set of Six DOF Properties. @@ -45598,13 +35833,14 @@ def motion_history_file_name(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/dynamic_mesh/controls/six_dof_parameters/motion_history_file_name").execute(*args, **kwargs) - class periodic_displacement_parameters(metaclass=PyMenuMeta): + class periodic_displacement_parameters(TUIMenu): """ Enter the dynamic mesh periodic displacement menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def list_displacements(self, *args, **kwargs): """ List Periodic Displacements. @@ -45666,7 +35902,7 @@ def set_active_displacement(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/dynamic_mesh/controls/periodic_displacement_parameters/set_active_displacement").execute(*args, **kwargs) - class contact_parameters(metaclass=PyMenuMeta): + class contact_parameters(TUIMenu): """ Enter the dynamic mesh contact detection menu. """ @@ -45674,6 +35910,7 @@ def __init__(self, path, service): self.path = path self.service = service self.flow_control_parameters = self.__class__.flow_control_parameters(path + [("flow_control_parameters", None)], service) + super().__init__(path, service) def contact_face_zones(self, *args, **kwargs): """ Select face zones involved in contact detection. @@ -45715,13 +35952,14 @@ def verbosity(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/dynamic_mesh/controls/contact_parameters/verbosity").execute(*args, **kwargs) - class flow_control_parameters(metaclass=PyMenuMeta): + class flow_control_parameters(TUIMenu): """ Enter the flow control menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def solution_stabilization(self, *args, **kwargs): """ Enable/disable the performance of additional iterations per time step and @@ -45739,13 +35977,14 @@ def delete_flow_control_zone(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/dynamic_mesh/controls/contact_parameters/flow_control_parameters/delete_flow_control_zone").execute(*args, **kwargs) - class events(metaclass=PyMenuMeta): + class events(TUIMenu): """ Enter the dynamic mesh events menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def import_event_file(self, *args, **kwargs): """ Import dynamic mesh event file. @@ -45757,13 +35996,14 @@ def export_event_file(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/dynamic_mesh/events/export_event_file").execute(*args, **kwargs) - class zones(metaclass=PyMenuMeta): + class zones(TUIMenu): """ Enter the dynamic mesh zones menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def create(self, *args, **kwargs): """ Create dynamic zone. @@ -45800,26 +36040,28 @@ def remove_interior_layer(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/dynamic_mesh/zones/remove_interior_layer").execute(*args, **kwargs) - class actions(metaclass=PyMenuMeta): + class actions(TUIMenu): """ Enter the dynamic mesh actions menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def remesh_cell_zone(self, *args, **kwargs): """ Manually remesh cell zone with option to remesh adjacent dynamic face zones. """ return PyMenu(self.service, "/setup/dynamic_mesh/actions/remesh_cell_zone").execute(*args, **kwargs) - class transient_settings(metaclass=PyMenuMeta): + class transient_settings(TUIMenu): """ Enter the dynamic mesh transient settings menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def verbosity(self, *args, **kwargs): """ Enable/disable transient scheme verbosity for dynamic mesh cases. @@ -45831,7 +36073,7 @@ def allow_second_order(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/dynamic_mesh/transient_settings/allow_second_order").execute(*args, **kwargs) - class expert(metaclass=PyMenuMeta): + class expert(TUIMenu): """ Enter expert setup menu. """ @@ -45839,6 +36081,7 @@ def __init__(self, path, service): self.path = path self.service = service self.spectral = self.__class__.spectral(path + [("spectral", None)], service) + super().__init__(path, service) def beta_feature_access(self, *args, **kwargs): """ Enable access to beta features in the interface. @@ -45860,13 +36103,14 @@ def stiff_chemistry(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/expert/stiff_chemistry").execute(*args, **kwargs) - class spectral(metaclass=PyMenuMeta): + class spectral(TUIMenu): """ Enter the Spectral menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def calculate_fourier_coefficients(self, *args, **kwargs): """ Calculates Fourier coefficient data. @@ -45888,7 +36132,7 @@ def delete_harmonic_exports(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/expert/spectral/delete_harmonic_exports").execute(*args, **kwargs) - class gap_model(metaclass=PyMenuMeta): + class gap_model(TUIMenu): """ Enter the narrow-gaps menu. """ @@ -45896,6 +36140,7 @@ def __init__(self, path, service): self.path = path self.service = service self.advanced_options = self.__class__.advanced_options(path + [("advanced_options", None)], service) + super().__init__(path, service) def enable(self, *args, **kwargs): """ Enable/Disable gap model. @@ -45942,13 +36187,14 @@ def render_gap_regions(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/gap_model/render_gap_regions").execute(*args, **kwargs) - class advanced_options(metaclass=PyMenuMeta): + class advanced_options(TUIMenu): """ Show options. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def expert(self, *args, **kwargs): """ Enable expert options for gap model. @@ -46045,7 +36291,7 @@ def render_gap_interface(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/gap_model/advanced_options/render_gap_interface").execute(*args, **kwargs) - class materials(metaclass=PyMenuMeta): + class materials(TUIMenu): """ Enter the materials menu. """ @@ -46053,6 +36299,7 @@ def __init__(self, path, service): self.path = path self.service = service self.data_base = self.__class__.data_base(path + [("data_base", None)], service) + super().__init__(path, service) def change_create(self, *args, **kwargs): """ Change the properties of a locally-stored material or create a new material. @@ -46084,13 +36331,14 @@ def list_properties(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/materials/list_properties").execute(*args, **kwargs) - class data_base(metaclass=PyMenuMeta): + class data_base(TUIMenu): """ Enter the database menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def database_type(self, *args, **kwargs): """ Set the database type. @@ -46122,7 +36370,7 @@ def save(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/materials/data_base/save").execute(*args, **kwargs) - class mesh_interfaces(metaclass=PyMenuMeta): + class mesh_interfaces(TUIMenu): """ Enter the mesh-interfaces menu. """ @@ -46132,6 +36380,7 @@ def __init__(self, path, service): self.non_conformal_interface_numerics = self.__class__.non_conformal_interface_numerics(path + [("non_conformal_interface_numerics", None)], service) self.mapped_interface_options = self.__class__.mapped_interface_options(path + [("mapped_interface_options", None)], service) self.auto_options = self.__class__.auto_options(path + [("auto_options", None)], service) + super().__init__(path, service) def create(self, *args, **kwargs): """ Create a mesh interface. @@ -46238,26 +36487,28 @@ def remove_left_handed_interface_faces(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/mesh_interfaces/remove_left_handed_interface_faces").execute(*args, **kwargs) - class non_conformal_interface_numerics(metaclass=PyMenuMeta): + class non_conformal_interface_numerics(TUIMenu): """ Setting non-conformal numerics options. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def change_numerics(self, *args, **kwargs): """ Enable modified non-conformal interface numerics. """ return PyMenu(self.service, "/setup/mesh_interfaces/non_conformal_interface_numerics/change_numerics").execute(*args, **kwargs) - class mapped_interface_options(metaclass=PyMenuMeta): + class mapped_interface_options(TUIMenu): """ Enter the mapped-interface-options menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def solution_controls(self, *args, **kwargs): """ Specification of mapped frequency and under-relaxation factor for mapped interfaces. @@ -46274,13 +36525,14 @@ def convert_to_mapped_interface(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/mesh_interfaces/mapped_interface_options/convert_to_mapped_interface").execute(*args, **kwargs) - class auto_options(metaclass=PyMenuMeta): + class auto_options(TUIMenu): """ Enter auto-options menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def proximity_tolerance(self, *args, **kwargs): """ Specification of auto pairing tolerance. @@ -46317,7 +36569,7 @@ def keep_empty_interface(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/mesh_interfaces/auto_options/keep_empty_interface").execute(*args, **kwargs) - class mixing_planes(metaclass=PyMenuMeta): + class mixing_planes(TUIMenu): """ Enter the mixing planes menu. """ @@ -46325,6 +36577,7 @@ def __init__(self, path, service): self.path = path self.service = service self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) def create(self, *args, **kwargs): """ Create a mixing plane. @@ -46341,7 +36594,7 @@ def list(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/mixing_planes/list").execute(*args, **kwargs) - class set(metaclass=PyMenuMeta): + class set(TUIMenu): """ Enter the mixing plane set menu. """ @@ -46350,6 +36603,7 @@ def __init__(self, path, service): self.service = service self.conserve_swirl = self.__class__.conserve_swirl(path + [("conserve_swirl", None)], service) self.conserve_total_enthalpy = self.__class__.conserve_total_enthalpy(path + [("conserve_total_enthalpy", None)], service) + super().__init__(path, service) def under_relaxation(self, *args, **kwargs): """ Set mixing plane under-relaxation factor. @@ -46366,13 +36620,14 @@ def fix_pressure_level(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/mixing_planes/set/fix_pressure_level").execute(*args, **kwargs) - class conserve_swirl(metaclass=PyMenuMeta): + class conserve_swirl(TUIMenu): """ Enter the mixing plane conserve-swirl menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def enable(self, *args, **kwargs): """ Enable/disable swirl conservation in mixing plane. @@ -46389,13 +36644,14 @@ def report_swirl_integration(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/mixing_planes/set/conserve_swirl/report_swirl_integration").execute(*args, **kwargs) - class conserve_total_enthalpy(metaclass=PyMenuMeta): + class conserve_total_enthalpy(TUIMenu): """ Enter the menu to set total enthalpy conservation in mixing plane menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def enable(self, *args, **kwargs): """ Enable/disable total enthalpy conservation in mixing plane. @@ -46407,7 +36663,7 @@ def verbosity(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/mixing_planes/set/conserve_total_enthalpy/verbosity").execute(*args, **kwargs) - class models(metaclass=PyMenuMeta): + class models(TUIMenu): """ Enter the models menu to configure the solver. """ @@ -46432,6 +36688,7 @@ def __init__(self, path, service): self.structure = self.__class__.structure(path + [("structure", None)], service) self.heat_exchanger = self.__class__.heat_exchanger(path + [("heat_exchanger", None)], service) self.electrolysis_setup = self.__class__.electrolysis_setup(path + [("electrolysis_setup", None)], service) + super().__init__(path, service) def addon_module(self, *args, **kwargs): """ Load addon module. @@ -46538,7 +36795,7 @@ def potential_and_li_ion_battery(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/potential_and_li_ion_battery").execute(*args, **kwargs) - class acoustics(metaclass=PyMenuMeta): + class acoustics(TUIMenu): """ Enter the acoustics model menu. """ @@ -46549,6 +36806,7 @@ def __init__(self, path, service): self.wave_equation_options = self.__class__.wave_equation_options(path + [("wave_equation_options", None)], service) self.sources_fft = self.__class__.sources_fft(path + [("sources_fft", None)], service) self.sponge_layers = self.__class__.sponge_layers(path + [("sponge_layers", None)], service) + super().__init__(path, service) def off(self, *args, **kwargs): """ Enable/disable the acoustics model. @@ -46660,13 +36918,14 @@ def display_frequencies(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/acoustics/display_frequencies").execute(*args, **kwargs) - class far_field_parameters(metaclass=PyMenuMeta): + class far_field_parameters(TUIMenu): """ Enter the far field parameters menu for the wave equation model. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def far_field_density(self, *args, **kwargs): """ Specify far field density. @@ -46678,7 +36937,7 @@ def far_field_sound_speed(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/acoustics/far_field_parameters/far_field_sound_speed").execute(*args, **kwargs) - class wave_equation_options(metaclass=PyMenuMeta): + class wave_equation_options(TUIMenu): """ Enter the options menu for the wave equation model. """ @@ -46687,6 +36946,7 @@ def __init__(self, path, service): self.service = service self.basic_shapes = self.__class__.basic_shapes(path + [("basic_shapes", None)], service) self.remote_receivers_options = self.__class__.remote_receivers_options(path + [("remote_receivers_options", None)], service) + super().__init__(path, service) def time_filter_source(self, *args, **kwargs): """ Activate time-filtering of sound sources. @@ -46718,7 +36978,7 @@ def remote_receivers(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/acoustics/wave_equation_options/remote_receivers").execute(*args, **kwargs) - class basic_shapes(metaclass=PyMenuMeta): + class basic_shapes(TUIMenu): """ Enter the basic shapes menu to build source mask and sponge layer geometry shapes using cell registers. @@ -46726,6 +36986,7 @@ class basic_shapes(metaclass=PyMenuMeta): def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def list_region_registers(self, *args, **kwargs): """ List all available region registers (hex/cylinder/sphere). @@ -46762,13 +37023,14 @@ def remove_sponge_layer_shape(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/acoustics/wave_equation_options/basic_shapes/remove_sponge_layer_shape").execute(*args, **kwargs) - class remote_receivers_options(metaclass=PyMenuMeta): + class remote_receivers_options(TUIMenu): """ Enter the menu to set up the Kirchhoff's integral method and output its results. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def integration_surface(self, *args, **kwargs): """ Select Kirchhoff's integration surface. @@ -46780,7 +37042,7 @@ def write_signals(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/acoustics/wave_equation_options/remote_receivers_options/write_signals").execute(*args, **kwargs) - class sources_fft(metaclass=PyMenuMeta): + class sources_fft(TUIMenu): """ Enter the acoustic sources FFT menu. """ @@ -46788,6 +37050,7 @@ def __init__(self, path, service): self.path = path self.service = service self.fft_surface_variables = self.__class__.fft_surface_variables(path + [("fft_surface_variables", None)], service) + super().__init__(path, service) def read_asd_files(self, *args, **kwargs): """ Read ASD files. @@ -46809,13 +37072,14 @@ def clean_up_storage_area(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/acoustics/sources_fft/clean_up_storage_area").execute(*args, **kwargs) - class fft_surface_variables(metaclass=PyMenuMeta): + class fft_surface_variables(TUIMenu): """ Enter the FFT surface variables menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def create_octave_bands(self, *args, **kwargs): """ Create octave bands. @@ -46842,13 +37106,14 @@ def remove_variables(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/acoustics/sources_fft/fft_surface_variables/remove_variables").execute(*args, **kwargs) - class sponge_layers(metaclass=PyMenuMeta): + class sponge_layers(TUIMenu): """ Manage sponge layers where density is blended to eliminate reflections from boundary zones. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def activate(self, *args, **kwargs): """ Activate a sponge object. @@ -46890,7 +37155,7 @@ def list_properties(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/acoustics/sponge_layers/list_properties").execute(*args, **kwargs) - class optics(metaclass=PyMenuMeta): + class optics(TUIMenu): """ Enter the optics model menu. """ @@ -46898,6 +37163,7 @@ def __init__(self, path, service): self.path = path self.service = service self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) def enable(self, *args, **kwargs): """ Enable/disable optics model. @@ -46909,13 +37175,14 @@ def add_beam(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/optics/add_beam").execute(*args, **kwargs) - class set(metaclass=PyMenuMeta): + class set(TUIMenu): """ Enter the set menu for optics model. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def sampling(self, *args, **kwargs): """ Specify when the fluid density field is sampled. @@ -46932,7 +37199,7 @@ def running_average(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/optics/set/running_average").execute(*args, **kwargs) - class eulerian_wallfilm(metaclass=PyMenuMeta): + class eulerian_wallfilm(TUIMenu): """ Enter the Eulerian wall film model menu. """ @@ -46941,6 +37208,7 @@ def __init__(self, path, service): self.service = service self.coupled_solution = self.__class__.coupled_solution(path + [("coupled_solution", None)], service) self.implicit_options = self.__class__.implicit_options(path + [("implicit_options", None)], service) + super().__init__(path, service) def enable_wallfilm_model(self, *args, **kwargs): """ Enable Eulerian wall film model. @@ -46972,13 +37240,14 @@ def solution_options(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/eulerian_wallfilm/solution_options").execute(*args, **kwargs) - class coupled_solution(metaclass=PyMenuMeta): + class coupled_solution(TUIMenu): """ Enter Eulerian wall film coupled solution menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def enable_coupled_solution(self, *args, **kwargs): """ Enable Eulerian wall film coupled solution. @@ -46990,13 +37259,14 @@ def enable_curvature_smoothing(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/eulerian_wallfilm/coupled_solution/enable_curvature_smoothing").execute(*args, **kwargs) - class implicit_options(metaclass=PyMenuMeta): + class implicit_options(TUIMenu): """ Enter Implicit Scheme Option (beta). """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def new_implicit_scheme(self, *args, **kwargs): """ Enable alternative implicit scheme. @@ -47008,7 +37278,7 @@ def relative_error_residual(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/eulerian_wallfilm/implicit_options/relative_error_residual").execute(*args, **kwargs) - class dpm(metaclass=PyMenuMeta): + class dpm(TUIMenu): """ Enter the dispersed phase model menu. """ @@ -47023,6 +37293,7 @@ def __init__(self, path, service): self.parallel = self.__class__.parallel(path + [("parallel", None)], service) self.splash_options = self.__class__.splash_options(path + [("splash_options", None)], service) self.stripping_options = self.__class__.stripping_options(path + [("stripping_options", None)], service) + super().__init__(path, service) def clear_particles_from_domain(self, *args, **kwargs): """ Remove/keep all particles currently in the domain. @@ -47054,7 +37325,7 @@ def user_defined(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/dpm/user_defined").execute(*args, **kwargs) - class collisions(metaclass=PyMenuMeta): + class collisions(TUIMenu): """ Enter the DEM collisions menu. """ @@ -47062,6 +37333,7 @@ def __init__(self, path, service): self.path = path self.service = service self.collision_partners = self.__class__.collision_partners(path + [("collision_partners", None)], service) + super().__init__(path, service) def collision_pair_settings(self, *args, **kwargs): """ Supply settings for collisions to a pair of collision partners. @@ -47088,13 +37360,14 @@ def max_particle_velocity(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/dpm/collisions/max_particle_velocity").execute(*args, **kwargs) - class collision_partners(metaclass=PyMenuMeta): + class collision_partners(TUIMenu): """ Manage collision partners. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def create(self, *args, **kwargs): """ Create a collision partner. @@ -47121,7 +37394,7 @@ def list(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/dpm/collisions/collision_partners/list").execute(*args, **kwargs) - class erosion_dynamic_mesh(metaclass=PyMenuMeta): + class erosion_dynamic_mesh(TUIMenu): """ Enter the erosion-dynamic mesh interactions menu. """ @@ -47130,6 +37403,7 @@ def __init__(self, path, service): self.service = service self.general_parameters = self.__class__.general_parameters(path + [("general_parameters", None)], service) self.run_parameters = self.__class__.run_parameters(path + [("run_parameters", None)], service) + super().__init__(path, service) def enable_erosion_dynamic_mesh_coupling(self, *args, **kwargs): """ Enable mesh deformation due to wall erosion. @@ -47141,13 +37415,14 @@ def run_simulation(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/dpm/erosion_dynamic_mesh/run_simulation").execute(*args, **kwargs) - class general_parameters(metaclass=PyMenuMeta): + class general_parameters(TUIMenu): """ Enter the erosion-dynamic mesh setup menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def erosion_settings(self, *args, **kwargs): """ Set erosion modelling specific settings. @@ -47164,13 +37439,14 @@ def participating_walls(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/dpm/erosion_dynamic_mesh/general_parameters/participating_walls").execute(*args, **kwargs) - class run_parameters(metaclass=PyMenuMeta): + class run_parameters(TUIMenu): """ Enter the erosion-dynamic mesh run menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def mesh_motion_time_step(self, *args, **kwargs): """ Set the mesh motion time stepping parameters and method. @@ -47197,13 +37473,14 @@ def autosave_graphics(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/dpm/erosion_dynamic_mesh/run_parameters/autosave_graphics").execute(*args, **kwargs) - class interaction(metaclass=PyMenuMeta): + class interaction(TUIMenu): """ Enter the interaction menu to set parameters for coupled discrete phase calculations. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def choice_of_eulerian_phase_for_interaction(self, *args, **kwargs): """ Enable/disable the option to choose for every injection the Eulerian phase for the DPM continuous phase interaction. @@ -47313,7 +37590,7 @@ def ddpm_iad_particle(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/dpm/interaction/ddpm_iad_particle").execute(*args, **kwargs) - class numerics(metaclass=PyMenuMeta): + class numerics(TUIMenu): """ Enter the numerics menu to set numerical solution parameters. """ @@ -47321,6 +37598,7 @@ def __init__(self, path, service): self.path = path self.service = service self.high_resolution_tracking = self.__class__.high_resolution_tracking(path + [("high_resolution_tracking", None)], service) + super().__init__(path, service) def coupled_heat_mass_update(self, *args, **kwargs): """ Enable/disable coupled heat and mass update. @@ -47417,7 +37695,7 @@ def enhanced_packing_limit_numerics(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/dpm/numerics/enhanced_packing_limit_numerics").execute(*args, **kwargs) - class high_resolution_tracking(metaclass=PyMenuMeta): + class high_resolution_tracking(TUIMenu): """ Enter the high resolution tracking menu. """ @@ -47426,6 +37704,7 @@ def __init__(self, path, service): self.service = service self.barycentric_interpolation = self.__class__.barycentric_interpolation(path + [("barycentric_interpolation", None)], service) self.particle_relocation = self.__class__.particle_relocation(path + [("particle_relocation", None)], service) + super().__init__(path, service) def enable_high_resolution_tracking(self, *args, **kwargs): """ Enable high resolution tracking. @@ -47497,13 +37776,14 @@ def set_subtet_intersection_tolerance(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/dpm/numerics/high_resolution_tracking/set_subtet_intersection_tolerance").execute(*args, **kwargs) - class barycentric_interpolation(metaclass=PyMenuMeta): + class barycentric_interpolation(TUIMenu): """ Enter the barycentric interpolation menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def interpolate_flow_solution_gradients(self, *args, **kwargs): """ Enable interpolation of flow solution gradients. @@ -47560,13 +37840,14 @@ def user_interpolation_function(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/dpm/numerics/high_resolution_tracking/barycentric_interpolation/user_interpolation_function").execute(*args, **kwargs) - class particle_relocation(metaclass=PyMenuMeta): + class particle_relocation(TUIMenu): """ Enter the particle relocation menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def wallfilm_relocation_tolerance_scale_factor(self, *args, **kwargs): """ Set the relocation tolerance scaling factor for wallfilm particles after remeshing. @@ -47598,13 +37879,14 @@ def enhanced_wallfilm_location_method(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/dpm/numerics/high_resolution_tracking/particle_relocation/enhanced_wallfilm_location_method").execute(*args, **kwargs) - class options(metaclass=PyMenuMeta): + class options(TUIMenu): """ Enter the options menu to set optional DPM models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def enable_contour_plots(self, *args, **kwargs): """ Enable contour and vector plots of particle data. @@ -47766,7 +38048,7 @@ def scr_urea_deposition_risk_analysis(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/dpm/options/scr_urea_deposition_risk_analysis").execute(*args, **kwargs) - class parallel(metaclass=PyMenuMeta): + class parallel(TUIMenu): """ Enter the parallel menu. """ @@ -47774,6 +38056,7 @@ def __init__(self, path, service): self.path = path self.service = service self.expert = self.__class__.expert(path + [("expert", None)], service) + super().__init__(path, service) def enable_workpile(self, *args, **kwargs): """ Enable/disable the particle workpile algorithm. @@ -47837,26 +38120,28 @@ def hybrid_collision_variant(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/dpm/parallel/hybrid_collision_variant").execute(*args, **kwargs) - class expert(metaclass=PyMenuMeta): + class expert(TUIMenu): """ Enter the menu to set expert DPM parallel options. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def partition_method_hybrid_2domain(self, *args, **kwargs): """ Set DPM Domain partition method. """ return PyMenu(self.service, "/setup/models/dpm/parallel/expert/partition_method_hybrid_2domain").execute(*args, **kwargs) - class splash_options(metaclass=PyMenuMeta): + class splash_options(TUIMenu): """ Enter the splash options menu to set optional parameters. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def orourke_splash_fraction(self, *args, **kwargs): """ Select splash fraction method. @@ -47868,13 +38153,14 @@ def splash_pdf_limiting(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/dpm/splash_options/splash_pdf_limiting").execute(*args, **kwargs) - class stripping_options(metaclass=PyMenuMeta): + class stripping_options(TUIMenu): """ Enter the stripping options menu to set optional parameters. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def mass_coefficient(self, *args, **kwargs): """ Set the stripping mass coefficient. @@ -47886,13 +38172,14 @@ def diameter_coefficient(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/dpm/stripping_options/diameter_coefficient").execute(*args, **kwargs) - class shell_conduction(metaclass=PyMenuMeta): + class shell_conduction(TUIMenu): """ Enter the shell conduction model menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def multi_layer_shell(self, *args, **kwargs): """ Enable/disable multi layer shell conduction model. @@ -47924,7 +38211,7 @@ def save_shell_zones(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/shell_conduction/save_shell_zones").execute(*args, **kwargs) - class system_coupling_settings(metaclass=PyMenuMeta): + class system_coupling_settings(TUIMenu): """ Enter the system coupling model menu. """ @@ -47932,6 +38219,7 @@ def __init__(self, path, service): self.path = path self.service = service self.htc = self.__class__.htc(path + [("htc", None)], service) + super().__init__(path, service) def use_face_or_element_based_data_transfer(self, *args, **kwargs): """ Enable/disable face based data transfer. @@ -47948,7 +38236,7 @@ def specify_system_coupling_volumetric_cell_zones(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/system_coupling_settings/specify_system_coupling_volumetric_cell_zones").execute(*args, **kwargs) - class htc(metaclass=PyMenuMeta): + class htc(TUIMenu): """ Enter the heat transfer coeficient menu. """ @@ -47957,27 +38245,30 @@ def __init__(self, path, service): self.service = service self.unsteady_statistics = self.__class__.unsteady_statistics(path + [("unsteady_statistics", None)], service) self.htc_calculation_method = self.__class__.htc_calculation_method(path + [("htc_calculation_method", None)], service) + super().__init__(path, service) - class unsteady_statistics(metaclass=PyMenuMeta): + class unsteady_statistics(TUIMenu): """ Enter the unsteady statistics menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def sc_enable_sub_stepping_option_per_coupling_step(self, *args, **kwargs): """ Enable/disable sub stepping option per coupling step. """ return PyMenu(self.service, "/setup/models/system_coupling_settings/htc/unsteady_statistics/sc_enable_sub_stepping_option_per_coupling_step").execute(*args, **kwargs) - class htc_calculation_method(metaclass=PyMenuMeta): + class htc_calculation_method(TUIMenu): """ Enter the htc calculation menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def use_tref_in_htc_calculation(self, *args, **kwargs): """ Enable/disable tref in htc computation. @@ -47994,7 +38285,7 @@ def use_wall_function_based_htc(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/system_coupling_settings/htc/htc_calculation_method/use_wall_function_based_htc").execute(*args, **kwargs) - class cht(metaclass=PyMenuMeta): + class cht(TUIMenu): """ Enter the mapped interface model menu. """ @@ -48002,6 +38293,7 @@ def __init__(self, path, service): self.path = path self.service = service self.explicit_time_averaged_coupling = self.__class__.explicit_time_averaged_coupling(path + [("explicit_time_averaged_coupling", None)], service) + super().__init__(path, service) def read_mi_type_wall(self, *args, **kwargs): """ Read mapped interface data settings from a csv file. @@ -48018,13 +38310,14 @@ def implicit_coupling(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/cht/implicit_coupling").execute(*args, **kwargs) - class explicit_time_averaged_coupling(metaclass=PyMenuMeta): + class explicit_time_averaged_coupling(TUIMenu): """ Enter the explcit time averaged thermal coupling menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def conformal_coupled_walls(self, *args, **kwargs): """ Select fluid-solid coupled walls (without shell) for explicit coupling using time averaged thermal variables. @@ -48046,13 +38339,14 @@ def fuse_explicit_cht_zones(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/cht/explicit_time_averaged_coupling/fuse_explicit_cht_zones").execute(*args, **kwargs) - class two_temperature(metaclass=PyMenuMeta): + class two_temperature(TUIMenu): """ Define two-temperature model menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def enable(self, *args, **kwargs): """ Enable/disable the two-temperature model. @@ -48074,7 +38368,7 @@ def set_verbosity(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/two_temperature/set_verbosity").execute(*args, **kwargs) - class multiphase(metaclass=PyMenuMeta): + class multiphase(TUIMenu): """ Define multiphase model menu. """ @@ -48085,6 +38379,7 @@ def __init__(self, path, service): self.wet_steam = self.__class__.wet_steam(path + [("wet_steam", None)], service) self.population_balance = self.__class__.population_balance(path + [("population_balance", None)], service) self.explicit_expert_options = self.__class__.explicit_expert_options(path + [("explicit_expert_options", None)], service) + super().__init__(path, service) def model(self, *args, **kwargs): """ Specify multiphase model. @@ -48146,7 +38441,7 @@ def expert_options(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/expert_options").execute(*args, **kwargs) - class phases(metaclass=PyMenuMeta): + class phases(TUIMenu): """ Enter the phases menu. """ @@ -48155,8 +38450,9 @@ def __init__(self, path, service): self.service = service self.set_domain_properties = self.__class__.set_domain_properties(path + [("set_domain_properties", None)], service) self.iac_expert = self.__class__.iac_expert(path + [("iac_expert", None)], service) + super().__init__(path, service) - class set_domain_properties(metaclass=PyMenuMeta): + class set_domain_properties(TUIMenu): """ Enter the menu to set domain properties. """ @@ -48164,6 +38460,7 @@ def __init__(self, path, service): self.path = path self.service = service self.interaction_domain = self.__class__.interaction_domain(path + [("interaction_domain", None)], service) + super().__init__(path, service) def change_phases_names(self, *args, **kwargs): """ Change names for all defined phases?. @@ -48175,7 +38472,7 @@ def phase_domains(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/phase_domains").execute(*args, **kwargs) - class interaction_domain(metaclass=PyMenuMeta): + class interaction_domain(TUIMenu): """ Enter the menu to set the interaction domain properties. """ @@ -48187,8 +38484,9 @@ def __init__(self, path, service): self.interfacial_area = self.__class__.interfacial_area(path + [("interfacial_area", None)], service) self.model_transition = self.__class__.model_transition(path + [("model_transition", None)], service) self.numerics = self.__class__.numerics(path + [("numerics", None)], service) + super().__init__(path, service) - class forces(metaclass=PyMenuMeta): + class forces(TUIMenu): """ Enter the menu to set interfacial forces related models. """ @@ -48201,6 +38499,7 @@ def __init__(self, path, service): self.lift = self.__class__.lift(path + [("lift", None)], service) self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) + super().__init__(path, service) def drag(self, *args, **kwargs): """ Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. @@ -48257,13 +38556,14 @@ def wall_lubrication(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/forces/wall_lubrication").execute(*args, **kwargs) - class cavitation(metaclass=PyMenuMeta): + class cavitation(TUIMenu): """ Enter the menu to set cavitation models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -48350,13 +38650,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/forces/cavitation/wall_adhesion").execute(*args, **kwargs) - class interphase_discretization(metaclass=PyMenuMeta): + class interphase_discretization(TUIMenu): """ Enter the menu to set interphase discretization models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -48443,13 +38744,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - class interphase_viscous_dissipation(metaclass=PyMenuMeta): + class interphase_viscous_dissipation(TUIMenu): """ Enter the menu to set interphase viscous dissipation related models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -48536,13 +38838,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/forces/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - class lift(metaclass=PyMenuMeta): + class lift(TUIMenu): """ Enter the menu to set lift models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -48629,13 +38932,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/forces/lift/wall_adhesion").execute(*args, **kwargs) - class surface_tension(metaclass=PyMenuMeta): + class surface_tension(TUIMenu): """ Enter the menu to set surface tension models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -48722,13 +39026,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/forces/surface_tension/wall_adhesion").execute(*args, **kwargs) - class virtual_mass(metaclass=PyMenuMeta): + class virtual_mass(TUIMenu): """ Enter the menu to set virtual mass models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -48815,7 +39120,7 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/forces/virtual_mass/wall_adhesion").execute(*args, **kwargs) - class heat_mass_reactions(metaclass=PyMenuMeta): + class heat_mass_reactions(TUIMenu): """ Enter the menu to set heat, mass-transfer, or reaction related models. """ @@ -48828,6 +39133,7 @@ def __init__(self, path, service): self.lift = self.__class__.lift(path + [("lift", None)], service) self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) + super().__init__(path, service) def drag(self, *args, **kwargs): """ Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. @@ -48884,13 +39190,14 @@ def wall_lubrication(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/wall_lubrication").execute(*args, **kwargs) - class cavitation(metaclass=PyMenuMeta): + class cavitation(TUIMenu): """ Enter the menu to set cavitation models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -48977,13 +39284,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/cavitation/wall_adhesion").execute(*args, **kwargs) - class interphase_discretization(metaclass=PyMenuMeta): + class interphase_discretization(TUIMenu): """ Enter the menu to set interphase discretization models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -49070,13 +39378,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - class interphase_viscous_dissipation(metaclass=PyMenuMeta): + class interphase_viscous_dissipation(TUIMenu): """ Enter the menu to set interphase viscous dissipation related models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -49163,13 +39472,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - class lift(metaclass=PyMenuMeta): + class lift(TUIMenu): """ Enter the menu to set lift models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -49256,13 +39566,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/lift/wall_adhesion").execute(*args, **kwargs) - class surface_tension(metaclass=PyMenuMeta): + class surface_tension(TUIMenu): """ Enter the menu to set surface tension models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -49349,13 +39660,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/surface_tension/wall_adhesion").execute(*args, **kwargs) - class virtual_mass(metaclass=PyMenuMeta): + class virtual_mass(TUIMenu): """ Enter the menu to set virtual mass models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -49442,7 +39754,7 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/heat_mass_reactions/virtual_mass/wall_adhesion").execute(*args, **kwargs) - class interfacial_area(metaclass=PyMenuMeta): + class interfacial_area(TUIMenu): """ Enter the menu to set interfacial area models. """ @@ -49455,6 +39767,7 @@ def __init__(self, path, service): self.lift = self.__class__.lift(path + [("lift", None)], service) self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) + super().__init__(path, service) def drag(self, *args, **kwargs): """ Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. @@ -49511,13 +39824,14 @@ def wall_lubrication(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/wall_lubrication").execute(*args, **kwargs) - class cavitation(metaclass=PyMenuMeta): + class cavitation(TUIMenu): """ Enter the menu to set cavitation models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -49604,13 +39918,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/cavitation/wall_adhesion").execute(*args, **kwargs) - class interphase_discretization(metaclass=PyMenuMeta): + class interphase_discretization(TUIMenu): """ Enter the menu to set interphase discretization models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -49697,13 +40012,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - class interphase_viscous_dissipation(metaclass=PyMenuMeta): + class interphase_viscous_dissipation(TUIMenu): """ Enter the menu to set interphase viscous dissipation related models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -49790,13 +40106,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - class lift(metaclass=PyMenuMeta): + class lift(TUIMenu): """ Enter the menu to set lift models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -49883,13 +40200,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/lift/wall_adhesion").execute(*args, **kwargs) - class surface_tension(metaclass=PyMenuMeta): + class surface_tension(TUIMenu): """ Enter the menu to set surface tension models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -49976,13 +40294,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/surface_tension/wall_adhesion").execute(*args, **kwargs) - class virtual_mass(metaclass=PyMenuMeta): + class virtual_mass(TUIMenu): """ Enter the menu to set virtual mass models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -50069,7 +40388,7 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/interfacial_area/virtual_mass/wall_adhesion").execute(*args, **kwargs) - class model_transition(metaclass=PyMenuMeta): + class model_transition(TUIMenu): """ Enter the menu to set model transition mechanisms. """ @@ -50082,6 +40401,7 @@ def __init__(self, path, service): self.lift = self.__class__.lift(path + [("lift", None)], service) self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) + super().__init__(path, service) def drag(self, *args, **kwargs): """ Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. @@ -50138,13 +40458,14 @@ def wall_lubrication(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/wall_lubrication").execute(*args, **kwargs) - class cavitation(metaclass=PyMenuMeta): + class cavitation(TUIMenu): """ Enter the menu to set cavitation models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -50231,13 +40552,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/cavitation/wall_adhesion").execute(*args, **kwargs) - class interphase_discretization(metaclass=PyMenuMeta): + class interphase_discretization(TUIMenu): """ Enter the menu to set interphase discretization models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -50324,13 +40646,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - class interphase_viscous_dissipation(metaclass=PyMenuMeta): + class interphase_viscous_dissipation(TUIMenu): """ Enter the menu to set interphase viscous dissipation related models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -50417,13 +40740,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - class lift(metaclass=PyMenuMeta): + class lift(TUIMenu): """ Enter the menu to set lift models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -50510,13 +40834,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/lift/wall_adhesion").execute(*args, **kwargs) - class surface_tension(metaclass=PyMenuMeta): + class surface_tension(TUIMenu): """ Enter the menu to set surface tension models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -50603,13 +40928,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/surface_tension/wall_adhesion").execute(*args, **kwargs) - class virtual_mass(metaclass=PyMenuMeta): + class virtual_mass(TUIMenu): """ Enter the menu to set virtual mass models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -50696,7 +41022,7 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/model_transition/virtual_mass/wall_adhesion").execute(*args, **kwargs) - class numerics(metaclass=PyMenuMeta): + class numerics(TUIMenu): """ Enter the menu to set numerics models. """ @@ -50709,6 +41035,7 @@ def __init__(self, path, service): self.lift = self.__class__.lift(path + [("lift", None)], service) self.surface_tension = self.__class__.surface_tension(path + [("surface_tension", None)], service) self.virtual_mass = self.__class__.virtual_mass(path + [("virtual_mass", None)], service) + super().__init__(path, service) def drag(self, *args, **kwargs): """ Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor. @@ -50765,13 +41092,14 @@ def wall_lubrication(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/wall_lubrication").execute(*args, **kwargs) - class cavitation(metaclass=PyMenuMeta): + class cavitation(TUIMenu): """ Enter the menu to set cavitation models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -50858,13 +41186,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/cavitation/wall_adhesion").execute(*args, **kwargs) - class interphase_discretization(metaclass=PyMenuMeta): + class interphase_discretization(TUIMenu): """ Enter the menu to set interphase discretization models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -50951,13 +41280,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_discretization/wall_adhesion").execute(*args, **kwargs) - class interphase_viscous_dissipation(metaclass=PyMenuMeta): + class interphase_viscous_dissipation(TUIMenu): """ Enter the menu to set interphase viscous dissipation related models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -51044,13 +41374,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/interphase_viscous_dissipation/wall_adhesion").execute(*args, **kwargs) - class lift(metaclass=PyMenuMeta): + class lift(TUIMenu): """ Enter the menu to set lift models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -51137,13 +41468,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/lift/wall_adhesion").execute(*args, **kwargs) - class surface_tension(metaclass=PyMenuMeta): + class surface_tension(TUIMenu): """ Enter the menu to set surface tension models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -51230,13 +41562,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/surface_tension/wall_adhesion").execute(*args, **kwargs) - class virtual_mass(metaclass=PyMenuMeta): + class virtual_mass(TUIMenu): """ Enter the menu to set virtual mass models. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def cavitation(self, *args, **kwargs): """ Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction. @@ -51323,13 +41656,14 @@ def wall_adhesion(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/set_domain_properties/interaction_domain/numerics/virtual_mass/wall_adhesion").execute(*args, **kwargs) - class iac_expert(metaclass=PyMenuMeta): + class iac_expert(TUIMenu): """ Enter the IAC expert setting menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def ishii_kim_model(self, *args, **kwargs): """ Set ik model coefficients. @@ -51351,7 +41685,7 @@ def iac_pseudo_time_step(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/phases/iac_expert/iac_pseudo_time_step").execute(*args, **kwargs) - class wet_steam(metaclass=PyMenuMeta): + class wet_steam(TUIMenu): """ Enter the wet steam model menu. """ @@ -51359,6 +41693,7 @@ def __init__(self, path, service): self.path = path self.service = service self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) def enable(self, *args, **kwargs): """ Enable/disable the wet steam model. @@ -51375,13 +41710,14 @@ def load_unload_user_defined_wetsteam_library(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/wet_steam/load_unload_user_defined_wetsteam_library").execute(*args, **kwargs) - class set(metaclass=PyMenuMeta): + class set(TUIMenu): """ Enter the set menu for setting wet steam model options. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def max_liquid_mass_fraction(self, *args, **kwargs): """ Set the maximum limit on the condensed liquid-phase mass-fraction to prevent divergence. @@ -51408,7 +41744,7 @@ def stagnation_conditions(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/wet_steam/set/stagnation_conditions").execute(*args, **kwargs) - class population_balance(metaclass=PyMenuMeta): + class population_balance(TUIMenu): """ Enter the population balance model menu. """ @@ -51417,6 +41753,7 @@ def __init__(self, path, service): self.service = service self.phenomena = self.__class__.phenomena(path + [("phenomena", None)], service) self.expert = self.__class__.expert(path + [("expert", None)], service) + super().__init__(path, service) def model(self, *args, **kwargs): """ Select the population balance model. @@ -51433,13 +41770,14 @@ def size_calculator(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/population_balance/size_calculator").execute(*args, **kwargs) - class phenomena(metaclass=PyMenuMeta): + class phenomena(TUIMenu): """ Enter the phenomena menu for population balance. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def nucleation(self, *args, **kwargs): """ Set the nucleantion rate. @@ -51476,7 +41814,7 @@ def breakage_aggregation_vof_cutoff(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/population_balance/phenomena/breakage_aggregation_vof_cutoff").execute(*args, **kwargs) - class expert(metaclass=PyMenuMeta): + class expert(TUIMenu): """ Enter the expert menu for quadrature-based population balance method. """ @@ -51484,14 +41822,16 @@ def __init__(self, path, service): self.path = path self.service = service self.qmom = self.__class__.qmom(path + [("qmom", None)], service) + super().__init__(path, service) - class qmom(metaclass=PyMenuMeta): + class qmom(TUIMenu): """ . """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def retain_qmom_sources_for_low_vof(self, *args, **kwargs): """ Retain qmom source calculation for low secondary phase vof. @@ -51513,7 +41853,7 @@ def inversion_algorithm(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/population_balance/expert/qmom/inversion_algorithm").execute(*args, **kwargs) - class explicit_expert_options(metaclass=PyMenuMeta): + class explicit_expert_options(TUIMenu): """ Expert options for explicit formulation. """ @@ -51521,6 +41861,7 @@ def __init__(self, path, service): self.path = path self.service = service self.volume_fraction_filtering = self.__class__.volume_fraction_filtering(path + [("volume_fraction_filtering", None)], service) + super().__init__(path, service) def sub_time_step_method(self, *args, **kwargs): """ Select sub-time step method for the time integration in explicit formulation. @@ -51532,13 +41873,14 @@ def solve_vof_every_iter(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/explicit_expert_options/solve_vof_every_iter").execute(*args, **kwargs) - class volume_fraction_filtering(metaclass=PyMenuMeta): + class volume_fraction_filtering(TUIMenu): """ Advanced volume fraction filtering controls for explicit formulation. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def enable(self, *args, **kwargs): """ Enable volume fraction filtering treatment. @@ -51555,13 +41897,14 @@ def vol_frac_cutoff(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/multiphase/explicit_expert_options/volume_fraction_filtering/vol_frac_cutoff").execute(*args, **kwargs) - class nox_parameters(metaclass=PyMenuMeta): + class nox_parameters(TUIMenu): """ Enter the NOx parameters menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def nox_chemistry(self, *args, **kwargs): """ Select NOx chemistry model. @@ -51583,13 +41926,14 @@ def nox_expert(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/nox_parameters/nox_expert").execute(*args, **kwargs) - class soot_parameters(metaclass=PyMenuMeta): + class soot_parameters(TUIMenu): """ Enter the soot parameters menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def soot_model_parameters(self, *args, **kwargs): """ Enter the soot model parameters menu. @@ -51626,7 +41970,7 @@ def soot_model_udfs(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/soot_parameters/soot_model_udfs").execute(*args, **kwargs) - class radiation(metaclass=PyMenuMeta): + class radiation(TUIMenu): """ Enter the radiation models menu. """ @@ -51636,6 +41980,7 @@ def __init__(self, path, service): self.s2s_parameters = self.__class__.s2s_parameters(path + [("s2s_parameters", None)], service) self.dtrm_parameters = self.__class__.dtrm_parameters(path + [("dtrm_parameters", None)], service) self.solar_parameters = self.__class__.solar_parameters(path + [("solar_parameters", None)], service) + super().__init__(path, service) def discrete_ordinates(self, *args, **kwargs): """ Enable/disable the discrete ordinates radiation model. @@ -51757,13 +42102,14 @@ def blending_factor(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/radiation/blending_factor").execute(*args, **kwargs) - class s2s_parameters(metaclass=PyMenuMeta): + class s2s_parameters(TUIMenu): """ Enter the S2S parameters menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def compute_vf_only(self, *args, **kwargs): """ Compute/write view factors only. @@ -51840,13 +42186,14 @@ def enable_mesh_interface_clustering(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/radiation/s2s_parameters/enable_mesh_interface_clustering").execute(*args, **kwargs) - class dtrm_parameters(metaclass=PyMenuMeta): + class dtrm_parameters(TUIMenu): """ Enter the DTRM parameters menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def controls(self, *args, **kwargs): """ Set DTRM solution controls. @@ -51868,13 +42215,14 @@ def check_ray_file(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/radiation/dtrm_parameters/check_ray_file").execute(*args, **kwargs) - class solar_parameters(metaclass=PyMenuMeta): + class solar_parameters(TUIMenu): """ Enter the solar parameters menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def autosave_solar_data(self, *args, **kwargs): """ Set autosave solar data parameters. @@ -51941,13 +42289,14 @@ def solar_thread_control(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/radiation/solar_parameters/solar_thread_control").execute(*args, **kwargs) - class solver(metaclass=PyMenuMeta): + class solver(TUIMenu): """ Enter the menu to select the solver. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def pressure_based(self, *args, **kwargs): """ Enable/disable the segregated solver. @@ -51969,7 +42318,7 @@ def adjust_solver_defaults_based_on_setup(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/solver/adjust_solver_defaults_based_on_setup").execute(*args, **kwargs) - class species(metaclass=PyMenuMeta): + class species(TUIMenu): """ Enter the species models menu. """ @@ -51977,6 +42326,7 @@ def __init__(self, path, service): self.path = path self.service = service self.CHEMKIN_CFD_parameters = self.__class__.CHEMKIN_CFD_parameters(path + [("CHEMKIN_CFD_parameters", None)], service) + super().__init__(path, service) def off(self, *args, **kwargs): """ Enable/disable solution of species models. @@ -52278,13 +42628,14 @@ def combustion_numerics(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/species/combustion_numerics").execute(*args, **kwargs) - class CHEMKIN_CFD_parameters(metaclass=PyMenuMeta): + class CHEMKIN_CFD_parameters(TUIMenu): """ Enter the expert CHEMKIN-CFD parameters menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def basic_options(self, *args, **kwargs): """ Set basic parameter options. @@ -52311,7 +42662,7 @@ def delete_cell_monitors(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/species/CHEMKIN_CFD_parameters/delete_cell_monitors").execute(*args, **kwargs) - class viscous(metaclass=PyMenuMeta): + class viscous(TUIMenu): """ Enter the viscous model menu. """ @@ -52323,6 +42674,7 @@ def __init__(self, path, service): self.turbulence_expert = self.__class__.turbulence_expert(path + [("turbulence_expert", None)], service) self.geko_options = self.__class__.geko_options(path + [("geko_options", None)], service) self.transition_model_options = self.__class__.transition_model_options(path + [("transition_model_options", None)], service) + super().__init__(path, service) def inviscid(self, *args, **kwargs): """ Enable/disable the inviscid flow model. @@ -52616,13 +42968,14 @@ def trans_sst_roughness_correlation(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/viscous/trans_sst_roughness_correlation").execute(*args, **kwargs) - class near_wall_treatment(metaclass=PyMenuMeta): + class near_wall_treatment(TUIMenu): """ Enter the near wall treatment menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def non_equilibrium_wall_fn(self, *args, **kwargs): """ Enable/disable non-equilibrium wall functions. @@ -52664,13 +43017,14 @@ def wf_thermal_effects(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/viscous/near_wall_treatment/wf_thermal_effects").execute(*args, **kwargs) - class multiphase_turbulence(metaclass=PyMenuMeta): + class multiphase_turbulence(TUIMenu): """ Enter the multiphase turbulence menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def multiphase_options(self, *args, **kwargs): """ Enable/disable multiphase options. @@ -52692,13 +43046,14 @@ def subgrid_turbulence_contribution_aiad(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/viscous/multiphase_turbulence/subgrid_turbulence_contribution_aiad").execute(*args, **kwargs) - class turbulence_expert(metaclass=PyMenuMeta): + class turbulence_expert(TUIMenu): """ Enter the turbulence expert menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def low_re_ke(self, *args, **kwargs): """ Enable/disable the low-Re k-epsilon turbulence model. @@ -52802,13 +43157,14 @@ def stg_set_ti_and_tvr_limiters(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/viscous/turbulence_expert/stg_set_ti_and_tvr_limiters").execute(*args, **kwargs) - class geko_options(metaclass=PyMenuMeta): + class geko_options(TUIMenu): """ Enter the GEKO options menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def wall_distance_free(self, *args, **kwargs): """ Enable/disable wall-distance-free version of GEKO model. @@ -52870,13 +43226,14 @@ def geko_defaults(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/viscous/geko_options/geko_defaults").execute(*args, **kwargs) - class transition_model_options(metaclass=PyMenuMeta): + class transition_model_options(TUIMenu): """ Enter the transition model options menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def crossflow_transition(self, *args, **kwargs): """ Enable/disable crossflow transition for the intermittency transition model. @@ -52953,7 +43310,7 @@ def rv1_switch(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/viscous/transition_model_options/rv1_switch").execute(*args, **kwargs) - class structure(metaclass=PyMenuMeta): + class structure(TUIMenu): """ Enter the structure model menu. """ @@ -52962,6 +43319,7 @@ def __init__(self, path, service): self.service = service self.controls = self.__class__.controls(path + [("controls", None)], service) self.expert = self.__class__.expert(path + [("expert", None)], service) + super().__init__(path, service) def structure_off(self, *args, **kwargs): """ Disable the structural model. @@ -52983,13 +43341,14 @@ def thermal_effects(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/structure/thermal_effects").execute(*args, **kwargs) - class controls(metaclass=PyMenuMeta): + class controls(TUIMenu): """ Enter the structure controls menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def numerical_damping_factor(self, *args, **kwargs): """ Set structure damping parameters. @@ -53016,13 +43375,14 @@ def max_iter(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/structure/controls/max_iter").execute(*args, **kwargs) - class expert(metaclass=PyMenuMeta): + class expert(TUIMenu): """ Enter the structure expert menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def include_pop_in_fsi_force(self, *args, **kwargs): """ Enable inclusion of operating p into fsi force. @@ -53044,7 +43404,7 @@ def explicit_fsi_force(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/structure/expert/explicit_fsi_force").execute(*args, **kwargs) - class heat_exchanger(metaclass=PyMenuMeta): + class heat_exchanger(TUIMenu): """ Enter the heat exchanger menu. """ @@ -53053,14 +43413,16 @@ def __init__(self, path, service): self.service = service self.macro_model = self.__class__.macro_model(path + [("macro_model", None)], service) self.dual_cell_model = self.__class__.dual_cell_model(path + [("dual_cell_model", None)], service) + super().__init__(path, service) - class macro_model(metaclass=PyMenuMeta): + class macro_model(TUIMenu): """ Enter the heat macro-model menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def heat_exchanger(self, *args, **kwargs): """ Enable/disable heat-exchanger model. @@ -53107,13 +43469,14 @@ def write_NTU(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/heat_exchanger/macro_model/write_NTU").execute(*args, **kwargs) - class dual_cell_model(metaclass=PyMenuMeta): + class dual_cell_model(TUIMenu): """ Enter the dual cell model menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def heat_exchanger(self, *args, **kwargs): """ Enable/disable the dual cell heat-exchanger model. @@ -53150,7 +43513,7 @@ def alternative_formulation(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/heat_exchanger/dual_cell_model/alternative_formulation").execute(*args, **kwargs) - class electrolysis_setup(metaclass=PyMenuMeta): + class electrolysis_setup(TUIMenu): """ Enter the electrolysis model setup menu. """ @@ -53160,6 +43523,7 @@ def __init__(self, path, service): self.anode_setup = self.__class__.anode_setup(path + [("anode_setup", None)], service) self.cathode_setup = self.__class__.cathode_setup(path + [("cathode_setup", None)], service) self.membrane_setup = self.__class__.membrane_setup(path + [("membrane_setup", None)], service) + super().__init__(path, service) def model_options(self, *args, **kwargs): """ Model Options. @@ -53176,13 +43540,14 @@ def electrical_tabs_setup(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/electrolysis_setup/electrical_tabs_setup").execute(*args, **kwargs) - class anode_setup(metaclass=PyMenuMeta): + class anode_setup(TUIMenu): """ Anode Setup. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def current_collector(self, *args, **kwargs): """ Set Current Collector. @@ -53209,13 +43574,14 @@ def electrolyte(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/electrolysis_setup/anode_setup/electrolyte").execute(*args, **kwargs) - class cathode_setup(metaclass=PyMenuMeta): + class cathode_setup(TUIMenu): """ Cathode Setup. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def current_collector(self, *args, **kwargs): """ Set Current Collector. @@ -53242,13 +43608,14 @@ def electrolyte(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/electrolysis_setup/cathode_setup/electrolyte").execute(*args, **kwargs) - class membrane_setup(metaclass=PyMenuMeta): + class membrane_setup(TUIMenu): """ Membrane Setup. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def current_collector(self, *args, **kwargs): """ Set Current Collector. @@ -53275,13 +43642,14 @@ def electrolyte(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/models/electrolysis_setup/membrane_setup/electrolyte").execute(*args, **kwargs) - class named_expressions(metaclass=PyMenuMeta): + class named_expressions(TUIMenu): """ Manage named expressions. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def add(self, *args, **kwargs): """ Add a new object. @@ -53328,13 +43696,14 @@ def list_properties(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/named_expressions/list_properties").execute(*args, **kwargs) - class operating_conditions(metaclass=PyMenuMeta): + class operating_conditions(TUIMenu): """ Enter the define operating conditions menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def gravity(self, *args, **kwargs): """ Set gravitational acceleration. @@ -53386,7 +43755,7 @@ def operating_temperature(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/operating_conditions/operating_temperature").execute(*args, **kwargs) - class overset_interfaces(metaclass=PyMenuMeta): + class overset_interfaces(TUIMenu): """ Enter the overset-interfaces menu. """ @@ -53396,6 +43765,7 @@ def __init__(self, path, service): self.options = self.__class__.options(path + [("options", None)], service) self.cut_control = self.__class__.cut_control(path + [("cut_control", None)], service) self.adapt = self.__class__.adapt(path + [("adapt", None)], service) + super().__init__(path, service) def create(self, *args, **kwargs): """ Create an overset interface. @@ -53517,13 +43887,14 @@ def find_all_bounding_cells(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/overset_interfaces/find_all_bounding_cells").execute(*args, **kwargs) - class options(metaclass=PyMenuMeta): + class options(TUIMenu): """ Enter the overset interface options menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def expert(self, *args, **kwargs): """ Enable additional overset options and tools. @@ -53610,7 +43981,7 @@ def verbosity(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/overset_interfaces/options/verbosity").execute(*args, **kwargs) - class cut_control(metaclass=PyMenuMeta): + class cut_control(TUIMenu): """ Enter the overset hole cut control menu. """ @@ -53618,6 +43989,7 @@ def __init__(self, path, service): self.path = path self.service = service self.cut_seeds = self.__class__.cut_seeds(path + [("cut_seeds", None)], service) + super().__init__(path, service) def add(self, *args, **kwargs): """ Add hole cut control for a boundary zone. @@ -53639,13 +44011,14 @@ def list(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/overset_interfaces/cut_control/list").execute(*args, **kwargs) - class cut_seeds(metaclass=PyMenuMeta): + class cut_seeds(TUIMenu): """ Enter the overset hole cut seed menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def add(self, *args, **kwargs): """ Add a hole cut seed. @@ -53672,7 +44045,7 @@ def cut_seeds_for_all_component_zones(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/overset_interfaces/cut_control/cut_seeds/cut_seeds_for_all_component_zones").execute(*args, **kwargs) - class adapt(metaclass=PyMenuMeta): + class adapt(TUIMenu): """ Enter the overset adaption menu. """ @@ -53680,6 +44053,7 @@ def __init__(self, path, service): self.path = path self.service = service self.set = self.__class__.set(path + [("set", None)], service) + super().__init__(path, service) def mark_adaption(self, *args, **kwargs): """ Mark cells for overset orphan adaption and donor-receptor size differences. @@ -53691,13 +44065,14 @@ def adapt_mesh(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/overset_interfaces/adapt/adapt_mesh").execute(*args, **kwargs) - class set(metaclass=PyMenuMeta): + class set(TUIMenu): """ Enter the overset adaption set menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def mark_orphans(self, *args, **kwargs): """ Enable the option to adapt for orphan reduction. @@ -53754,13 +44129,14 @@ def maximum_refinement_level(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/overset_interfaces/adapt/set/maximum_refinement_level").execute(*args, **kwargs) - class reference_frames(metaclass=PyMenuMeta): + class reference_frames(TUIMenu): """ Manage reference frames. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def add(self, *args, **kwargs): """ Add a new object. @@ -53802,7 +44178,7 @@ def list_properties(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/reference_frames/list_properties").execute(*args, **kwargs) - class reference_values(metaclass=PyMenuMeta): + class reference_values(TUIMenu): """ Reference value menu. """ @@ -53810,6 +44186,7 @@ def __init__(self, path, service): self.path = path self.service = service self.compute = self.__class__.compute(path + [("compute", None)], service) + super().__init__(path, service) def area(self, *args, **kwargs): """ Set reference area for normalization. @@ -53871,13 +44248,14 @@ def list(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/reference_values/list").execute(*args, **kwargs) - class compute(metaclass=PyMenuMeta): + class compute(TUIMenu): """ Enter the compute menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def axis(self, *args, **kwargs): """ Compute reference values from a zone of this type. @@ -54039,7 +44417,7 @@ def wall(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/reference_values/compute/wall").execute(*args, **kwargs) - class turbo_model(metaclass=PyMenuMeta): + class turbo_model(TUIMenu): """ Turbo features menu. """ @@ -54049,6 +44427,7 @@ def __init__(self, path, service): self.turbo_topology = self.__class__.turbo_topology(path + [("turbo_topology", None)], service) self.general_turbo_interface_settings = self.__class__.general_turbo_interface_settings(path + [("general_turbo_interface_settings", None)], service) self.blade_flutter_harmonics = self.__class__.blade_flutter_harmonics(path + [("blade_flutter_harmonics", None)], service) + super().__init__(path, service) def enable_turbo_model(self, *args, **kwargs): """ Enable/disable turbo model menu. @@ -54135,13 +44514,14 @@ def make_phaselag_from_periodic(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/turbo_model/make_phaselag_from_periodic").execute(*args, **kwargs) - class turbo_topology(metaclass=PyMenuMeta): + class turbo_topology(TUIMenu): """ Define turbo topology. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def define_topology(self, *args, **kwargs): """ Define a turbo topology. @@ -54168,7 +44548,7 @@ def delete(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/turbo_model/turbo_topology/delete").execute(*args, **kwargs) - class general_turbo_interface_settings(metaclass=PyMenuMeta): + class general_turbo_interface_settings(TUIMenu): """ Set General Turbo Interface options. """ @@ -54179,8 +44559,9 @@ def __init__(self, path, service): self.pitch_scale_model_settings = self.__class__.pitch_scale_model_settings(path + [("pitch_scale_model_settings", None)], service) self.no_pitch_scale_model_settings = self.__class__.no_pitch_scale_model_settings(path + [("no_pitch_scale_model_settings", None)], service) self.expert = self.__class__.expert(path + [("expert", None)], service) + super().__init__(path, service) - class mixing_plane_model_settings(metaclass=PyMenuMeta): + class mixing_plane_model_settings(TUIMenu): """ Set the mixing plane model settings. """ @@ -54188,6 +44569,7 @@ def __init__(self, path, service): self.path = path self.service = service self.number_of_bands = self.__class__.number_of_bands(path + [("number_of_bands", None)], service) + super().__init__(path, service) def averaging_method(self, *args, **kwargs): """ Set the averaging method for the mixing. @@ -54214,13 +44596,14 @@ def list_mixing_planes(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/turbo_model/general_turbo_interface_settings/mixing_plane_model_settings/list_mixing_planes").execute(*args, **kwargs) - class number_of_bands(metaclass=PyMenuMeta): + class number_of_bands(TUIMenu): """ Set the maximum number of bands to be used for mixing. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def set_specific_interface(self, *args, **kwargs): """ Set number of band to be used for mixing. @@ -54232,39 +44615,42 @@ def set_all_interfaces(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/turbo_model/general_turbo_interface_settings/mixing_plane_model_settings/number_of_bands/set_all_interfaces").execute(*args, **kwargs) - class pitch_scale_model_settings(metaclass=PyMenuMeta): + class pitch_scale_model_settings(TUIMenu): """ Set the pitch scale model settings. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def scale_mflux(self, *args, **kwargs): """ Scale mass flux to improve the conservation. """ return PyMenu(self.service, "/setup/turbo_model/general_turbo_interface_settings/pitch_scale_model_settings/scale_mflux").execute(*args, **kwargs) - class no_pitch_scale_model_settings(metaclass=PyMenuMeta): + class no_pitch_scale_model_settings(TUIMenu): """ Set the no pitch scale model settings. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def scale_mflux(self, *args, **kwargs): """ Scale mass flux to improve the conservation. """ return PyMenu(self.service, "/setup/turbo_model/general_turbo_interface_settings/no_pitch_scale_model_settings/scale_mflux").execute(*args, **kwargs) - class expert(metaclass=PyMenuMeta): + class expert(TUIMenu): """ Set the expert parameters for turbo interfaces. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def enforce_flux_scaling(self, *args, **kwargs): """ Enforce flux scaling ON/OFF at the turbo interfaces. @@ -54276,13 +44662,14 @@ def list_settings(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/turbo_model/general_turbo_interface_settings/expert/list_settings").execute(*args, **kwargs) - class blade_flutter_harmonics(metaclass=PyMenuMeta): + class blade_flutter_harmonics(TUIMenu): """ Enter the blade flutter harmonics menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def enable_harmonic_postprocessing(self, *args, **kwargs): """ Calculates/Deletes Postprocessing Fourier coefficients data. @@ -54304,7 +44691,7 @@ def write_aerodamping_vs_nodal_diameter(self, *args, **kwargs): """ return PyMenu(self.service, "/setup/turbo_model/blade_flutter_harmonics/write_aerodamping_vs_nodal_diameter").execute(*args, **kwargs) - class surface(metaclass=PyMenuMeta): + class surface(TUIMenu): """ Enter the data surface manipulation menu. """ @@ -54313,6 +44700,7 @@ def __init__(self, path, service): self.service = service self.post_processing_volume = self.__class__.post_processing_volume(path + [("post_processing_volume", None)], service) self.query = self.__class__.query(path + [("query", None)], service) + super().__init__(path, service) def circle_slice(self, *args, **kwargs): """ Extracts a circular slice. @@ -54489,13 +44877,14 @@ def edit_surface(self, *args, **kwargs): """ return PyMenu(self.service, "/surface/edit_surface").execute(*args, **kwargs) - class post_processing_volume(metaclass=PyMenuMeta): + class post_processing_volume(TUIMenu): """ Enter post-processing volume menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def create_from_file(self, *args, **kwargs): """ Read post-processing mesh from file. @@ -54507,13 +44896,14 @@ def create_octree(self, *args, **kwargs): """ return PyMenu(self.service, "/surface/post_processing_volume/create_octree").execute(*args, **kwargs) - class query(metaclass=PyMenuMeta): + class query(TUIMenu): """ Enter surface query menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def delete_query(self, *args, **kwargs): """ Delete saved query. @@ -54540,13 +44930,14 @@ def list_queries(self, *args, **kwargs): """ return PyMenu(self.service, "/surface/query/list_queries").execute(*args, **kwargs) - class simulation_reports(metaclass=PyMenuMeta): + class simulation_reports(TUIMenu): """ Enter the simulation reports menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def list_simulation_reports(self, *args, **kwargs): """ List all report names. @@ -54608,13 +44999,14 @@ def read_simulation_report_template_file(self, *args, **kwargs): """ return PyMenu(self.service, "/simulation_reports/read_simulation_report_template_file").execute(*args, **kwargs) - class server(metaclass=PyMenuMeta): + class server(TUIMenu): """ Enter the server menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def start_server(self, *args, **kwargs): """ Starts the server for the ANSYS Fluent remote visualization client. @@ -54646,13 +45038,14 @@ def shutdown_server(self, *args, **kwargs): """ return PyMenu(self.service, "/server/shutdown_server").execute(*args, **kwargs) - class turbo_post(metaclass=PyMenuMeta): + class turbo_post(TUIMenu): """ Enter the turbo menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def compute_report(self, *args, **kwargs): """ Computes turbomachinery quantities. @@ -54684,7 +45077,7 @@ def current_topology(self, *args, **kwargs): """ return PyMenu(self.service, "/turbo_post/current_topology").execute(*args, **kwargs) - class views(metaclass=PyMenuMeta): + class views(TUIMenu): """ Enter the view manipulation menu. """ @@ -54692,6 +45085,7 @@ def __init__(self, path, service): self.path = path self.service = service self.camera = self.__class__.camera(path + [("camera", None)], service) + super().__init__(path, service) def auto_scale(self, *args, **kwargs): """ Scales and centers the current scene without changing its orientation. @@ -54743,13 +45137,14 @@ def write_views(self, *args, **kwargs): """ return PyMenu(self.service, "/views/write_views").execute(*args, **kwargs) - class camera(metaclass=PyMenuMeta): + class camera(TUIMenu): """ Enters the camera menu to modify the current viewing parameters. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def dolly_camera(self, *args, **kwargs): """ Adjusts the camera position and target. @@ -54801,7 +45196,7 @@ def zoom_camera(self, *args, **kwargs): """ return PyMenu(self.service, "/views/camera/zoom_camera").execute(*args, **kwargs) - class parametric_study(metaclass=PyMenuMeta): + class parametric_study(TUIMenu): """ Enter the parametric study menu. """ @@ -54810,6 +45205,7 @@ def __init__(self, path, service): self.service = service self.design_points = self.__class__.design_points(path + [("design_points", None)], service) self.update = self.__class__.update(path + [("update", None)], service) + super().__init__(path, service) def initialize(self, *args, **kwargs): """ Start Parametric Study. @@ -54856,13 +45252,14 @@ def import_design_table(self, *args, **kwargs): """ return PyMenu(self.service, "/parametric_study/import_design_table").execute(*args, **kwargs) - class design_points(metaclass=PyMenuMeta): + class design_points(TUIMenu): """ Enter the design points menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def add_design_point(self, *args, **kwargs): """ Add new design point. @@ -54954,7 +45351,7 @@ def interrupt_all_design_points_submitted_concurrently(self, *args, **kwargs): """ return PyMenu(self.service, "/parametric_study/design_points/interrupt_all_design_points_submitted_concurrently").execute(*args, **kwargs) - class update(metaclass=PyMenuMeta): + class update(TUIMenu): """ Enter the update menu. """ @@ -54962,6 +45359,7 @@ def __init__(self, path, service): self.path = path self.service = service self.concurrent_settings = self.__class__.concurrent_settings(path + [("concurrent_settings", None)], service) + super().__init__(path, service) def set_update_method(self, *args, **kwargs): """ Set update method. @@ -55008,13 +45406,14 @@ def set_number_of_cores_per_dp(self, *args, **kwargs): """ return PyMenu(self.service, "/parametric_study/update/set_number_of_cores_per_dp").execute(*args, **kwargs) - class concurrent_settings(metaclass=PyMenuMeta): + class concurrent_settings(TUIMenu): """ Enter the Concurrent Settings menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def set_license_type(self, *args, **kwargs): """ Set License Type. @@ -55046,7 +45445,7 @@ def set_optislang_license_count(self, *args, **kwargs): """ return PyMenu(self.service, "/parametric_study/update/concurrent_settings/set_optislang_license_count").execute(*args, **kwargs) - class turbo_workflow(metaclass=PyMenuMeta): + class turbo_workflow(TUIMenu): """ Enter the turbo workflow menu. """ @@ -55054,14 +45453,16 @@ def __init__(self, path, service): self.path = path self.service = service self.workflow = self.__class__.workflow(path + [("workflow", None)], service) + super().__init__(path, service) - class workflow(metaclass=PyMenuMeta): + class workflow(TUIMenu): """ Enter the workflow menu. """ def __init__(self, path, service): self.path = path self.service = service + super().__init__(path, service) def enable(self, *args, **kwargs): """ Enable the workflow.