Skip to content
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
70 changes: 35 additions & 35 deletions sectionproperties/analysis/section.py
Original file line number Diff line number Diff line change
Expand Up @@ -1313,7 +1313,7 @@ def plot_mesh(
:param mask: Mask array, of length ``num_nodes``, to mask out triangles
:type mask: list[bool]
:param string title: Plot title
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -1408,7 +1408,7 @@ def plot_centroids(self, title="Centroids", **kwargs):
axis, if they have been calculated, on top of the finite element mesh.

:param string title: Plot title
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -2592,7 +2592,7 @@ def plot_stress_contour(self, sigs, title, cmap, normalize, **kwargs):
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axe object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -2658,7 +2658,7 @@ def plot_stress_vector(self, sigxs, sigys, title, cmap, normalize, **kwargs):
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -2872,7 +2872,7 @@ def plot_stress_n_zz(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -2921,7 +2921,7 @@ def plot_stress_mxx_zz(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -2970,7 +2970,7 @@ def plot_stress_myy_zz(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3019,7 +3019,7 @@ def plot_stress_m11_zz(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3068,7 +3068,7 @@ def plot_stress_m22_zz(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3117,7 +3117,7 @@ def plot_stress_m_zz(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3167,7 +3167,7 @@ def plot_stress_mzz_zx(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3216,7 +3216,7 @@ def plot_stress_mzz_zy(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3265,7 +3265,7 @@ def plot_stress_mzz_zxy(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3314,7 +3314,7 @@ def plot_vector_mzz_zxy(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3365,7 +3365,7 @@ def plot_stress_vx_zx(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3414,7 +3414,7 @@ def plot_stress_vx_zy(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3463,7 +3463,7 @@ def plot_stress_vx_zxy(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3513,7 +3513,7 @@ def plot_vector_vx_zxy(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3564,7 +3564,7 @@ def plot_stress_vy_zx(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3613,7 +3613,7 @@ def plot_stress_vy_zy(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3662,7 +3662,7 @@ def plot_stress_vy_zxy(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3711,7 +3711,7 @@ def plot_vector_vy_zxy(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3763,7 +3763,7 @@ def plot_stress_v_zx(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3814,7 +3814,7 @@ def plot_stress_v_zy(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3865,7 +3865,7 @@ def plot_stress_v_zxy(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3916,7 +3916,7 @@ def plot_vector_v_zxy(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -3968,7 +3968,7 @@ def plot_stress_zz(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -4018,7 +4018,7 @@ def plot_stress_zx(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -4068,7 +4068,7 @@ def plot_stress_zy(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -4118,7 +4118,7 @@ def plot_stress_zxy(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -4168,7 +4168,7 @@ def plot_vector_zxy(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -4220,7 +4220,7 @@ def plot_stress_1(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -4280,7 +4280,7 @@ def plot_stress_3(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -4340,7 +4340,7 @@ def plot_stress_vm(
:param string cmap: Matplotlib color map.
:param bool normalize: If set to true, the CenteredNorm is used to scale the colormap.
If set to false, the default linear scaling is used.
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down Expand Up @@ -4392,7 +4392,7 @@ def plot_mohrs_circles(self, x, y, title=None, **kwargs):
:param float x: x-coordinate of the point to draw Mohr's Circle
:param float y: y-coordinate of the point to draw Mohr's Circle
:param string title: Plot title
:param \**kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`
:param kwargs: Passed to :func:`~sectionproperties.post.post.plotting_context`

:return: Matplotlib axes object
:rtype: :class:`matplotlib.axes`
Expand Down
2 changes: 1 addition & 1 deletion sectionproperties/post/post.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def plotting_context(
This may be a tuple if a 2D array of plots is returned. The default value of None will
select the top left plot.
:type axis_index: Union[None, int, Tuple(int)]
:param \**kwargs: Passed to :func:`matplotlib.pyplot.subplots`
:param kwargs: Passed to :func:`matplotlib.pyplot.subplots`
"""

if filename:
Expand Down
Loading