Adding some more user guide examples

doc/source/user_guide/boundary_conditions.rst

@@ -1,51 +1,142 @@
 Defining Boundary Conditions
 ============================
-PyFluent supports defining boundary conditions using the TUI API and :ref:`ref_settings`.
 
 Text User Interface (TUI) API
 -----------------------------
 The following example demonstrates how you can define boundary conditions using
 the TUI API:
 
+Defining Boundary Conditions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+define/boundary-conditions TUI: Enters the boundary conditions menu.
+
 .. code:: python
 
+    import ansys.fluent.core as pyfluent
+    session = pyfluent.launch_fluent(precision='double', processor_count=2)
+    session.solver.tui.file.read_case(case_file_name='file.cas.h5')
     session.solver.tui.define.boundary_conditions.set.velocity_inlet(
-        "cold-inlet", [], "vmag", "no", 0.4, "quit"
+        'cold-inlet',
+        [],
+        'vmag',
+        'no',
+        0.4,
+        'quit'
     )
     session.solver.tui.define.boundary_conditions.set.velocity_inlet(
-        "cold-inlet", [], "ke-spec", "no", "no", "no", "yes", "quit"
+        'cold-inlet',
+        [],
+        'ke-spec',
+        'no',
+        'no',
+        'no',
+        'yes',
+        'quit'
     )
     session.solver.tui.define.boundary_conditions.set.velocity_inlet(
-        "cold-inlet", [], "turb-intensity", 5, "quit"
+        'cold-inlet',
+        [],
+        'turb-intensity',
+        5,
+        'quit'
     )
     session.solver.tui.define.boundary_conditions.set.velocity_inlet(
-        "cold-inlet", [], "turb-hydraulic-diam", 4, "quit"
+        'cold-inlet',
+        [],
+        'turb-hydraulic-diam',
+        4,
+        'quit'
     )
     session.solver.tui.define.boundary_conditions.set.velocity_inlet(
-        "cold-inlet", [], "temperature", "no", 293.15, "quit"
+        'cold-inlet',
+        [],
+        'temperature',
+        'no',
+        293.15,
+        'quit'
+    )
+
+Copying Boundary Conditions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+define/boundary-conditions/copy-bc TUI: Copies boundary conditions to other zones.
+
+.. code:: python
+
+    session.solver.tui.define.boundary_conditions.copy_bc('cold-inlet','hot-inlet','()')
+
+Listing Zones
+~~~~~~~~~~~~~
+define/boundary-conditions/list-zones TUI: Prints out the types and IDs of all
+zones in the console window.
+
+.. code:: python
+
+    session.solver.tui.define.boundary_conditions.list_zones()
+
+Modifying Cell Zone Conditions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+    #Enabling Laminar Zone
+    session.solver.tui.define.boundary_conditions.fluid(
+        'elbow-fluid',
+        'no',
+        'no',
+        'no',
+        'no',
+        'no',
+        0,
+        'no',
+        0,
+        'no',
+        0,
+        'no',
+        0,
+        'no',
+        0,
+        'no',
+        1,
+        'no',
+        'yes',
+        'yes',
+        'no',
+        'no',
+        'no'
     )
 
 Settings Objects
 ----------------
 The following example demonstrates how you can define boundary conditions using
 :ref:`ref_settings`:
 
+Defining Boundary Conditions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 .. code:: python
 
-    session.solver.root.setup.boundary_conditions.velocity_inlet["cold-inlet"].vmag = {
-        "option": "constant or expression",
-        "constant": 0.4,
+    session.solver.root.setup.boundary_conditions.velocity_inlet['cold-inlet'].vmag = {
+        'option': 'constant or expression',
+        'constant': 0.4,
     }
     session.solver.root.setup.boundary_conditions.velocity_inlet[
-        "cold-inlet"
-    ].ke_spec = "Intensity and Hydraulic Diameter"
+        'cold-inlet'
+    ].ke_spec = 'Intensity and Hydraulic Diameter'
     session.solver.root.setup.boundary_conditions.velocity_inlet[
-        "cold-inlet"
+        'cold-inlet'
     ].turb_intensity = 5
     session.solver.root.setup.boundary_conditions.velocity_inlet[
-        "cold-inlet"
-    ].turb_hydraulic_diam = "4 [in]"
-    session.solver.root.setup.boundary_conditions.velocity_inlet["cold-inlet"].t = {
-        "option": "constant or expression",
-        "constant": 293.15,
-    }
+        'cold-inlet'
+    ].turb_hydraulic_diam = '4 [in]'
+    session.solver.root.setup.boundary_conditions.velocity_inlet['cold-inlet'].t = {
+        'option': 'constant or expression',
+        'constant': 293.15,
+    }
+
+Modifying Cell Zone Conditions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+    #Enabling Laminar Zone
+    session.solver.root.setup.cell_zone_conditions.fluid['elbow-fluid'] = {'laminar' : True}

doc/source/user_guide/general_settings.rst

@@ -1,13 +1,50 @@
 Applying General Settings
 =========================
-PyFluent supports defining general settings using the TUI API and
-:ref:`ref_settings`.
 
 Text User Interface (TUI) API
 -----------------------------
-The following example demonstrates how you can define units using
-the TUI API:
+The following examples demonstrate how you can use solver meshing commands
+and setup units using the TUI API:
+
+Checking Mesh
+~~~~~~~~~~~~~
+mesh/check TUI: Performs various mesh consistency checks and displays a
+report in the console that lists the domain extents, the volume statistics,
+the face area statistics, and any warnings, as well as details about the
+various checks and mesh failures (depending on the setting specified for
+mesh/check-verbosity).
+
+.. code:: python
+
+    import ansys.fluent.core as pyfluent
+    session = pyfluent.launch_fluent(precision='double', processor_count=2)
+    session.solver.tui.file.read_case(case_file_name='file.cas.h5')
+    session.solver.tui.mesh.check()
+
+Reporting Mesh Quality
+~~~~~~~~~~~~~~~~~~~~~~
+mesh/quality TUI: Displays information about the quality of the mesh in the
+console, including the minimum orthogonal quality and the maximum aspect ratio.
+The level of detail displayed depends on the setting specified for
+mesh/check-verbosity.
+
+.. code:: python
+
+    session.solver.tui.mesh.quality()
+
+Scaling Mesh
+~~~~~~~~~~~~
+mesh/scale TUI: Prompts for the scaling factors in each of the active Cartesian
+coordinate directions.
+
+.. code:: python
+
+    session.solver.tui.mesh.scale(1,1,1)
+
+Defining Units
+~~~~~~~~~~~~~~
+define/units TUI: Sets unit conversion factors.
 
 .. code:: python
 
-    session.solver.tui.define.units("length", "in")
+    session.solver.tui.define.units('length', 'in')

doc/source/user_guide/launching_ansys_fluent.rst

@@ -38,23 +38,23 @@ The following example demonstrates how you can select double precision in soluti
 
 .. code:: python
 
-   solver_session = pyfluent.launch_fluent(precision="double")
+   solver_session = pyfluent.launch_fluent(precision='double')
 
 Dimension
 ~~~~~~~~~
 The following example demonstrates how you can select double precision and 2D in solution mode:
 
 .. code:: python
 
-   solver_session = pyfluent.launch_fluent(precision="double", version="2d")
+   solver_session = pyfluent.launch_fluent(precision='double', version='2d')
 
 Number of Processors
 ~~~~~~~~~~~~~~~~~~~~
 The following example demonstrates how you can select the number of processors:
 
 .. code:: python
 
-   solver_session = pyfluent.launch_fluent(precision="double", version="2d", processor_count=2)
+   solver_session = pyfluent.launch_fluent(precision='double', version='2d', processor_count=2)
 
 API Reference
 -------------

doc/source/user_guide/materials.rst

@@ -1,40 +1,43 @@
 Defining Materials
 ==================
-PyFluent supports defining materials using the TUI API and 
-:ref:`ref_settings`.
 
 Text User Interface (TUI) API
 -----------------------------
 The following example demonstrates how you can define materials using
 the TUI API:
 
+define/materials TUI: Enters the materials menu.
+
 .. code:: python
 
-    session.solver.tui.define.materials.copy("fluid", "water-liquid")
+    import ansys.fluent.core as pyfluent
+    session = pyfluent.launch_fluent(precision='double', processor_count=2)
+    session.solver.tui.file.read_case(case_file_name='file.cas.h5')
+    session.solver.tui.define.materials.copy('fluid', 'water-liquid')
     session.solver.tui.define.boundary_conditions.fluid(
-        "elbow-fluid",
-        "yes",
-        "water-liquid",
-        "no",
-        "no",
-        "no",
-        "no",
-        "0",
-        "no",
-        "0",
-        "no",
-        "0",
-        "no",
-        "0",
-        "no",
-        "0",
-        "no",
-        "1",
-        "no",
-        "no",
-        "no",
-        "no",
-        "no",
+        'elbow-fluid',
+        'yes',
+        'water-liquid',
+        'no',
+        'no',
+        'no',
+        'no',
+        '0',
+        'no',
+        '0',
+        'no',
+        '0',
+        'no',
+        '0',
+        'no',
+        '0',
+        'no',
+        '1',
+        'no',
+        'no',
+        'no',
+        'no',
+        'no',
     )
 
 Settings Objects
@@ -44,5 +47,5 @@ The following example demonstrates how you can define materials using
 
 .. code:: python
 
-    session.solver.root.setup.materials.copy_database_material_by_name(type="fluid", name="water-liquid")
-    session.solver.root.setup.cell_zone_conditions.fluid["elbow-fluid"].material = "water-liquid"
+    session.solver.root.setup.materials.copy_database_material_by_name(type='fluid', name='water-liquid')
+    session.solver.root.setup.cell_zone_conditions.fluid['elbow-fluid'].material = 'water-liquid'