build: Release updated doc for v0.30 (#3878)

Update docs in the stable release.

---------

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: prmukherj

doc/changelog.d/3874.documentation.md

@@ -0,0 +1 @@
+Update enhanced meshing workflow docs.

doc/source/cheatsheet/cheat_sheet.qmd

@@ -136,12 +136,9 @@ wt.update_regions()
 
 ```{python}
 wt.add_boundary_layer.add_child_to_task()
+wt.add_boundary_layer.bl_control_name.set_state("smooth-transition_1")
 wt.add_boundary_layer.insert_compound_child_task()
-wt.task("smooth-transition_1"
-    ).bl_control_name.set_state(
-    "smooth-transition_1")
-wt.add_boundary_layer.arguments = {}
-wt.task("smooth-transition_1")()
+wt.add_boundary_layer_child_1()
 ```
 
 ### Generate volume mesh

doc/source/user_guide/meshing/new_meshing_workflows.rst

@@ -78,10 +78,9 @@ Add boundary layers
 .. code:: python
 
     watertight.add_boundary_layer.add_child_to_task()
+    watertight.add_boundary_layer.bl_control_name.set_state("smooth-transition_1")
     watertight.add_boundary_layer.insert_compound_child_task()
-    watertight.task("smooth-transition_1").bl_control_name.set_state("smooth-transition_1")
-    watertight.add_boundary_layer.arguments = {}
-    watertight.task("smooth-transition_1")()
+    watertight.add_boundary_layer_child_1()
 
 Generate volume mesh
 ~~~~~~~~~~~~~~~~~~~~
@@ -144,11 +143,6 @@ Describe geometry and flow
 
 .. code:: python
 
-    fault_tolerant.describe_geometry_and_flow.add_enclosure.set_state("No")
-    fault_tolerant.describe_geometry_and_flow.close_caps.set_state("Yes")
-    fault_tolerant.describe_geometry_and_flow.flow_type.set_state("Internal flow through the object")
-    fault_tolerant.describe_geometry_and_flow.update_child_tasks(setup_type_changed=False)
-
     fault_tolerant.describe_geometry_and_flow.add_enclosure.set_state("No")
     fault_tolerant.describe_geometry_and_flow.close_caps.set_state("Yes")
     fault_tolerant.describe_geometry_and_flow.describe_geometry_and_flow_options.advanced_options.set_state(True)
@@ -163,172 +157,67 @@ Enclose fluid regions (capping)
 .. code:: python
 
     fault_tolerant.enclose_fluid_regions_fault.create_patch_preferences.show_create_patch_preferences.set_state(False)
-    fault_tolerant.enclose_fluid_regions_fault.patch_name.set_state("inlet-1")
-    fault_tolerant.enclose_fluid_regions_fault.selection_type.set_state("zone")
-    fault_tolerant.enclose_fluid_regions_fault.zone_selection_list.set_state(["inlet.1"])
 
-    fault_tolerant.enclose_fluid_regions_fault.create_patch_preferences.show_create_patch_preferences.set_state(False)
     fault_tolerant.enclose_fluid_regions_fault.patch_name.set_state("inlet-1")
     fault_tolerant.enclose_fluid_regions_fault.selection_type.set_state("zone")
-    fault_tolerant.enclose_fluid_regions_fault.zone_location.set_state([
-                "1",
-                "351.68205",
-                "-361.34322",
-                "-301.88668",
-                "396.96205",
-                "-332.84759",
-                "-266.69751",
-                "inlet.1",
-            ])
     fault_tolerant.enclose_fluid_regions_fault.zone_selection_list.set_state(["inlet.1"])
-    fault_tolerant.enclose_fluid_regions_fault.add_child_to_task()
     fault_tolerant.enclose_fluid_regions_fault.insert_compound_child_task()
-    fault_tolerant.enclose_fluid_regions_fault.arguments.set_state({})
     fault_tolerant.enclose_fluid_regions_fault_child_1()
 
     fault_tolerant.enclose_fluid_regions_fault.patch_name.set_state("inlet-2")
     fault_tolerant.enclose_fluid_regions_fault.selection_type.set_state("zone")
     fault_tolerant.enclose_fluid_regions_fault.zone_selection_list.set_state(["inlet.2"])
-
-    fault_tolerant.enclose_fluid_regions_fault.patch_name.set_state("inlet-2")
-    fault_tolerant.enclose_fluid_regions_fault.selection_type.set_state("zone")
-    fault_tolerant.enclose_fluid_regions_fault.zone_location.set_state([
-                "1",
-                "441.68205",
-                "-361.34322",
-                "-301.88668",
-                "486.96205",
-                "-332.84759",
-                "-266.69751",
-                "inlet.2",
-            ])
-    fault_tolerant.enclose_fluid_regions_fault.zone_selection_list.set_state(["inlet.2"])
-    fault_tolerant.enclose_fluid_regions_fault.add_child_to_task()
     fault_tolerant.enclose_fluid_regions_fault.insert_compound_child_task()
-    fault_tolerant.enclose_fluid_regions_fault.arguments.set_state({})
     fault_tolerant.enclose_fluid_regions_fault_child_2()
 
     fault_tolerant.enclose_fluid_regions_fault.patch_name.set_state("inlet-3")
     fault_tolerant.enclose_fluid_regions_fault.selection_type.set_state("zone")
     fault_tolerant.enclose_fluid_regions_fault.zone_selection_list.set_state(["inlet"])
-
-    fault_tolerant.enclose_fluid_regions_fault.patch_name.set_state("inlet-3")
-    fault_tolerant.enclose_fluid_regions_fault.selection_type.set_state("zone")
-    fault_tolerant.enclose_fluid_regions_fault.zone_location.set_state([
-                "1",
-                "261.68205",
-                "-361.34322",
-                "-301.88668",
-                "306.96205",
-                "-332.84759",
-                "-266.69751",
-                "inlet",
-            ])
-    fault_tolerant.enclose_fluid_regions_fault.zone_selection_list.set_state(["inlet"])
-    fault_tolerant.enclose_fluid_regions_fault.add_child_to_task()
     fault_tolerant.enclose_fluid_regions_fault.insert_compound_child_task()
-    fault_tolerant.enclose_fluid_regions_fault.arguments.set_state({})
     fault_tolerant.enclose_fluid_regions_fault_child_3()
 
     fault_tolerant.enclose_fluid_regions_fault.patch_name.set_state("outlet-1")
     fault_tolerant.enclose_fluid_regions_fault.selection_type.set_state("zone")
     fault_tolerant.enclose_fluid_regions_fault.zone_selection_list.set_state(["outlet"])
     fault_tolerant.enclose_fluid_regions_fault.zone_type.set_state("pressure-outlet")
-
-    fault_tolerant.enclose_fluid_regions_fault.patch_name.set_state("outlet-1")
-    fault_tolerant.enclose_fluid_regions_fault.selection_type.set_state("zone")
-    fault_tolerant.enclose_fluid_regions_fault.zone_location.set_state([
-                "1",
-                "352.22702",
-                "-197.8957",
-                "84.102381",
-                "394.41707",
-                "-155.70565",
-                "84.102381",
-                "outlet",
-            ])
-    fault_tolerant.enclose_fluid_regions_fault.zone_selection_list.set_state(["outlet"])
-    fault_tolerant.enclose_fluid_regions_fault.zone_type.set_state("pressure-outlet")
-    fault_tolerant.enclose_fluid_regions_fault.add_child_to_task()
     fault_tolerant.enclose_fluid_regions_fault.insert_compound_child_task()
-    fault_tolerant.enclose_fluid_regions_fault.arguments.set_state({})
     fault_tolerant.enclose_fluid_regions_fault_child_4()
 
 Extract edge features
 ~~~~~~~~~~~~~~~~~~~~~
 
 .. code:: python
 
-    fault_tolerant.extract_edge_features.extract_method_type.set_state("Intersection Loops")
-    fault_tolerant.extract_edge_features.object_selection_list.set_state(["flow_pipe", "main"])
-    fault_tolerant.extract_edge_features.add_child_to_task()
-    fault_tolerant.extract_edge_features.insert_compound_child_task()
-
     fault_tolerant.extract_edge_features.extract_edges_name.set_state("edge-group-1")
     fault_tolerant.extract_edge_features.extract_method_type.set_state("Intersection Loops")
     fault_tolerant.extract_edge_features.object_selection_list.set_state(["flow_pipe", "main"])
-
-    fault_tolerant.extract_edge_features.arguments.set_state({})
-    fault_tolerant.task("edge-group-1")()
+    fault_tolerant.extract_edge_features.insert_compound_child_task()
+    fault_tolerant.extract_edge_features_child_1()
 
 Identify regions
 ~~~~~~~~~~~~~~~~
 
 .. code:: python
 
+    fault_tolerant.identify_regions.show_coordinates = True
+    fault_tolerant.identify_regions.material_points_name.set_state("fluid-region-1")
     fault_tolerant.identify_regions.selection_type.set_state("zone")
     fault_tolerant.identify_regions.x.set_state(377.322045740589)
     fault_tolerant.identify_regions.y.set_state(-176.800676988458)
     fault_tolerant.identify_regions.z.set_state(-37.0764628583475)
     fault_tolerant.identify_regions.zone_selection_list.set_state(["main.1"])
-
-    fault_tolerant.identify_regions.selection_type.set_state("zone")
-    fault_tolerant.identify_regions.x.set_state(377.322045740589)
-    fault_tolerant.identify_regions.y.set_state(-176.800676988458)
-    fault_tolerant.identify_regions.z.set_state(-37.0764628583475)
-    fault_tolerant.identify_regions.zone_location.set_state([
-                "1",
-                "213.32205",
-                "-225.28068",
-                "-158.25531",
-                "541.32205",
-                "-128.32068",
-                "84.102381",
-                "main.1",
-            ])
-    fault_tolerant.identify_regions.zone_selection_list.set_state(["main.1"])
-    fault_tolerant.identify_regions.add_child_to_task()
     fault_tolerant.identify_regions.insert_compound_child_task()
+    fault_tolerant.identify_regions_child_1()
 
-    fault_tolerant.task("fluid-region-1").material_points_name.set_state("fluid-region-1")
-    fault_tolerant.task("fluid-region-1").selection_type.set_state("zone")
-    fault_tolerant.identify_regions.x.set_state(377.322045740589)
-    fault_tolerant.identify_regions.y.set_state(-176.800676988458)
-    fault_tolerant.identify_regions.z.set_state(-37.0764628583475)
-    fault_tolerant.identify_regions.zone_location.set_state([
-                "1",
-                "213.32205",
-                "-225.28068",
-                "-158.25531",
-                "541.32205",
-                "-128.32068",
-                "84.102381",
-                "main.1",
-            ])
-    fault_tolerant.identify_regions.zone_selection_list.set_state(["main.1"])
-    fault_tolerant.identify_regions.arguments.set_state({})
-    fault_tolerant.task("fluid-region-1")()
-
+    fault_tolerant.identify_regions.show_coordinates = True
     fault_tolerant.identify_regions.material_points_name.set_state("void-region-1")
     fault_tolerant.identify_regions.new_region_type.set_state("void")
     fault_tolerant.identify_regions.object_selection_list.set_state(["inlet-1", "inlet-2", "inlet-3", "main"])
     fault_tolerant.identify_regions.x.set_state(374.722045740589)
     fault_tolerant.identify_regions.y.set_state(-278.9775145640143)
     fault_tolerant.identify_regions.z.set_state(-161.1700719416913)
-    fault_tolerant.identify_regions.add_child_to_task()
     fault_tolerant.identify_regions.insert_compound_child_task()
-    fault_tolerant.identify_regions.arguments.set_state({})
-    fault_tolerant.task("void-region-1")()
+    fault_tolerant.identify_regions_child_2()
 
 Define leakage threshold
 ~~~~~~~~~~~~~~~~~~~~~~~~
@@ -339,22 +228,18 @@ Define leakage threshold
     fault_tolerant.define_leakage_threshold.flip_direction.set_state(True)
     fault_tolerant.define_leakage_threshold.plane_direction.set_state("X")
     fault_tolerant.define_leakage_threshold.region_selection_single.set_state("void-region-1")
-    fault_tolerant.define_leakage_threshold.add_child_to_task()
-    fault_tolerant.define_leakage_threshold.insert_compound_child_task()
 
-    fault_tolerant.task("leakage-1").arguments.set_state(
+    fault_tolerant.define_leakage_threshold.arguments.set_state(
         {
-            "AddChild": "yes",
-            "FlipDirection": True,
-            "LeakageName": "leakage-1",
-            "PlaneDirection": "X",
-            "RegionSelectionSingle": "void-region-1",
+            'add_child': 'yes',
+            'flip_direction': True,
+            'leakage_name': 'leakage-1',
+            'plane_direction': 'X',
+            'region_selection_single': ['void-region-1'],
         }
     )
-
-    fault_tolerant.define_leakage_threshold.add_child.set_state("yes")
-
-    fault_tolerant.task("leakage-1")()
+    fault_tolerant.define_leakage_threshold.insert_compound_child_task()
+    fault_tolerant.define_leakage_threshold_child_1()
 
 Update regions settings
 ~~~~~~~~~~~~~~~~~~~~~~~
@@ -379,18 +264,18 @@ Update regions settings
     fault_tolerant.update_region_settings.all_region_type_list.set_state(["void"] * 6 + ["fluid"])
     fault_tolerant.update_region_settings.all_region_volume_fill_list.set_state(["none"] * 6 + ["tet"])
     fault_tolerant.update_region_settings.filter_category.set_state("Identified Regions")
-    fault_tolerant.update_region_settings.old_region_leakage_size_list.set_state([""])
-    fault_tolerant.update_region_settings.old_region_mesh_method_list.set_state(["wrap"])
-    fault_tolerant.update_region_settings.old_region_name_list.set_state(["fluid-region-1"])
-    fault_tolerant.update_region_settings.old_region_overset_componen_list.set_state(["no"])
-    fault_tolerant.update_region_settings.old_region_type_list.set_state(["fluid"])
-    fault_tolerant.update_region_settings.old_region_volume_fill_list.set_state(["hexcore"])
-    fault_tolerant.update_region_settings.region_leakage_size_list.set_state([""])
-    fault_tolerant.update_region_settings.region_mesh_method_list.set_state(["wrap"])
-    fault_tolerant.update_region_settings.region_name_list.set_state(["fluid-region-1"])
-    fault_tolerant.update_region_settings.region_overset_componen_list.set_state(["no"])
-    fault_tolerant.update_region_settings.region_type_list.set_state(["fluid"])
-    fault_tolerant.update_region_settings.region_volume_fill_list.set_state(["tet"])
+    fault_tolerant.update_region_settings.all_region_leakage_size_list.set_state([""])
+    fault_tolerant.update_region_settings.all_region_mesh_method_list.set_state(["wrap"])
+    fault_tolerant.update_region_settings.all_region_name_list.set_state(["fluid-region-1"])
+    fault_tolerant.update_region_settings.all_region_overset_componen_list.set_state(["no"])
+    fault_tolerant.update_region_settings.all_region_type_list.set_state(["fluid"])
+    fault_tolerant.update_region_settings.all_region_volume_fill_list.set_state(["hexcore"])
+    fault_tolerant.update_region_settings.all_region_leakage_size_list.set_state([""])
+    fault_tolerant.update_region_settings.all_region_mesh_method_list.set_state(["wrap"])
+    fault_tolerant.update_region_settings.all_region_name_list.set_state(["fluid-region-1"])
+    fault_tolerant.update_region_settings.all_region_overset_componen_list.set_state(["no"])
+    fault_tolerant.update_region_settings.all_region_type_list.set_state(["fluid"])
+    fault_tolerant.update_region_settings.all_region_volume_fill_list.set_state(["tet"])
     fault_tolerant.update_region_settings()
 
 Choose mesh control options
@@ -419,11 +304,9 @@ Add boundary layers
 
 .. code:: python
 
-    fault_tolerant.add_boundary_layer_ftm.add_child_to_task()
+    fault_tolerant.add_boundary_layer_ftm.bl_control_name.set_state("aspect-ratio_1")
     fault_tolerant.add_boundary_layer_ftm.insert_compound_child_task()
-    fault_tolerant.task("aspect-ratio_1").bl_control_name.set_state("aspect-ratio_1")
-    fault_tolerant.add_boundary_layer_ftm.arguments.set_state({})
-    fault_tolerant.task("aspect-ratio_1")()
+    fault_tolerant.add_boundary_layer_ftm_child_1()
 
 Generate volume mesh
 ~~~~~~~~~~~~~~~~~~~~
@@ -441,7 +324,6 @@ Generate volume mesh
             ])
     fault_tolerant.create_volume_mesh.all_region_size_list.set_state(["11.33375"] * 7)
     fault_tolerant.create_volume_mesh.all_region_volume_fill_list.set_state(["none"] * 6 + ["tet"])
-    fault_tolerant.create_volume_mesh.enable_parallel.set_state(True)
     fault_tolerant.create_volume_mesh()
 
 Switch to solution mode
@@ -481,7 +363,6 @@ Set regions and boundaries
 
 .. code:: python
 
-    two_dim_mesh.update_regions_2d()
     two_dim_mesh.update_boundaries_2d.selection_type = "zone"
     two_dim_mesh.update_boundaries_2d()
 
@@ -557,53 +438,23 @@ Generate surface mesh
 
 .. code:: python
 
-    two_dim_mesh.generate_initial_surface_mesh.surface2_d_preferences.merge_edge_zones_based_on_labels = (
-        "no"
-    )
-    two_dim_mesh.generate_initial_surface_mesh.surface2_d_preferences.merge_face_zones_based_on_labels = (
-        "no"
-    )
-    two_dim_mesh.generate_initial_surface_mesh.surface2_d_preferences.show_advanced_options = (
-        True
-    )
+    two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.merge_edge_zones_based_on_labels = "no"
+    two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.merge_face_zones_based_on_labels = "no"
+    two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.show_advanced_options = True
     two_dim_mesh.generate_initial_surface_mesh()
 
-    two_dim_mesh.task("aspect-ratio_1").revert()
-    two_dim_mesh.task("aspect-ratio_1").add_child = "yes"
-    two_dim_mesh.task("aspect-ratio_1").bl_control_name = "uniform_1"
-    two_dim_mesh.task("aspect-ratio_1").first_layer_height = 2
-    two_dim_mesh.task("aspect-ratio_1").number_of_layers = 4
-    two_dim_mesh.task("aspect-ratio_1").offset_method_type = "uniform"
-    two_dim_mesh.task("aspect-ratio_1")()
+    two_dim_mesh.add_2d_boundary_layers_child_1.revert()
+    two_dim_mesh.add_2d_boundary_layers_child_1.add_child = "yes"
+    two_dim_mesh.add_2d_boundary_layers_child_1.bl_control_name = "uniform_1"
+    two_dim_mesh.add_2d_boundary_layers_child_1.first_layer_height = 2
+    two_dim_mesh.add_2d_boundary_layers_child_1.number_of_layers = 4
+    two_dim_mesh.add_2d_boundary_layers_child_1.offset_method_type = "uniform"
+    two_dim_mesh.add_2d_boundary_layers_child_1()
 
-    two_dim_mesh.generate_initial_surface_mesh.surface2_d_preferences.merge_edge_zones_based_on_labels = (
-        "no"
-    )
-    two_dim_mesh.generate_initial_surface_mesh.surface2_d_preferences.merge_face_zones_based_on_labels = (
-        "no"
-    )
-    two_dim_mesh.generate_initial_surface_mesh.surface2_d_preferences.show_advanced_options = (
-        True
-    )
-    two_dim_mesh.generate_initial_surface_mesh()
-
-    two_dim_mesh.task("uniform_1").revert()
-    two_dim_mesh.task("uniform_1").add_child = "yes"
-    two_dim_mesh.task("uniform_1").bl_control_name = "smooth-transition_1"
-    two_dim_mesh.task("uniform_1").first_layer_height = 2
-    two_dim_mesh.task("uniform_1").number_of_layers = 7
-    two_dim_mesh.task("uniform_1").offset_method_type = "smooth-transition"
-    two_dim_mesh.task("uniform_1")()
 
-    two_dim_mesh.generate_initial_surface_mesh.surface2_d_preferences.merge_edge_zones_based_on_labels = (
-        "no"
-    )
-    two_dim_mesh.generate_initial_surface_mesh.surface2_d_preferences.merge_face_zones_based_on_labels = (
-        "no"
-    )
-    two_dim_mesh.generate_initial_surface_mesh.surface2_d_preferences.show_advanced_options = (
-        True
-    )
+    two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.merge_edge_zones_based_on_labels = "no"
+    two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.merge_face_zones_based_on_labels = "no"
+    two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.show_advanced_options = True
     two_dim_mesh.generate_initial_surface_mesh()
 
 Switch to solution mode
@@ -726,7 +577,10 @@ Use the ``mark_as_updated()`` method to forcefully mark a task as updated.
 Sample use of ``arguments``
 ----------------------------
 This simple example shows how to use the ``arguments`` attributes and explicit
-attribute access methods in a watertight geometry meshing workflow.
+attribute access methods in a watertight geometry meshing workflow. Unlike the
+classic meshing workflow, the arguments in the new workflow are fully populated
+with all parameter values used during command execution, rather than only those
+explicitly set by the user.
 
 .. Note::
    The ``command_arguments()`` method is deprecated.