Skip to content

Update API hierarchy #405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 13, 2022
Merged

Update API hierarchy #405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,10 @@ You can run Fluent TUI commands using the ``session.tui`` interface:

.. code:: python

session.tui.solver.file.read_case(case_file_name='elbow.cas.h5')
session.tui.solver.define.models.unsteady_2nd_order("yes")
session.tui.solver.solve.initialize.initialize_flow()
session.tui.solver.solve.dual_time_iterate(2, 3)
session.solver.tui.file.read_case(case_file_name='elbow.cas.h5')
session.solver.tui.define.models.unsteady_2nd_order("yes")
session.solver.tui.solve.initialize.initialize_flow()
session.solver.tui.solve.dual_time_iterate(2, 3)

In addition to all TUI commands being available there are the ``parametric`` and
``post`` packages. The ``parametric`` package provides access to Fluent's
Expand Down
14 changes: 7 additions & 7 deletions doc/source/api/core/meshing/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ Workflow Example
import ansys.fluent.core as pyfluent
session = pyfluent.launch_fluent(meshing_mode=True)
session.start_transcript()
session.workflow.InitializeWorkflow(WorkflowType='Watertight Geometry')
session.workflow.TaskObject['Import Geometry'].Arguments = dict(FileName='cylinder.agdb')
session.workflow.TaskObject['Import Geometry'].Execute()
session.tui.meshing.mesh.check_mesh()
session.meshing.workflow.InitializeWorkflow(WorkflowType='Watertight Geometry')
session.meshing.workflow.TaskObject['Import Geometry'].Arguments = dict(FileName='cylinder.agdb')
session.meshing.workflow.TaskObject['Import Geometry'].Execute()
session.meshing.tui.mesh.check_mesh()
exit()

TUI Commands Example
Expand All @@ -26,9 +26,9 @@ TUI Commands Example

import ansys.fluent.core as pyfluent
session = pyfluent.launch_fluent(meshing_mode=True)
session.tui.meshing.file.read_case("elbow.cas.gz")
session.tui.meshing.switch_to_solution_mode("yes")
session.tui.solver.define.models.unsteady_2nd_order("yes")
session.meshing.tui.file.read_case("elbow.cas.gz")
session.meshing.tui.switch_to_solution_mode("yes")
session.solver.tui.define.models.unsteady_2nd_order("yes")
exit()

.. currentmodule:: ansys.fluent.core.meshing
Expand Down
11 changes: 5 additions & 6 deletions doc/source/api/core/solver/settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,17 @@ issue commands with a hierarchy of objects.
Top-level Objects
-----------------

The top-level settings object can be accessed by executing the
``get_settings_root`` method on a session object.
The top-level settings object is available as the ``root`` property of session.solver.

.. code-block::

>>> import ansys.fluent.core as pyfluent
>>> session = pyfluent.launch_fluent()
>>> root = session.get_settings_root()
>>> root = session.solver.root

The root object contains attributes such as ``file``, ``setup``, ``solution``
and ``results``. These objects are also instances of 'settings' objects and
roughly mirror the outline view in Fluent.
The root object contains attributes such as ``file``, ``setup``,
``solution`` and ``results``. These objects are also instances of 'settings'
objects and roughly mirror the outline view in Fluent.

Types of Settings Objects
-------------------------
Expand Down
16 changes: 8 additions & 8 deletions doc/source/api/post/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ written to a file using standard Fluent commands.

.. code:: python

session.tui.solver.display.objects.contour['contour-1'] = {'boundary_values': True, 'color_map': {'color': 'field-velocity', 'font_automatic': True, 'font_name': 'Helvetica', 'font_size': 0.032, 'format': '%0.2e', 'length': 0.54, 'log_scale': False, 'position': 1, 'show_all': True, 'size': 100, 'user_skip': 9, 'visible': True, 'width': 6.0}, 'coloring': {'smooth': False}, 'contour_lines': False, 'display_state_name': 'None', 'draw_mesh': False, 'field': 'pressure', 'filled': True, 'mesh_object': '', 'node_values': True, 'range_option': {'auto_range_on': {'global_range': True}}, 'surfaces_list': [2, 5]}
session.tui.solver.display.objects.contour['contour-1']()
session.tui.solver.display.objects.contour['contour-1'].field.set_state('velocity-magnitude')
session.tui.solver.display.objects.contour['contour-1'].field()
session.tui.solver.display.objects.contour['contour-1'].color_map.size.set_state(80.0)
session.tui.solver.display.objects.contour['contour-1'].color_map.size()
session.tui.solver.display.objects.contour['contour-1'].rename('my-contour')
del session.tui.solver.display.objects.contour['my-contour']
session.solver.tui.display.objects.contour['contour-1'] = {'boundary_values': True, 'color_map': {'color': 'field-velocity', 'font_automatic': True, 'font_name': 'Helvetica', 'font_size': 0.032, 'format': '%0.2e', 'length': 0.54, 'log_scale': False, 'position': 1, 'show_all': True, 'size': 100, 'user_skip': 9, 'visible': True, 'width': 6.0}, 'coloring': {'smooth': False}, 'contour_lines': False, 'display_state_name': 'None', 'draw_mesh': False, 'field': 'pressure', 'filled': True, 'mesh_object': '', 'node_values': True, 'range_option': {'auto_range_on': {'global_range': True}}, 'surfaces_list': [2, 5]}
session.solver.tui.display.objects.contour['contour-1']()
session.solver.tui.display.objects.contour['contour-1'].field.set_state('velocity-magnitude')
session.solver.tui.display.objects.contour['contour-1'].field()
session.solver.tui.display.objects.contour['contour-1'].color_map.size.set_state(80.0)
session.solver.tui.display.objects.contour['contour-1'].color_map.size()
session.solver.tui.display.objects.contour['contour-1'].rename('my-contour')
del session.solver.tui.display.objects.contour['my-contour']

PyVista Example (Graphics)
--------------------------
Expand Down
8 changes: 4 additions & 4 deletions doc/source/getting_started/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,10 @@ solver:

.. code:: python

session.tui.solver.file.read_case(case_file_name='elbow.cas.h5')
session.tui.solver.define.models.unsteady_2nd_order("yes")
session.tui.solver.solve.initialize.initialize_flow()
session.tui.solver.solve.dual_time_iterate(2, 3)
session.solver.tui.file.read_case(case_file_name='elbow.cas.h5')
session.solver.tui.define.models.unsteady_2nd_order("yes")
session.solver.tui.solve.initialize.initialize_flow()
session.solver.tui.solve.dual_time_iterate(2, 3)

In addition to all TUI commands being available there are the ``parametric`` and
``post`` packages. The ``parametric`` package provides access to Fluent's
Expand Down
3 changes: 1 addition & 2 deletions doc/source/users_guide/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,7 @@ Fluent capabilities.

.. code::

settings = session.get_settings_root()
settings.setup.models.energy.enabled = True
session.solver.root.setup.models.energy.enabled = True

+ The 'datamodel' module is a Python interface to access the
datamodel-driven aspects of Fluent, such as the meshing workflows.
Expand Down
Loading