Skip to content

Commit

Permalink
DOC: update development documentation 2dbb7c5
Browse files Browse the repository at this point in the history
  • Loading branch information
janvonrickenbach committed Sep 17, 2023
1 parent 4836e61 commit 7a5d4c3
Show file tree
Hide file tree
Showing 73 changed files with 96 additions and 96 deletions.
2 changes: 1 addition & 1 deletion version/dev/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 539d32866247320bc414506477af5cb3
config: ff1e433f139ed5759764f5f9876f4301
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified version/dev/_images/sphx_glr_003_short_fiber_example_001.vtksz
Binary file not shown.
Binary file modified version/dev/_images/sphx_glr_003_short_fiber_example_002.vtksz
Binary file not shown.
Binary file modified version/dev/_images/sphx_glr_003_short_fiber_example_003.vtksz
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified version/dev/_images/sphx_glr_008_assembly_example_001.vtksz
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified version/dev/_images/sphx_glr_010_harmonic_example_001.vtksz
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ Scope failure evaluation by plies.

.. rst-class:: sphx-glr-timing

**Total running time of the script:** ( 0 minutes 18.863 seconds)
**Total running time of the script:** ( 0 minutes 17.764 seconds)


.. _sphx_glr_download_examples_gallery_examples_001_failure_operator_example.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ You can change the element ID of the sampling point to generate another plot.

.. rst-class:: sphx-glr-timing

**Total running time of the script:** ( 0 minutes 7.484 seconds)
**Total running time of the script:** ( 0 minutes 6.380 seconds)


.. _sphx_glr_download_examples_gallery_examples_002_sampling_point_example.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ Compute and plot the maximum failure value per element.

.. rst-class:: sphx-glr-timing

**Total running time of the script:** ( 0 minutes 5.560 seconds)
**Total running time of the script:** ( 0 minutes 5.234 seconds)


.. _sphx_glr_download_examples_gallery_examples_003_short_fiber_example.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ Implement a custom failure criterion: basic max strain

.. rst-class:: sphx-glr-timing

**Total running time of the script:** ( 0 minutes 3.600 seconds)
**Total running time of the script:** ( 0 minutes 3.481 seconds)


.. _sphx_glr_download_examples_gallery_examples_004_get_material_properties_example.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ Plot basic layer properties (layer thicknesses, angles, and analysis ply names).

.. rst-class:: sphx-glr-timing

**Total running time of the script:** ( 0 minutes 0.642 seconds)
**Total running time of the script:** ( 0 minutes 0.552 seconds)


.. _sphx_glr_download_examples_gallery_examples_005_get_layup_properties_example.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ ID from an analysis ply.

.. rst-class:: sphx-glr-timing

**Total running time of the script:** ( 0 minutes 3.724 seconds)
**Total running time of the script:** ( 0 minutes 3.733 seconds)


.. _sphx_glr_download_examples_gallery_examples_006_filter_composite_data_example.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ Plot s3 at the mid-plane of a certain ply.

.. rst-class:: sphx-glr-timing

**Total running time of the script:** ( 0 minutes 8.694 seconds)
**Total running time of the script:** ( 0 minutes 8.752 seconds)


.. _sphx_glr_download_examples_gallery_examples_007_interlaminar_normal_stress_example.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ For DPF Server versions 7.0 and later, element information can be retrieved dire
.. rst-class:: sphx-glr-timing

**Total running time of the script:** ( 0 minutes 3.957 seconds)
**Total running time of the script:** ( 0 minutes 3.998 seconds)


.. _sphx_glr_download_examples_gallery_examples_008_assembly_example.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ Plot some components of the fiber orientation tensor.

.. rst-class:: sphx-glr-timing

**Total running time of the script:** ( 0 minutes 8.230 seconds)
**Total running time of the script:** ( 0 minutes 7.963 seconds)


.. _sphx_glr_download_examples_gallery_examples_009_short_fiber_orientation_tensor.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ at each frequency, because we look only at the element that has the highest IRF
.. code-block:: none
[<matplotlib.lines.Line2D object at 0x7f85b3a9c280>]
[<matplotlib.lines.Line2D object at 0x7fbaf3533730>]
Expand Down Expand Up @@ -484,7 +484,7 @@ Compute critical layer and critical failure mode.
.. rst-class:: sphx-glr-timing

**Total running time of the script:** ( 0 minutes 11.868 seconds)
**Total running time of the script:** ( 0 minutes 11.856 seconds)


.. _sphx_glr_download_examples_gallery_examples_010_harmonic_example.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ Plot the maximum and minimum values.

.. rst-class:: sphx-glr-timing

**Total running time of the script:** ( 0 minutes 5.681 seconds)
**Total running time of the script:** ( 0 minutes 5.754 seconds)


.. _sphx_glr_download_examples_gallery_examples_011_dpf_composite_failure_workflow.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,28 @@

Computation times
=================
**01:18.304** total execution time for **examples_gallery_examples** files:
**01:15.468** total execution time for **examples_gallery_examples** files:

+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_001_failure_operator_example.py` (``001_failure_operator_example.py``) | 00:18.863 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_001_failure_operator_example.py` (``001_failure_operator_example.py``) | 00:17.764 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_010_harmonic_example.py` (``010_harmonic_example.py``) | 00:11.868 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_010_harmonic_example.py` (``010_harmonic_example.py``) | 00:11.856 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py` (``007_interlaminar_normal_stress_example.py``) | 00:08.694 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py` (``007_interlaminar_normal_stress_example.py``) | 00:08.752 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py` (``009_short_fiber_orientation_tensor.py``) | 00:08.230 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py` (``009_short_fiber_orientation_tensor.py``) | 00:07.963 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_002_sampling_point_example.py` (``002_sampling_point_example.py``) | 00:07.484 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_002_sampling_point_example.py` (``002_sampling_point_example.py``) | 00:06.380 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_011_dpf_composite_failure_workflow.py` (``011_dpf_composite_failure_workflow.py``) | 00:05.681 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_011_dpf_composite_failure_workflow.py` (``011_dpf_composite_failure_workflow.py``) | 00:05.754 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_003_short_fiber_example.py` (``003_short_fiber_example.py``) | 00:05.560 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_003_short_fiber_example.py` (``003_short_fiber_example.py``) | 00:05.234 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_008_assembly_example.py` (``008_assembly_example.py``) | 00:03.957 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_008_assembly_example.py` (``008_assembly_example.py``) | 00:03.998 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py` (``006_filter_composite_data_example.py``) | 00:03.724 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py` (``006_filter_composite_data_example.py``) | 00:03.733 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_004_get_material_properties_example.py` (``004_get_material_properties_example.py``) | 00:03.600 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_004_get_material_properties_example.py` (``004_get_material_properties_example.py``) | 00:03.481 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``005_get_layup_properties_example.py``) | 00:00.642 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``005_get_layup_properties_example.py``) | 00:00.552 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
Original file line number Diff line number Diff line change
Expand Up @@ -511,7 +511,7 @@ <h1>get_property_for_all_layers<a class="headerlink" href="#get-property-for-all
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/dev/library/typing.html#typing.Optional" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.25)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>[<a class="reference external" href="https://docs.python.org/dev/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.25)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dtype</span></code></a>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float64</span></code>]]]</p>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/dev/library/typing.html#typing.Optional" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>[<a class="reference external" href="https://docs.python.org/dev/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.26)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dtype</span></code></a>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float64</span></code>]]]</p>
</dd>
</dl>
</dd></dl>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -498,7 +498,7 @@ <h1>get_result_times_or_frequencies<a class="headerlink" href="#get-result-times
<dd><p>Get the times or frequencies in the result file.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.25)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>[<a class="reference external" href="https://docs.python.org/dev/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.25)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dtype</span></code></a>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float64</span></code>]]</p>
<dd class="field-odd"><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>[<a class="reference external" href="https://docs.python.org/dev/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.26)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dtype</span></code></a>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float64</span></code>]]</p>
</dd>
</dl>
</dd></dl>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,7 @@ <h3>Navigation</h3>
<h1>dpf_material_ids<a class="headerlink" href="#dpf-material-ids" title="Permalink to this heading">#</a></h1>
<dl class="py attribute">
<dt class="sig sig-object py" id="ansys.dpf.composites.layup_info.ElementInfo.dpf_material_ids">
<span class="sig-prename descclassname"><span class="pre">ElementInfo.</span></span><span class="sig-name descname"><span class="pre">dpf_material_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.25)"><span class="pre">ndarray</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/dev/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.25)"><span class="pre">dtype</span></a><span class="p"><span class="pre">[</span></span><span class="pre">int64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ansys.dpf.composites.layup_info.ElementInfo.dpf_material_ids" title="Permalink to this definition">#</a></dt>
<span class="sig-prename descclassname"><span class="pre">ElementInfo.</span></span><span class="sig-name descname"><span class="pre">dpf_material_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><span class="pre">ndarray</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/dev/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.26)"><span class="pre">dtype</span></a><span class="p"><span class="pre">[</span></span><span class="pre">int64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ansys.dpf.composites.layup_info.ElementInfo.dpf_material_ids" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>

</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,7 @@ <h1>ElementInfo<a class="headerlink" href="#elementinfo" title="Permalink to thi
<li><p><strong>n_corner_nodes</strong> (<a class="reference external" href="https://docs.python.org/dev/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – Number of corner nodes (without midside nodes).</p></li>
<li><p><strong>n_spots</strong> (<a class="reference external" href="https://docs.python.org/dev/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – Number of spots (through-the-thickness integration points) per layer.</p></li>
<li><p><strong>element_type</strong> (<a class="reference external" href="https://docs.python.org/dev/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – APDL element type. For example, <code class="docutils literal notranslate"><span class="pre">181</span></code> for layered shells.</p></li>
<li><p><strong>dpf_material_ids</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.25)"><em>numpy.ndarray</em></a><em>[</em><em>Any</em><em>, </em><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.25)"><em>numpy.dtype</em></a><em>[</em><em>numpy.int64</em><em>]</em><em>]</em>) – List of DPF material IDs for all layers.</p></li>
<li><p><strong>dpf_material_ids</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><em>numpy.ndarray</em></a><em>[</em><em>Any</em><em>, </em><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.26)"><em>numpy.dtype</em></a><em>[</em><em>numpy.int64</em><em>]</em><em>]</em>) – List of DPF material IDs for all layers.</p></li>
<li><p><strong>is_shell</strong> (<a class="reference external" href="https://docs.python.org/dev/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Whether the element is a shell element.</p></li>
<li><p><strong>number_of_nodes_per_spot_plane</strong> (<a class="reference external" href="https://docs.python.org/dev/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – Number of nodes per output plane. The value is equal
to <code class="docutils literal notranslate"><span class="pre">n_corner_nodes</span></code> for shell elements and <code class="docutils literal notranslate"><span class="pre">n_corner_nodes</span></code>
Expand Down
Loading

0 comments on commit 7a5d4c3

Please sign in to comment.