Search

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

Functions:

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

ansys.fluent.core.utils.search.get_api_tree_file_name(version, pyfluent_path)

Get API tree file name.

ansys.fluent.core.utils.search.search(word, match_whole_word=False, match_case=False, version=None, search_root=None)

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

Parameters:

wordstr

The word to search for.

match_whole_wordbool, optional

Whether to match whole word, by default False

match_casebool, optional

Whether to match case, by default False

versionstr, optional

Fluent version to search in, by default None in which case it will search in the latest version for which codegen was run.

search_rootAny, optional

The root object within which the search will be performed, can be a session object or any API object within a session, by default None in which case it will search everything.

Examples

>>> import ansys.fluent.core as pyfluent
>>> pyfluent.search("geometry")
<meshing_session>.tui.file.import_.cad_geometry (Command)
<meshing_session>.tui.display.update_scene.select_geometry (Command)
<meshing_session>.meshing.ImportGeometry (Command)
<meshing_session>.meshing.LoadCADGeometry (Command)
<solver_session>.tui.solve.initialize.compute_defaults.geometry (Command)
<solver_session>.tui.report.reference_values.compute.geometry (Command)
<solver_session>.tui.define.geometry (Command)
<solver_session>.tui.mesh.geometry (Object)
<solver_session>.setup.boundary_conditions.geometry["<name>"] (Object)
<solver_session>.setup.geometry (Object)
<solver_session>.solution.report_definitions.surface["<name>"].geometry (Parameter)
<solver_session>.solution.report_definitions.volume["<name>"].geometry (Parameter)
<solver_session>.results.graphics.mesh["<name>"].geometry (Parameter)
<solver_session>.results.graphics.contour["<name>"].geometry (Parameter)