Skip to content

Commit

Permalink
DOC: update development documentation af4aab6
Browse files Browse the repository at this point in the history
  • Loading branch information
janvonrickenbach committed May 7, 2024
1 parent 71a200e commit 7902c14
Show file tree
Hide file tree
Showing 86 changed files with 129 additions and 129 deletions.
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 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 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 not shown.
Binary file not shown.
Binary file not shown.
Binary file modified version/dev/_images/sphx_glr_012_fatigue_example_001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified version/dev/_images/sphx_glr_012_fatigue_example_003.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified version/dev/_images/sphx_glr_012_fatigue_example_thumb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ Scope failure evaluation by plies.

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

**Total running time of the script:** ( 0 minutes 20.547 seconds)
**Total running time of the script:** ( 0 minutes 16.155 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 8.797 seconds)
**Total running time of the script:** ( 0 minutes 4.948 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 @@ -306,7 +306,7 @@ Compute and plot the maximum failure value per element.

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

**Total running time of the script:** ( 0 minutes 3.403 seconds)
**Total running time of the script:** ( 0 minutes 3.184 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 @@ -205,7 +205,7 @@ Implement a custom failure criterion: basic max strain

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

**Total running time of the script:** ( 0 minutes 5.095 seconds)
**Total running time of the script:** ( 0 minutes 4.342 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 2.755 seconds)
**Total running time of the script:** ( 0 minutes 0.958 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 @@ -452,7 +452,7 @@ in the material direction in this ply.

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

**Total running time of the script:** ( 0 minutes 4.196 seconds)
**Total running time of the script:** ( 0 minutes 3.521 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 @@ -307,7 +307,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.014 seconds)
**Total running time of the script:** ( 0 minutes 7.511 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 @@ -256,7 +256,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 6.475 seconds)
**Total running time of the script:** ( 0 minutes 5.143 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 @@ -432,7 +432,7 @@ Plot some components of the fiber orientation tensor.

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

**Total running time of the script:** ( 0 minutes 6.293 seconds)
**Total running time of the script:** ( 0 minutes 6.221 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 @@ -435,7 +435,7 @@ at each frequency, because we look only at the element that has the highest IRF
.. code-block:: none
[<matplotlib.lines.Line2D object at 0x7fc479119be0>]
[<matplotlib.lines.Line2D object at 0x7f0140736eb0>]
Expand Down Expand Up @@ -510,7 +510,7 @@ Compute critical layer and critical failure mode.
.. rst-class:: sphx-glr-timing

**Total running time of the script:** ( 0 minutes 15.202 seconds)
**Total running time of the script:** ( 0 minutes 10.973 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 @@ -113,7 +113,7 @@ Get input files (RST and material.engd but skip the ACP layup file).

.. code-block:: none
ContinuousFiberCompositesFiles(rst=['/tmp/dataProcessingTemp139920538588928/99349543-39b9-475f-ad59-97ab3cd2ee91/shell.rst'], composite={}, engineering_data='/tmp/dataProcessingTemp139920538588928/b23f018a-bdb9-4948-94f7-e32337060d98/material.engd', files_are_local=False)
ContinuousFiberCompositesFiles(rst=['/tmp/dataProcessingTemp140257290868480/3e40705a-520d-4c42-ad86-b97fd1cf962a/shell.rst'], composite={}, engineering_data='/tmp/dataProcessingTemp140257290868480/1a78bcb2-6bbe-41d3-91c6-6a19dd7702d3/material.engd', files_are_local=False)
Expand Down Expand Up @@ -265,7 +265,7 @@ With ACP Standalone (for constant material properties only):

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

**Total running time of the script:** ( 0 minutes 9.790 seconds)
**Total running time of the script:** ( 0 minutes 6.278 seconds)


.. _sphx_glr_download_examples_gallery_examples_011_rst_workflow.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ No mean stress correction is applied.
.. code-block:: none
[<matplotlib.lines.Line2D object at 0x7fc482ffaf10>]
[<matplotlib.lines.Line2D object at 0x7f01408c7640>]
Expand Down Expand Up @@ -378,15 +378,15 @@ Identify the element with the maximum damage
.. code-block:: none
The element with highest damage is 27.
The highest damage value is 4.4248551238187656e-07.
The highest damage value is 2.7816449870271834e-07.
.. rst-class:: sphx-glr-timing

**Total running time of the script:** ( 0 minutes 4.537 seconds)
**Total running time of the script:** ( 0 minutes 3.551 seconds)


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

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

**Total running time of the script:** ( 0 minutes 7.391 seconds)
**Total running time of the script:** ( 0 minutes 5.169 seconds)


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

Computation times
=================
**01:42.496** total execution time for **examples_gallery_examples** files:
**01:17.954** 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:20.547 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_001_failure_operator_example.py` (``001_failure_operator_example.py``) | 00:16.155 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_010_harmonic_example.py` (``010_harmonic_example.py``) | 00:15.202 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_010_harmonic_example.py` (``010_harmonic_example.py``) | 00:10.973 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_011_rst_workflow.py` (``011_rst_workflow.py``) | 00:09.790 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py` (``007_interlaminar_normal_stress_example.py``) | 00:07.511 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_002_sampling_point_example.py` (``002_sampling_point_example.py``) | 00:08.797 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_011_rst_workflow.py` (``011_rst_workflow.py``) | 00:06.278 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py` (``007_interlaminar_normal_stress_example.py``) | 00:08.014 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py` (``009_short_fiber_orientation_tensor.py``) | 00:06.221 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_099_dpf_composite_failure_workflow.py` (``099_dpf_composite_failure_workflow.py``) | 00:07.391 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_099_dpf_composite_failure_workflow.py` (``099_dpf_composite_failure_workflow.py``) | 00:05.169 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_008_assembly_example.py` (``008_assembly_example.py``) | 00:06.475 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_008_assembly_example.py` (``008_assembly_example.py``) | 00:05.143 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py` (``009_short_fiber_orientation_tensor.py``) | 00:06.293 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_002_sampling_point_example.py` (``002_sampling_point_example.py``) | 00:04.948 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_004_get_material_properties_example.py` (``004_get_material_properties_example.py``) | 00:05.095 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_004_get_material_properties_example.py` (``004_get_material_properties_example.py``) | 00:04.342 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_012_fatigue_example.py` (``012_fatigue_example.py``) | 00:04.537 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_012_fatigue_example.py` (``012_fatigue_example.py``) | 00:03.551 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py` (``006_filter_composite_data_example.py``) | 00:04.196 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py` (``006_filter_composite_data_example.py``) | 00:03.521 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_003_short_fiber_example.py` (``003_short_fiber_example.py``) | 00:03.403 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_003_short_fiber_example.py` (``003_short_fiber_example.py``) | 00:03.184 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``005_get_layup_properties_example.py``) | 00:02.755 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``005_get_layup_properties_example.py``) | 00:00.958 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
Original file line number Diff line number Diff line change
Expand Up @@ -575,8 +575,8 @@ <h1>add_interlaminar_normal_stresses<a class="headerlink" href="#add-interlamina
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>stresses</strong> (<a class="reference external" href="https://dpf.docs.pyansys.com/version/stable/api/ansys.dpf.core.fields_container.html#ansys.dpf.core.fields_container.FieldsContainer" title="(in PyDPF-Core v0.12.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldsContainer</span></code></a>) – Stresses fields container to add interlaminar normal stresses to.</p></li>
<li><p><strong>strains</strong> (<a class="reference external" href="https://dpf.docs.pyansys.com/version/stable/api/ansys.dpf.core.fields_container.html#ansys.dpf.core.fields_container.FieldsContainer" title="(in PyDPF-Core v0.12.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldsContainer</span></code></a>) – </p></li>
<li><p><strong>stresses</strong> (<a class="reference external" href="https://dpf.docs.pyansys.com/version/stable/api/ansys.dpf.core.fields_container.html#ansys.dpf.core.fields_container.FieldsContainer" title="(in PyDPF-Core v0.12.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldsContainer</span></code></a>) – Stresses fields container to add interlaminar normal stresses to.</p></li>
<li><p><strong>strains</strong> (<a class="reference external" href="https://dpf.docs.pyansys.com/version/stable/api/ansys.dpf.core.fields_container.html#ansys.dpf.core.fields_container.FieldsContainer" title="(in PyDPF-Core v0.12.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldsContainer</span></code></a>) – </p></li>
<li><p><strong>composite_definition_label</strong> (<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://docs.python.org/dev/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>], default: <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Label of the composite definition, which is the
dictionary key in the <a class="reference internal" href="ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.composite.html#ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.composite" title="ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.composite"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ContinuousFiberCompositesFiles.composite</span></code></a>
attribute. This parameter is only required for assemblies.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -563,11 +563,11 @@
<h1>core_model<a class="headerlink" href="#core-model" title="Permalink to this heading">#</a></h1>
<dl class="py property">
<dt class="sig sig-object py" id="ansys.dpf.composites.composite_model.CompositeModel.core_model">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">CompositeModel.</span></span><span class="sig-name descname"><span class="pre">core_model</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://dpf.docs.pyansys.com/version/stable/api/ansys.dpf.core.model.html#ansys.dpf.core.model.Model" title="(in PyDPF-Core v0.12.0)"><span class="pre">Model</span></a></em><a class="headerlink" href="#ansys.dpf.composites.composite_model.CompositeModel.core_model" title="Permalink to this definition">#</a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">CompositeModel.</span></span><span class="sig-name descname"><span class="pre">core_model</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://dpf.docs.pyansys.com/version/stable/api/ansys.dpf.core.model.html#ansys.dpf.core.model.Model" title="(in PyDPF-Core v0.12.1)"><span class="pre">Model</span></a></em><a class="headerlink" href="#ansys.dpf.composites.composite_model.CompositeModel.core_model" title="Permalink to this definition">#</a></dt>
<dd><p>Underlying DPF core model.</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://dpf.docs.pyansys.com/version/stable/api/ansys.dpf.core.model.html#ansys.dpf.core.model.Model" title="(in PyDPF-Core v0.12.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Model</span></code></a></p>
<dd class="field-odd"><p><a class="reference external" href="https://dpf.docs.pyansys.com/version/stable/api/ansys.dpf.core.model.html#ansys.dpf.core.model.Model" title="(in PyDPF-Core v0.12.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Model</span></code></a></p>
</dd>
</dl>
</dd></dl>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -592,7 +592,7 @@ <h1>evaluate_failure_criteria<a class="headerlink" href="#evaluate-failure-crite
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://dpf.docs.pyansys.com/version/stable/api/ansys.dpf.core.fields_container.html#ansys.dpf.core.fields_container.FieldsContainer" title="(in PyDPF-Core v0.12.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldsContainer</span></code></a></p>
<dd class="field-even"><p><a class="reference external" href="https://dpf.docs.pyansys.com/version/stable/api/ansys.dpf.core.fields_container.html#ansys.dpf.core.fields_container.FieldsContainer" title="(in PyDPF-Core v0.12.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldsContainer</span></code></a></p>
</dd>
</dl>
</dd></dl>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -573,7 +573,7 @@ <h1>get_layup_operator<a class="headerlink" href="#get-layup-operator" title="Pe
See the note about assemblies in the description for the <a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.html#ansys.dpf.composites.composite_model.CompositeModel" title="ansys.dpf.composites.composite_model.CompositeModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompositeModel</span></code></a> class.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://dpf.docs.pyansys.com/version/stable/api/ansys.dpf.core.dpf_operator.html#ansys.dpf.core.dpf_operator.Operator" title="(in PyDPF-Core v0.12.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Operator</span></code></a></p>
<dd class="field-even"><p><a class="reference external" href="https://dpf.docs.pyansys.com/version/stable/api/ansys.dpf.core.dpf_operator.html#ansys.dpf.core.dpf_operator.Operator" title="(in PyDPF-Core v0.12.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Operator</span></code></a></p>
</dd>
</dl>
</dd></dl>
Expand Down
Loading

0 comments on commit 7902c14

Please sign in to comment.