Skip to content

Commit

Permalink
docs: update to docs for Solver Settings Objects (#3580)
Browse files Browse the repository at this point in the history
* no newline in report_definitions and replace root

* replace last root

* replace zone_names
  • Loading branch information
millerj97 authored Dec 19, 2024
1 parent 70774ba commit e570545
Showing 1 changed file with 6 additions and 12 deletions.
18 changes: 6 additions & 12 deletions doc/source/user_guide/solver_settings/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -244,28 +244,22 @@ These examples accesses the list of zone surfaces:

.. code-block::
>>> root.solution.report_definitions.flux["mass_flow_rate"] = {}
>>> root.solution.report_definitions.flux[
"mass_flow_rate"
].zone_names.allowed_values()
>>> solver.settings.solution.report_definitions.flux["mass_flow_rate"] = {}
>>> solver.settings.solution.report_definitions.flux["mass_flow_rate"].boundaries.allowed_values()
['symmetry-xyplane', 'hot-inlet', 'cold-inlet', 'outlet', 'wall-inlet', 'wall-elbow', 'interior--elbow-fluid']
.. code-block::
>>> root.solution.report_definitions.flux["mass_flow_rate"] = {}
>>> root.solution.report_definitions.flux[
"mass_flow_rate"
].zone_names.get_attr("allowed-values")
>>> solver.settings.solution.report_definitions.flux["mass_flow_rate"] = {}
>>> solver.settings.solution.report_definitions.flux["mass_flow_rate"].boundaries.get_attr("allowed-values")
['symmetry-xyplane', 'hot-inlet', 'cold-inlet', 'outlet', 'wall-inlet', 'wall-elbow', 'interior--elbow-fluid']
.. code-block::
>>> root.solution.report_definitions.flux["mass_flow_rate"] = {}
>>> root.solution.report_definitions.flux[
"mass_flow_rate"
].zone_names.get_attrs(["allowed-values"])
>>> solver.settings.solution.report_definitions.flux["mass_flow_rate"] = {}
>>> solver.settings.solution.report_definitions.flux["mass_flow_rate"].boundaries.get_attrs(["allowed-values"])
{'allowed-values': ['symmetry-xyplane', 'hot-inlet', 'cold-inlet', 'outlet', 'wall-inlet', 'wall-elbow', 'interior--elbow-fluid']}
Expand Down

0 comments on commit e570545

Please sign in to comment.