Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.rst to update expression more effective #21

Merged
merged 3 commits into from
Dec 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Motivation

`PyVista`_ accessors for `Gmsh`_ to generate 3D finite element mesh.

The motivation is that PyVista is the solution to the following.
PyVista is the solution to the following.

`Overview of Gmsh`_

Expand All @@ -30,24 +30,24 @@ We can define the surface using PyVista.

.. code-block:: python

>>> square = pv.Polygon(n_sides=4, radius=8, fill=False)
>>> square = square.rotate_z(45, inplace=False)
>>> geometry = pv.Polygon(n_sides=4, radius=8, fill=False)
>>> geometry = geometry.rotate_z(45, inplace=False)

We can then generate a 2D mesh.

.. code-block:: python

>>> tess = pvgmsh.frontal_delaunay_2d(edge_source=square, mesh_size=1.0)
>>> mesh = pvgmsh.frontal_delaunay_2d(geometry, mesh_size=1.0)

To visualize the model we can use PyVista.

.. code-block:: python

>>> plotter = pv.Plotter(off_screen=True)
>>> _ = plotter.add_mesh(tess, show_edges=True, line_width=4, color="white")
>>> _ = plotter.add_mesh(squar, show_edges=True, line_width=4, color="blue")
>>> _ = plotter.add_mesh(mesh, show_edges=True, line_width=4, color="white")
>>> _ = plotter.add_mesh(geometry, show_edges=True, line_width=4, color="blue")
>>> _ = plotter.add_points(
... squar.points, style="points", point_size=20, color="blue"
... geometry.points, style="points", point_size=20, color="blue"
... )
>>> plotter.show(cpos="xy")

Expand Down
22 changes: 11 additions & 11 deletions src/pvgmsh/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ def frontal_delaunay_2d(edge_source, mesh_size=1e-2):

>>> import pyvista as pv
>>> import pvgmsh
>>> squar = pv.Polygon(n_sides=4, radius=8, fill=False)
>>> squar = squar.rotate_z(45, inplace=False)
>>> squar
>>> geometry = pv.Polygon(n_sides=4, radius=8, fill=False)
>>> geometry = geometry.rotate_z(45, inplace=False)
>>> geometry
PolyData (...)
N Cells: 1
N Points: 4
Expand All @@ -47,20 +47,20 @@ def frontal_delaunay_2d(edge_source, mesh_size=1e-2):
Y Bounds: -5.657e+00, 5.657e+00
Z Bounds: 0.000e+00, 0.000e+00
N Arrays: 0
>>> squar.points
>>> geometry.points
pyvista_ndarray([[-5.656854, 5.656854, 0. ],
[ 5.656854, 5.656854, 0. ],
[ 5.656854, -5.656854, 0. ],
[-5.656854, -5.656854, 0. ]], dtype=float32)
>>> squar.faces
>>> geometry.faces
array([], dtype=int64)
>>> squar.lines
>>> geometry.lines
array([5, 0, 1, 2, 3, 0])

>>> tess = pvgmsh.frontal_delaunay_2d(edge_source=squar, mesh_size=1.0)
>>> mesh = pvgmsh.frontal_delaunay_2d(geometry, mesh_size=1.0)
<BLANKLINE>

>>> tess
>>> mesh
UnstructuredGrid (...)
N Cells: 398
N Points: 198
Expand All @@ -70,10 +70,10 @@ def frontal_delaunay_2d(edge_source, mesh_size=1e-2):
N Arrays: 0

>>> plotter = pv.Plotter(off_screen=True)
>>> _ = plotter.add_mesh(tess, show_edges=True, line_width=4, color="white")
>>> _ = plotter.add_mesh(squar, show_edges=True, line_width=4, color="blue")
>>> _ = plotter.add_mesh(mesh, show_edges=True, line_width=4, color="white")
>>> _ = plotter.add_mesh(geometry, show_edges=True, line_width=4, color="blue")
>>> _ = plotter.add_points(
... squar.points, style="points", point_size=20, color="blue"
... geometry.points, style="points", point_size=20, color="blue"
... )
>>> plotter.show(cpos="xy", screenshot="frontal_delaunay_2d_01.png")
"""
Expand Down