Skip to content

Commit 22b4c3e

Browse files
hpohekarpyansys-ci-bot
hpohekar
and
pyansys-ci-bot
authored
docs: update search results [skip tests] (#4266)
Updated search results after removing redundant children. --------- Co-authored-by: pyansys-ci-bot <[email protected]>
1 parent 01ebda2 commit 22b4c3e

File tree

2 files changed

+70
-59
lines changed

2 files changed

+70
-59
lines changed

‎doc/changelog.d/4266.documentation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update search results [skip tests]

‎doc/source/user_guide/usability.rst

Lines changed: 69 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -22,41 +22,43 @@ Examples
2222
>>> # Semantic search
2323
>>> pyfluent.search("speed")
2424
...
25-
<solver_session>.setup.physics.volumes.solid["<name>"].solid_motion.solid_motion_velocity[<index>] (Object) (similarity: 98.31%)
26-
<solver_session>.setup.physics.volumes.solid["<name>"].solid_motion.solid_motion_velocity[<index>].field_name (Parameter) (similarity: 98.31%)
27-
<solver_session>.setup.physics.volumes.solid["<name>"].solid_motion.solid_motion_velocity[<index>].list_properties (Command) (similarity: 98.31%)
28-
<solver_session>.setup.physics.volumes.solid["<name>"].solid_motion.solid_motion_velocity[<index>].option (Parameter) (similarity: 98.31%)
29-
<solver_session>.setup.physics.volumes.solid["<name>"].solid_motion.solid_motion_velocity[<index>].profile_name (Parameter) (similarity: 98.31%)
30-
<solver_session>.setup.physics.volumes.solid["<name>"].solid_motion.solid_motion_velocity[<index>].resize (Command) (similarity: 98.31%)
31-
<solver_session>.setup.physics.volumes.solid["<name>"].solid_motion.solid_motion_velocity[<index>].udf (Parameter) (similarity: 98.31%)
32-
<solver_session>.setup.physics.volumes.solid["<name>"].solid_motion.solid_motion_velocity[<index>].value (Parameter) (similarity: 98.31%)
33-
<solver_session>.setup.reference_frames["<name>"].motion.constant_velocity (Object) (similarity: 98.31%)
34-
<solver_session>.setup.reference_frames["<name>"].motion.constant_velocity.linear_velocity (Parameter) (similarity: 98.31%)
35-
<solver_session>.setup.reference_frames["<name>"].motion.constant_velocity.rotational_velocity (Object) (similarity: 98.31%)
36-
<solver_session>.setup.reference_frames["<name>"].motion.constant_velocity.rotational_velocity.rotation_axis (Parameter) (similarity: 98.31%)
37-
<solver_session>.setup.reference_frames["<name>"].motion.constant_velocity.rotational_velocity.speed (Parameter) (similarity: 98.31%)
38-
<solver_session>.setup.reference_values.velocity (Parameter) (similarity: 98.31%)
39-
<solver_session>.solution.initialization.hybrid_init_options.general_settings.initialization_options.const_velocity (Parameter) (similarity: 98.31%)
40-
<solver_session>.solution.methods.expert.physical_velocity_formulation (Parameter) (similarity: 98.31%)
41-
<solver_session>.solution.methods.expert.velocity_formulation (Parameter) (similarity: 98.31%)
42-
<solver_session>.solution.methods.high_speed_numerics (Object) (similarity: 98.31%)
43-
<solver_session>.solution.methods.high_speed_numerics.enable (Parameter) (similarity: 98.31%)
44-
<solver_session>.solution.methods.high_speed_numerics.expert (Parameter) (similarity: 98.31%)
45-
<solver_session>.solution.methods.high_speed_numerics.robust_fluxes (Parameter) (similarity: 98.31%)
46-
<solver_session>.solution.methods.high_speed_numerics.visualize_pressure_discontinuity_sensor (Parameter) (similarity: 98.31%)
47-
<solver_session>.solution.methods.multiphase_numerics.advanced_stability_controls.hybrid_nita.instability_detector.set_velocity_limit (Parameter) (similarity: 98.31%)
25+
<solver_session>.setup.boundary_conditions.wall["<name>"].turbulence.free_stream_velocity (Parameter) (similarity: 98.31%)
26+
<solver_session>.setup.boundary_conditions.wall["<name>"].wall_film.relative_initial_film_velocity (Parameter) (similarity: 98.31%)
27+
<solver_session>.setup.boundary_conditions.wall["<name>"].wall_film.upper_deposition_limit_offset (Parameter) (similarity: 98.31%)
28+
<solver_session>.setup.cell_zone_conditions.fluid["<name>"].disabled.solid_motion_velocity[<index>] (Object) (similarity: 98.31%)
29+
<solver_session>.setup.cell_zone_conditions.fluid["<name>"].mesh_motion.moving_mesh_velocity[<index>] (Object) (similarity: 98.31%)
30+
<solver_session>.setup.cell_zone_conditions.fluid["<name>"].phase["<name>"].disabled.solid_motion_velocity[<index>] (Object) (similarity: 98.31%)
31+
<solver_session>.setup.cell_zone_conditions.fluid["<name>"].phase["<name>"].mesh_motion.moving_mesh_velocity[<index>] (Object) (similarity: 98.31%)
32+
<solver_session>.setup.cell_zone_conditions.fluid["<name>"].phase["<name>"].reference_frame.reference_frame_velocity[<index>] (Object) (similarity: 98.31%)
33+
<solver_session>.setup.cell_zone_conditions.fluid["<name>"].reference_frame.reference_frame_velocity[<index>] (Object) (similarity: 98.31%)
34+
<solver_session>.setup.cell_zone_conditions.solid["<name>"].mesh_motion.moving_mesh_velocity[<index>] (Object) (similarity: 98.31%)
35+
<solver_session>.setup.cell_zone_conditions.solid["<name>"].phase["<name>"].mesh_motion.moving_mesh_velocity[<index>] (Object) (similarity: 98.31%)
36+
<solver_session>.setup.cell_zone_conditions.solid["<name>"].phase["<name>"].reference_frame.reference_frame_velocity[<index>] (Object) (similarity: 98.31%)
37+
<solver_session>.setup.cell_zone_conditions.solid["<name>"].phase["<name>"].solid_motion.solid_motion_velocity[<index>] (Object) (similarity: 98.31%)
38+
<solver_session>.setup.cell_zone_conditions.solid["<name>"].reference_frame.reference_frame_velocity[<index>] (Object) (similarity: 98.31%)
39+
<solver_session>.setup.cell_zone_conditions.solid["<name>"].solid_motion.solid_motion_velocity[<index>] (Object) (similarity: 98.31%)
40+
<solver_session>.setup.dynamic_mesh.dynamic_zones["<name>"].motion.rigid_body_properties.angular_velocity (Parameter) (similarity: 98.31%)
41+
<solver_session>.setup.dynamic_mesh.dynamic_zones["<name>"].motion.rigid_body_properties.cg_velocity (Parameter) (similarity: 98.31%)
42+
<solver_session>.setup.dynamic_mesh.options.in_cylinder.crank_shaft_speed (Parameter) (similarity: 98.31%)
43+
<solver_session>.setup.general.solver.velocity_formulation (Parameter) (similarity: 98.31%)
44+
<solver_session>.setup.materials.fluid["<name>"].premix_laminar_speed (Object) (similarity: 98.31%)
45+
<solver_session>.setup.materials.fluid["<name>"].speed_of_sound (Object) (similarity: 98.31%)
46+
<solver_session>.setup.materials.fluid["<name>"].velocity_accom_coefficient (Object) (similarity: 98.31%)
47+
<solver_session>.setup.materials.mixture["<name>"].premix_laminar_speed (Object) (similarity: 98.31%)
4848
...
4949
>>>
5050
>>> # Semantic search within a specific API object
5151
>>> pyfluent.search("load", api_path="<solver_session>.parallel.partition.set")
5252
<solver_session>.parallel.partition.set.dpm_load_balancing (Object) (similarity: 98.31%)
53-
<solver_session>.parallel.partition.set.dpm_load_balancing.interval (Parameter) (similarity: 98.31%)
5453
<solver_session>.parallel.partition.set.dpm_load_balancing.load_balancing (Parameter) (similarity: 98.31%)
55-
<solver_session>.parallel.partition.set.dpm_load_balancing.threshold (Parameter) (similarity: 98.31%)
5654
<solver_session>.parallel.partition.set.load_distribution (Parameter) (similarity: 98.31%)
5755
>>>
5856
>>> # Spanish semantic search
5957
>>> pyfluent.search("superficie", language="spa") # search 'surface' in Spanish
58+
<meshing_session>.PMFileManagement.File["<name>"].Options.Surface (Parameter) (similarity: 100.0%)
59+
<meshing_session>.meshing_utilities.get_face_zone_area (Query) (similarity: 100.0%)
60+
<meshing_session>.meshing_utilities.get_face_zones_by_zone_area (Query) (similarity: 100.0%)
61+
<meshing_session>.meshing_utilities.get_minsize_face_zone_by_area (Query) (similarity: 100.0%)
6062
<meshing_session>.preferences.Appearance.SurfaceEmissivity (Parameter) (similarity: 100.0%)
6163
<meshing_session>.preferences.Appearance.SurfaceSpecularity (Parameter) (similarity: 100.0%)
6264
<meshing_session>.preferences.Appearance.SurfaceSpecularityForContours (Parameter) (similarity: 100.0%)
@@ -66,32 +68,35 @@ Examples
6668
<solver_session>.design.geometry.parameterize_and_explore.design_change.history.surfaces (Parameter) (similarity: 100.0%)
6769
<solver_session>.design.geometry.parameterize_and_explore.design_change.preview.surfaces (Parameter) (similarity: 100.0%)
6870
...
69-
<solver_session>.setup.boundary_conditions.intake_fan["<name>"].multiphase.ht_bottom (Object) (similarity: 88.89%)
70-
<solver_session>.setup.boundary_conditions.intake_fan["<name>"].multiphase.ht_bottom.field_name (Parameter) (similarity: 88.89%)
71-
<solver_session>.setup.boundary_conditions.intake_fan["<name>"].multiphase.ht_bottom.option (Parameter) (similarity: 88.89%)
72-
<solver_session>.setup.boundary_conditions.intake_fan["<name>"].multiphase.ht_bottom.profile_name (Parameter) (similarity: 88.89%)
73-
<solver_session>.setup.boundary_conditions.intake_fan["<name>"].multiphase.ht_bottom.udf (Parameter) (similarity: 88.89%)
74-
<solver_session>.setup.boundary_conditions.intake_fan["<name>"].multiphase.ht_bottom.value (Parameter) (similarity: 88.89%)
71+
<solver_session>.mesh.modify_zones.create_periodic_interface (Command) (similarity: 94.12%)
72+
<solver_session>.mesh.polyhedra.options.preserve_interior_zones (Parameter) (similarity: 94.12%)
73+
<solver_session>.results.graphics.colors.interface_faces (Parameter) (similarity: 94.12%)
74+
<solver_session>.results.graphics.colors.interior_faces (Parameter) (similarity: 94.12%)
75+
<solver_session>.results.graphics.colors.rans_les_interface_faces (Parameter) (similarity: 94.12%)
76+
<solver_session>.results.graphics.particle_track["<name>"].filter_settings.options.inside (Parameter) (similarity: 94.12%)
77+
<solver_session>.results.graphics.particle_track["<name>"].filter_settings.options.outside (Parameter) (similarity: 94.12%)
78+
<solver_session>.results.surfaces.partition_surface["<name>"].interior_cell_faces (Parameter) (similarity: 94.12%)
79+
<solver_session>.setup.boundary_conditions.interface["<name>"] (Object) (similarity: 94.12%)
7580
...
76-
<solver_session>.setup.boundary_conditions.outlet_vent["<name>"].list (Command) (similarity: 85.71%)
77-
<solver_session>.setup.boundary_conditions.outlet_vent["<name>"].list_properties (Command) (similarity: 85.71%)
78-
<solver_session>.setup.boundary_conditions.outlet_vent["<name>"].make_a_copy (Command) (similarity: 85.71%)
79-
<solver_session>.setup.boundary_conditions.outlet_vent["<name>"].momentum (Object) (similarity: 85.71%)
81+
<solver_session>.setup.boundary_conditions.exhaust_fan["<name>"].structure.x_disp_boundary_condition (Parameter) (similarity: 85.71%)
82+
<solver_session>.setup.boundary_conditions.exhaust_fan["<name>"].structure.x_disp_boundary_value (Object) (similarity: 85.71%)
83+
<solver_session>.setup.boundary_conditions.exhaust_fan["<name>"].structure.y_disp_boundary_condition (Parameter) (similarity: 85.71%)
84+
<solver_session>.setup.boundary_conditions.exhaust_fan["<name>"].structure.y_disp_boundary_value (Object) (similarity: 85.71%)
85+
<solver_session>.setup.boundary_conditions.exhaust_fan["<name>"].structure.z_disp_boundary_condition (Parameter) (similarity: 85.71%)
86+
<solver_session>.setup.boundary_conditions.exhaust_fan["<name>"].structure.z_disp_boundary_value (Object) (similarity: 85.71%)
8087
...
81-
<solver_session>.results.graphics.pathline["<name>"].axes.rules.x_axis.major_rule_line_color (Parameter) (similarity: 83.33%)
82-
<solver_session>.results.graphics.pathline["<name>"].axes.rules.x_axis.major_rule_weight (Parameter) (similarity: 83.33%)
83-
<solver_session>.results.graphics.pathline["<name>"].axes.rules.x_axis.minor_rule_line_color (Parameter) (similarity: 83.33%)
84-
<solver_session>.results.graphics.pathline["<name>"].axes.rules.x_axis.minor_rule_weight (Parameter) (similarity: 83.33%)
85-
<solver_session>.results.graphics.pathline["<name>"].axes.rules.y_axis.major_rule_line_color (Parameter) (similarity: 83.33%)
86-
<solver_session>.results.graphics.pathline["<name>"].axes.rules.y_axis.major_rule_weight (Parameter) (similarity: 83.33%)
87-
<solver_session>.results.graphics.pathline["<name>"].axes.rules.y_axis.minor_rule_line_color (Parameter) (similarity: 83.33%)
88+
<solver_session>.results.graphics.pathline["<name>"].style_attributes.range_sphere (Object) (similarity: 83.33%)
89+
<solver_session>.results.graphics.pathline["<name>"].style_attributes.sphere_detail_lod (Parameter) (similarity: 83.33%)
90+
<solver_session>.results.graphics.pathline["<name>"].style_attributes.sphere_lod (Parameter) (similarity: 83.33%)
91+
<solver_session>.results.graphics.pathline["<name>"].style_attributes.sphere_scale (Parameter) (similarity: 83.33%)
92+
<solver_session>.results.graphics.pathline["<name>"].style_attributes.sphere_size (Parameter) (similarity: 83.33%)
8893
...
89-
<solver_session>.setup.physics.volumes.solid["<name>"].boundaries.pressure_outlet["<name>"].settings.species.tss_scalar["<name>"].profile_name (Parameter) (similarity: 82.35%)
90-
<solver_session>.setup.physics.volumes.solid["<name>"].boundaries.pressure_outlet["<name>"].settings.structure.x_disp_boundary_value.profile_name (Parameter) (similarity: 82.35%)
91-
<solver_session>.setup.physics.volumes.solid["<name>"].boundaries.pressure_outlet["<name>"].settings.structure.y_disp_boundary_value.profile_name (Parameter) (similarity: 82.35%)
92-
<solver_session>.setup.physics.volumes.solid["<name>"].boundaries.pressure_outlet["<name>"].settings.structure.z_disp_boundary_value.profile_name (Parameter) (similarity: 82.35%)
93-
<solver_session>.setup.physics.volumes.solid["<name>"].boundaries.pressure_outlet["<name>"].settings.thermal.backflow_total_temperature.profile_name (Parameter) (similarity: 82.35%)
94-
<solver_session>.setup.physics.volumes.solid["<name>"].boundaries.pressure_outlet["<name>"].settings.turbulence.backflow_intermittency.profile_name (Parameter) (similarity: 82.35%)
94+
<solver_session>.setup.profiles.display_profile_point_cloud_data (Command) (similarity: 82.35%)
95+
<solver_session>.setup.profiles.display_profile_surface (Command) (similarity: 82.35%)
96+
<solver_session>.setup.profiles.list_profile_fields (Command) (similarity: 82.35%)
97+
<solver_session>.setup.profiles.list_profile_parameters (Command) (similarity: 82.35%)
98+
<solver_session>.setup.profiles.list_profile_parameters_with_value (Command) (similarity: 82.35%)
99+
<solver_session>.setup.profiles.list_profiles (Command) (similarity: 82.35%)
95100
...
96101
>>>
97102
>>> # Chinese semantic search within a specific API object
@@ -121,16 +126,21 @@ Examples
121126
>>>
122127
>>> # Wildcard pattern search
123128
>>> pyfluent.search("local*")
124-
<solver_session>.solution.controls.advanced.expert.pseudo_time_method_usage.local_dt["<name>"] (Object)
125-
<solver_session>.solution.controls.advanced.expert.pseudo_time_method_usage.local_dt["<name>"].create (Command)
126-
<solver_session>.solution.controls.advanced.expert.pseudo_time_method_usage.local_dt["<name>"].delete (Command)
127-
<solver_session>.solution.controls.advanced.expert.pseudo_time_method_usage.local_dt["<name>"].enable_pseudo_time_method (Parameter)
128-
<solver_session>.solution.controls.advanced.expert.pseudo_time_method_usage.local_dt["<name>"].implicit_under_relaxation_factor (Parameter)
129-
<solver_session>.solution.controls.advanced.expert.pseudo_time_method_usage.local_dt["<name>"].list (Command)
130-
<solver_session>.solution.controls.advanced.expert.pseudo_time_method_usage.local_dt["<name>"].list_properties (Command)
131-
<solver_session>.solution.controls.advanced.expert.pseudo_time_method_usage.local_dt["<name>"].make_a_copy (Command)
132-
<solver_session>.solution.controls.advanced.expert.pseudo_time_method_usage.local_dt["<name>"].pseudo_time_scale_factor (Parameter)
133-
<solver_session>.solution.controls.advanced.expert.pseudo_time_method_usage.local_dt["<name>"].rename (Command)
129+
<solver_session>.setup.dynamic_mesh.methods.smoothing.radial_settings.local_smoothing (Parameter)
130+
<solver_session>.setup.mesh_interfaces.interface["<name>"].local_absolute_mapped_tolerance (Parameter)
131+
<solver_session>.setup.mesh_interfaces.interface["<name>"].local_relative_mapped_tolerance (Parameter)
132+
<solver_session>.setup.models.species.nox.turbulence_interaction.local_tmax_factor (Parameter)
133+
<solver_session>.solution.controls.pseudo_time_explicit_relaxation_factor.local_dt_dualts_relax["<name>"] (Object)
134+
<solver_session>.solution.controls.zonal_pbns_solution_controls.local_dt_verbosity (Parameter)
135+
<solver_session>.solution.initialization.localized_turb_init (Object)
136+
<meshing_session>.tui.boundary.modify.local_remesh (Command)
137+
<meshing_session>.tui.boundary.refine.local_regions (Object)
138+
<meshing_session>.tui.boundary.separate.local_regions (Object)
139+
<meshing_session>.tui.mesh.hexcore.local_regions (Object)
140+
<meshing_session>.tui.mesh.poly.local_regions (Object)
141+
<meshing_session>.tui.mesh.separate.local_regions (Object)
142+
<meshing_session>.tui.mesh.tet.local_regions (Object)
143+
<meshing_session>.tui.preferences.simulation.local_residual_scaling (Command)
134144
...
135145
>>>
136146
>> # Wildcard pattern search within a specific API object
@@ -142,7 +152,7 @@ Examples
142152
>>>
143153
>>> # Misspelled search
144154
>>> pyfluent.search("cfb_lma")
145-
<solver_session>.setup.models.viscous.geko_options.cbf_lam (Parameter)
155+
<solver_session>.setup.models.viscous.geko.auxiliary_constants.cbf_lam (Parameter)
146156
<solver_session>.tui.define.models.viscous.geko_options.cbf_lam (Command)
147157
>>>
148158

0 commit comments

Comments
 (0)