Skip to content

Commit

Permalink
Meshing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
robbievanleeuwen committed Jun 21, 2023
1 parent a2c17d5 commit 3bcaf44
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/user_guide/meshing.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,25 @@
Meshing
=======

A finite element mesh is required to perform a cross-section analysis. After a geometry
has been created, a finite element mesh can then be created for the geometry by using
the :meth:`sectionproperties.pre.geometry.Geometry.create_mesh` or
:meth:`sectionproperties.pre.geometry.CompoundGeometry.create_mesh` methods:

.. automethod:: sectionproperties.pre.geometry.Geometry.create_mesh
:noindex:

.. automethod:: sectionproperties.pre.geometry.CompoundGeometry.create_mesh
:noindex:

.. warning::

The length of ``mesh_sizes`` must match the number of regions in the geometry object.

Once the mesh has been created, it is stored within the geometry object and the geometry
object can then be passed to :class:`~sectionproperties.analysis.section.Section` for
analysis.

Mesh quality analysis, such as plotting the mesh and displaying mesh metrics, can be
performed using the :class:`~sectionproperties.analysis.section.Section` class. Please
see :ref:`label-analysis` for further information on performing analyses.

0 comments on commit 3bcaf44

Please sign in to comment.