Skip to content

Commit

Permalink
Remove unnecessary parentheses
Browse files Browse the repository at this point in the history
  • Loading branch information
robbievanleeuwen committed Jun 21, 2023
1 parent 1774745 commit a2c17d5
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
22 changes: 11 additions & 11 deletions docs/user_guide/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,29 +88,29 @@ The solver operates on a :class:`~sectionproperties.analysis.section.Section` ob
can perform five different analysis types:

- **Geometric Analysis**: calculates area properties,
:meth:`~sectionproperties.analysis.section.Section.calculate_geometric_properties()`.
:meth:`~sectionproperties.analysis.section.Section.calculate_geometric_properties`.
- **Warping Analysis**: calculates torsion and shear properties,
:meth:`~sectionproperties.analysis.section.Section.calculate_warping_properties()`.
:meth:`~sectionproperties.analysis.section.Section.calculate_warping_properties`.
- **Frame Analysis**: calculates section properties used for frame analysis (more
efficient than running a geometric and warping analysis),
:meth:`~sectionproperties.analysis.section.Section.calculate_frame_properties()`.
:meth:`~sectionproperties.analysis.section.Section.calculate_frame_properties`.
- **Plastic Analysis**: calculates plastic properties,
:meth:`~sectionproperties.analysis.section.Section.calculate_plastic_properties()`.
:meth:`~sectionproperties.analysis.section.Section.calculate_plastic_properties`.
- **Stress Analysis**: calculates cross-section stresses,
:meth:`~sectionproperties.analysis.section.Section.calculate_stress()`.
:meth:`~sectionproperties.analysis.section.Section.calculate_stress`.

Post-Processor
--------------

There are a number of built-in methods to enable the post-processing of analysis
results. For example, a full list of calculated section properties can be printed to the
terminal by using the
:meth:`~sectionproperties.analysis.section.Section.display_results()` method.
:meth:`~sectionproperties.analysis.section.Section.display_results` method.
Alternatively, specific properties can be retrieved by calling the appropriate ``get``
method, e.g. :meth:`~sectionproperties.analysis.section.Section.get_ic()`.
method, e.g. :meth:`~sectionproperties.analysis.section.Section.get_ic`.

The calculated cross-section centroids can be plotted by calling the
:meth:`~sectionproperties.analysis.section.Section.plot_centroids()` method. The
:meth:`~sectionproperties.analysis.section.Section.plot_centroids` method. The
following example plots the centroids of a 200 PFC section:

.. plot::
Expand All @@ -131,11 +131,11 @@ following example plots the centroids of a 200 PFC section:
sec.plot_centroids()

Finally, cross-section stresses may be retrieved by at specific points by calling the
:meth:`~sectionproperties.analysis.section.Section.get_stress_at_points()` method, or
:meth:`~sectionproperties.analysis.section.Section.get_stress_at_points` method, or
plotted by calling the
:meth:`~sectionproperties.post.stress_post.StressPost.plot_stress()` method from a
:meth:`~sectionproperties.post.stress_post.StressPost.plot_stress` method from a
:class:`~sectionproperties.post.stress_post.StressPost` object, obtained after running
the :meth:`~sectionproperties.analysis.section.Section.calculate_stress()` method. The
the :meth:`~sectionproperties.analysis.section.Section.calculate_stress` method. The
following example plots the von Mises stress in a 100 x 6 SHS subject to bending, shear
and torsion:

Expand Down
8 changes: 4 additions & 4 deletions docs/user_guide/validation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ In ``sectionproperties``, there are multiple ways to set this problem up. We cou
different shapely geometries and merge together, or a set of custom points, or a
built-in constructor. For the sake of simplicity, this simpler I-section is identical to
the Nastran I-section definition, so it makes sense to utilise the built-in constructor
from :func:`~sectionproperties.pre.library.nastran_sections.nastran_i()`.
from :func:`~sectionproperties.pre.library.nastran_sections.nastran_i`.

Using an arbitrarily coarse mesh, the properties can then be directly calculated from
the class method
:meth:`~sectionproperties.analysis.section.Section.calculate_geometric_properties()`.
:meth:`~sectionproperties.analysis.section.Section.calculate_geometric_properties`.

Peery lists the second moment of area about the primary bending axis as a value of 43.3
in\ :sup:`4`. For the automated tests in this library, we check against this hardcoded
Expand Down Expand Up @@ -85,13 +85,13 @@ referenced as the z-axis, and loads must be applied in this coordinate system.
:align: center

The construction of this geometry takes a similar approach to Ex 6.2.1, and utilises a
built-in factory, :func:`~sectionproperties.pre.library.nastran_sections.nastran_zed()`.
built-in factory, :func:`~sectionproperties.pre.library.nastran_sections.nastran_zed`.
The only difference you may notice in the test code is usage of a custom class for ease
of initialisation. This is not necessary.

Using an arbitrarily coarse mesh, the properties can then be directly calculated from
the class method
:meth:`~sectionproperties.analysis.section.Section.calculate_geometric_properties()`.
:meth:`~sectionproperties.analysis.section.Section.calculate_geometric_properties`.
Each property listed directly by Peery is taken as a hardcoded value and checked
against, within the testing suite.

Expand Down

0 comments on commit a2c17d5

Please sign in to comment.