search

Provides a module to search a word through the Fluent’s object hierarchy..

Functions:

get_api_tree_file_name(version)	Get API tree file name.
search(search_string[, language, ...])	Search for a word through the Fluent's object hierarchy.

ansys.fluent.core.search.get_api_tree_file_name(version)

Get API tree file name.

ansys.fluent.core.search.search(search_string, language='eng', match_whole_word=False, match_case=True, api_path=None)

Search for a word through the Fluent’s object hierarchy.

Parameters:

search_string: str

Word to search for. Semantic search is the default.

language: str

ISO 639-3 code for the language to use for the semantic search. The default is eng for English. For the list of supported languages, see OMW Version 1.

match_whole_word: bool, optional

Whether to find only exact matches. The default is False. If True, only exact matches are found and semantic matching is turned off.

match_case: bool, optional

Whether to match case. The default is True. If False, the search is case-insensitive.

api_path: str, optional

The API path to search in. The default is None. If None, it searches in the whole Fluent’s object hierarchy.

Examples

>>> import ansys.fluent.core as pyfluent
>>> pyfluent.search("font", match_whole_word=True)
>>> pyfluent.search("Font")
>>> pyfluent.search("local*", api_path="<solver_session>.setup")
<solver_session>.setup.dynamic_mesh.methods.smoothing.radial_settings.local_smoothing (Parameter)
<solver_session>.setup.mesh_interfaces.interface["<name>"].local_absolute_mapped_tolerance (Parameter)
<solver_session>.setup.mesh_interfaces.interface["<name>"].local_relative_mapped_tolerance (Parameter)
>>> pyfluent.search("读", language="cmn")   # search 'read' in Chinese
<solver_session>.file.read (Command)
<solver_session>.file.import_.read (Command)
<solver_session>.mesh.surface_mesh.read (Command)
<solver_session>.tui.display.display_states.read (Command)
<meshing_session>.tui.display.display_states.read (Command)