Issue 666: Improve User Guide for TUI Commands and Python Equivalents

doc/source/user_guide/boundary_conditions.rst

@@ -10,8 +10,16 @@ and modify cell zone conditions using :ref:`ref_solver_tui_commands`.
 
 Defining boundary conditions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The ``define.boundary_counditions.set.velocity_inlet`` TUI command defines velocity
-boundary conditions at inlets.
+The following example shows a comparison between the TUI command and the
+python code for defining velocity boundary conditions at inlets.
+
+TUI command
+
+.. code:: scheme
+
+    /define/boundary-counditions/set/velocity-inlet
+
+Python code
 
 .. code:: python
 
@@ -61,25 +69,51 @@ boundary conditions at inlets.
 
 Copying boundary conditions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The ``define.boundary_conditions.copy_bc`` TUI command copies boundary conditions
-to other zones.
+The following example shows a comparison between the TUI command and the
+python code for copying boundary conditions to other zones.
+
+TUI command
+
+.. code:: scheme
+
+    /define/boundary-conditions/copy-bc
+
+Python command
 
 .. code:: python
 
     session.solver.tui.define.boundary_conditions.copy_bc('cold-inlet','hot-inlet','()')
 
 Listing zones
 ~~~~~~~~~~~~~
-The ``define.boundary_conditions.list_zones`` TUI command prints in the Fluent console
-the types and IDs of all zones.
+The following example shows a comparison between the TUI command and the
+python code for printing the types and IDs of all zones in the Fluent
+console.
+
+TUI command
+
+.. code:: scheme
+
+    /define/boundary-conditions/list-zones
+
+Python command
 
 .. code:: python
 
     session.solver.tui.define.boundary_conditions.list_zones()
 
 Modifying cell zone conditions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The ``define.boundary_conditions.fluid`` TUI command modifies cell zone conditions.
+The following example shows a comparison between the TUI command and the
+python code for modifying cell zone conditions.
+
+TUI command
+
+.. code:: scheme
+
+    /define/boundary-conditions/fluid
+
+Python command
 
 .. code:: python
 

doc/source/user_guide/general_settings.rst

@@ -8,11 +8,19 @@ and set up units using :ref:`ref_solver_tui_commands`.
 
 Checking the mesh
 -----------------
-The ``mesh.check`` TUI performs various mesh consistency checks and displays a
+The following example shows a comparison between the TUI command and the
+python code for performing various mesh consistency checks and displays a
 report in the console that lists domain extents, volume statistics,
 face area statistics, any warnings, and information about various check and mesh
-failures. THe level of information shown depends on the setting specified for
-``mesh.check-verbosity``.
+failures.
+
+TUI command
+
+.. code:: scheme
+
+    /mesh/check
+
+Python command
 
 .. code:: python
 
@@ -23,27 +31,52 @@ failures. THe level of information shown depends on the setting specified for
 
 Reporting mesh quality
 ----------------------
-The ``mesh.quality`` TUI displays information about the quality of the mesh in the
+The following example shows a comparison between the TUI command and the
+python code for displaying information about the quality of the mesh in the
 console, including the minimum orthogonal quality and maximum aspect ratio.
-The level of information that is shown depends on the setting specified for
-``mesh.check-verbosity``.
+
+TUI command
+
+.. code:: scheme
+
+    /mesh/quality
+
+Python command
 
 .. code:: python
 
     session.solver.tui.mesh.quality()
 
 Scaling mesh
 ------------
-The ``mesh.scale`` TUI prompts for the scaling factors in each of the active Cartesian
+The following example shows a comparison between the TUI command and the
+python code for the scaling factors in each of the active Cartesian
 coordinate directions.
 
+TUI command
+
+.. code:: scheme
+
+    /mesh/scale 1 1 1
+
+Python command
+
 .. code:: python
 
     session.solver.tui.mesh.scale(1,1,1)
 
 Defining units
 --------------
-The ``define.units`` TUI sets unit conversion factors.
+The following example shows a comparison between the TUI command and the
+python code for the setting unit conversion factors.
+
+TUI command
+
+.. code:: scheme
+
+    /define/units length 'in'
+
+Python command
 
 .. code:: python
 

doc/source/user_guide/materials.rst

@@ -5,10 +5,16 @@ PyFluent supports defining materials using :ref:`ref_solver_tui_commands` and
 
 Using solver TUI commands
 -------------------------
-This example shows how you define materials using
-:ref:`ref_solver_tui_commands`.
+The following example shows a comparison between the TUI command and the
+python code for defining materials.
+
+TUI command
+
+.. code:: scheme
+
+    /define/materials
 
-The ``define.materials`` TUI enters the materials menu.
+Python command
 
 .. code:: python
 

doc/source/user_guide/models.rst

@@ -8,7 +8,16 @@ The following examples show how you define models using :ref:`ref_solver_tui_com
 
 Enabling the energy model
 ~~~~~~~~~~~~~~~~~~~~~~~~~
-The ``define.models.energy`` TUI enables and disables the energy model.
+The following example shows a comparison between the TUI command and the
+python code for enabling and disabling the energy model.
+
+TUI command
+
+.. code:: scheme
+
+    /define/models/energy yes no no no yes
+
+Python command
 
 .. code:: python
 
@@ -19,12 +28,18 @@ The ``define.models.energy`` TUI enables and disables the energy model.
 
 Enabling the viscous model
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
-The ``define.models.viscous.laminar`` TUI enables and disables the laminar flow model.
+The following example shows a comparison between the TUI command and the
+python code for enabling and disabling the various viscous models.
 
-The ``define.models.viscous.kw_sst`` TUI enables and disables the SST-kw turbulence model.
+TUI command
 
-The ``define.models.viscous.ke_standard`` TUI enables and disables the standard-ke
-turbulence model.
+.. code:: scheme
+
+    /define/models/viscous/laminar yes
+    /define/models/viscous/kw-sst yes
+    /define/models/viscous/ke-standard yes
+
+Python command
 
 .. code:: python
 
@@ -34,7 +49,17 @@ turbulence model.
 
 Enabling the radiation model
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The ``define.models.radiation`` TUI provides options for selecting different radiation models.
+The following example shows a comparison between the TUI command and the
+python code for selecting different radiation models.
+
+TUI command
+
+.. code:: scheme
+
+    /define/models/radiation/s2s yes
+    /define/models/radiation/p1 yes
+
+Python command
 
 .. code:: python
 
@@ -43,7 +68,19 @@ The ``define.models.radiation`` TUI provides options for selecting different rad
 
 Enabling the multiphase model
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The ``define.models.multiphase`` TUI provides options for selecting different multiphase models.
+The following example shows a comparison between the TUI command and the
+python code for selecting different multiphase models.
+
+TUI command
+
+.. code:: scheme
+
+    /define/models/multiphase/model vof
+    /define/models/multiphase/model eulerian
+    /define/models/multiphase/model mixture
+    /define/models/multiphase/model wetsteam
+
+Python command
 
 .. code:: python
 

doc/source/user_guide/solution.rst

@@ -11,11 +11,20 @@ using :ref:`ref_solver_tui_commands`.
 
 Selecting solution methods 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
-The ``solve.set.p_v_coupling`` TUI command selects which pressure-velocity coupling scheme to use.
-Five schemes (Index-Model) are available: 20-SIMPLE, 21-SIMPLEC, 22-PISO, 24-Coupled,
-and 25-Fractional Step.
+The following example shows a comparison between the TUI command and the
+python code for selecting the pressure velocity coupling scheme and setting
+the gradient options. Five schemes (Index-Model) are available:
+20-SIMPLE, 21-SIMPLEC, 22-PISO, 24-Coupled, and 25-Fractional Step.
 
-The ``solve.set/gradient_scheme`` TUI sets the gradient options.
+TUI command
+
+.. code:: scheme
+
+    /solve/set/p-v-coupling 24
+    /solve/set/gradient-scheme yes
+    /solve/set/gradient-scheme no yes 
+
+Python command
 
 .. code:: python
 
@@ -28,15 +37,33 @@ The ``solve.set/gradient_scheme`` TUI sets the gradient options.
 
 Selecting solution controls 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The ``solve.set.p_v_controls`` TUI sets pressure-velocity controls.
+The following example shows a comparison between the TUI command and the
+python code for selecting the pressure velocity controls.
+
+TUI command
+
+.. code:: scheme
+
+    /solve/set/p-v-controls 0.3 0.4
+
+Python command
 
 .. code:: python
 
     session.solver.tui.solve.set.p_v_controls(0.3,0.4) # Momentum and Pressure
 
 Creating report definitions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The ``solve.report_definitions`` TUI enters the report definitions menu.
+The following example shows a comparison between the TUI command and the
+python code for report definitions.
+
+TUI command
+
+.. code:: scheme
+
+    /solve/report-definitions
+
+Python command
 
 .. code:: python
 
@@ -53,12 +80,17 @@ The ``solve.report_definitions`` TUI enters the report definitions menu.
 
 Initializing and solving 
 ~~~~~~~~~~~~~~~~~~~~~~~~
-The ``solve.initialize`` TUI enters the flow initialization menu.
+The following example shows a comparison between the TUI command and the
+python code for initialization and performing a specified number of iterations.
+
+TUI command
+
+.. code:: scheme
 
-The ``solve.initialize.hyb_initialization`` TUI initializes using the hybrid
-initialization method.
+    /solve/initialize/hyb-initialization
+    /solve/iterate 100
 
-The ``solve.iterate`` TUI performs a specified number of iterations.
+Python command
 
 .. code:: python