Improve geometry examples

Author: GuillemBarroso

examples/05-plotting/07-plot_on_points.py

@@ -1,8 +1,8 @@
 """
 .. _plot_on_points:
 
-Plot on geometry elements
-~~~~~~~~~~~~~~~~~~~~~~~~~
+Plot on Points object
+~~~~~~~~~~~~~~~~~~~~~
 This example shows how to plot a Field on a Points object.
 
 .. note::
@@ -48,6 +48,12 @@
     ]
 )
 
+###############################################################################
+# Get Points object properties
+print(f"Total number of points: n_points = {points.n_points}")
+print(f"Get points' coordinates:\n    {points.coordinates.data}")
+print(f"Access first point: {points[0]}")
+
 ###############################################################################
 # Get mesh from model
 mesh = model.metadata.meshed_region
@@ -67,7 +73,7 @@
 # Map displacement field to Points
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 # Use :class:`on_coordinates <ansys.dpf.core.operators.mapping.on_coordinates.
-# on_coordinates>`: mapping opretor
+# on_coordinates>` mapping opretor
 disp = model.results.displacement
 mapping_operator = ops.mapping.on_coordinates(
     fields_container=disp,

examples/05-plotting/08-plot_on_lines.py

@@ -37,6 +37,14 @@
 # Create line passing through the geometry's diagonal
 line = Line([[0.03, 0.03, 0.05], [0.0, 0.06, 0.0]], n_points=50)
 
+###############################################################################
+# Get Line object properties
+print(f"Coordinates of the two points:\n    {line.coordinates.data}")
+print(f"Direction of the line = {line.direction}")
+print(f"Length of the line = {line.length}")
+print(f"Path of the line =\n    {line.path}")
+assert len(line.path) == line.n_points
+
 ###############################################################################
 # Get mesh from model
 mesh = model.metadata.meshed_region
@@ -56,7 +64,7 @@
 ###############################################################################
 # Map displacement field to Line
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-# Use :class:`on_coordinates <ansys.dpf.core.operators.mapping.on_coordinates.on_coordinates>`:
+# Use :class:`on_coordinates <ansys.dpf.core.operators.mapping.on_coordinates.on_coordinates>`
 # mapping opretor to obtain the displacement Field on the line:
 disp = model.results.displacement
 mapping_operator = ops.mapping.on_coordinates(
@@ -86,7 +94,7 @@
 # 2D Plot displacement field alogn line length
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 # Get norm of the displacement using
-# :class:`norm <ansys.dpf.core.operators.math.norm.norm>`:
+# :class:`norm <ansys.dpf.core.operators.math.norm.norm>`
 norm_op = dpf.operators.math.norm()  # operator instantiation
 norm_op.inputs.field.connect(field_line)
 norm = norm_op.outputs.field()

examples/05-plotting/09-plot_on_planes.py

@@ -34,17 +34,17 @@
 # ~~~~~~~~~~~~~~~~~~~
 # Create plane passing through the mid point
 plane1 = Plane(
-    [0.015, 0.045, 0.015],
-    [1, 1, 0],
+    center=[0.015, 0.045, 0.015],
+    normal=[1, 1, 0],
     width=0.03,
     height=0.03,
     n_cells_x=10,
     n_cells_y=10,
 )
 
 plane2 = Plane(
-    [0.015, 0.045, 0.015],
-    [1, 1, 1],
+    center=[0.015, 0.045, 0.015],
+    normal=[1, 1, 1],
     width=0.03,
     height=0.03,
     n_cells_x=10,
@@ -69,11 +69,20 @@
 plane1.plot(mesh, cpos=cpos)
 plane2.plot(mesh, cpos=cpos)
 
+###############################################################################
+# Get plane's properties
+print(f"Center of the plane = {plane1.center}")
+print(f"Normal direction of the plane = {plane1.normal_dir}")
+print(f"Number of cells in the x axis to discretize the plane = {plane1.n_cells_x}")
+print(f"Number of cells in the y axis to discretize the plane = {plane1.n_cells_y}")
+print(f"Height of the discretized plane = {plane1.height}")
+print(f"Width of the discretized plane = {plane1.width}")
+
 ###############################################################################
 # Map displacements to plane
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~
 # Map displacement field to points in plane object using
-# :class:`on_coordinates <ansys.dpf.core.operators.mapping.on_coordinates.on_coordinates>:`
+# :class:`on_coordinates <ansys.dpf.core.operators.mapping.on_coordinates.on_coordinates>`
 disp = model.results.displacement
 mapping_operator = ops.mapping.on_coordinates(
     fields_container=disp,
@@ -91,20 +100,15 @@
 # Extract the only field (0th entry) available in ``disp_plane1_fc`` FieldsContainer
 field_plane1 = disp_plane1_fc[0]
 
+###############################################################################
+# Repeat process for plane2
 mapping_operator = ops.mapping.on_coordinates(
     fields_container=disp,
     coordinates=plane2.mesh.nodes.coordinates_field,
     create_support=True,
     mesh=mesh,
 )
 disp_plane2_fc = mapping_operator.outputs.fields_container()
-
-###############################################################################
-# Print ``disp_plane2_fc`` information
-print(disp_plane2_fc)
-
-###############################################################################
-# Extract the only field (0th entry) available in ``disp_plane2_fc`` FieldsContainer
 field_plane2 = disp_plane2_fc[0]
 
 ###############################################################################
@@ -134,7 +138,7 @@
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 # Obtain the levelset of the plane with respect to the mesh using
 # :class:`make_plane_levelset <ansys.dpf.core.operators.mesh.make_plane_levelset.
-# make_plane_levelset>`:
+# make_plane_levelset>`
 # A levelset is a scalar Field representing the normal distance between the plane
 # and the nodes of the mesh.
 # Note that origin and normal must be ``dpf.locations.overall`` 3D vectors.
@@ -171,13 +175,12 @@
 ###############################################################################
 # Compute intersection plane / mesh
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-# Use the :class:`mesh_cut <ansys.dpf.core.operators.mesh.mesh_cut.mesh_cut>`:
+# Use the :class:`mesh_cut <ansys.dpf.core.operators.mesh.mesh_cut.mesh_cut>`
 # operator to obtain the intersection of the plane with the mesh from the levelset
 mesh_cutter_op = ops.mesh.mesh_cut()
 mesh_cutter_op.inputs.field.connect(levelset1)
 mesh_cutter_op.inputs.iso_value.connect(float(0))
 mesh_cutter_op.connect(2, 0)
-# mesh_cutter_op.inputs.mesh.connect(mesh)
 mesh_cutter_op.connect(3, mesh)
 mesh_cutter_op.inputs.slice_surfaces.connect(True)
 intersection1 = mesh_cutter_op.outputs.mesh()
@@ -186,7 +189,6 @@
 mesh_cutter_op.inputs.field.connect(levelset2)
 mesh_cutter_op.inputs.iso_value.connect(float(0))
 mesh_cutter_op.connect(2, 0)
-# mesh_cutter_op.inputs.mesh.connect(mesh)
 mesh_cutter_op.connect(3, mesh)
 mesh_cutter_op.inputs.slice_surfaces.connect(True)
 intersection2 = mesh_cutter_op.outputs.mesh()