Skip to content

Commit

Permalink
DOC: update development documentation c71f5ef
Browse files Browse the repository at this point in the history
  • Loading branch information
janvonrickenbach committed Nov 8, 2024
1 parent 4b5701b commit 79fdffa
Show file tree
Hide file tree
Showing 116 changed files with 179 additions and 179 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 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 @@ -290,7 +290,7 @@ Scope failure evaluation by plies.

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

**Total running time of the script:** (0 minutes 32.768 seconds)
**Total running time of the script:** (0 minutes 33.505 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 @@ -349,7 +349,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 16.273 seconds)
**Total running time of the script:** (0 minutes 16.250 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 4.571 seconds)
**Total running time of the script:** (0 minutes 5.628 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 @@ -212,7 +212,7 @@ Implement a custom failure criterion: basic max strain

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

**Total running time of the script:** (0 minutes 8.971 seconds)
**Total running time of the script:** (0 minutes 9.276 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 @@ -168,7 +168,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 4.735 seconds)
**Total running time of the script:** (0 minutes 4.821 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 @@ -523,7 +523,7 @@ in the material direction in this ply.

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

**Total running time of the script:** (0 minutes 7.918 seconds)
**Total running time of the script:** (0 minutes 7.737 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 @@ -313,7 +313,7 @@ Plot s3 at the mid-plane of a certain ply.

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

**Total running time of the script:** (0 minutes 12.375 seconds)
**Total running time of the script:** (0 minutes 12.585 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 @@ -262,7 +262,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 11.293 seconds)
**Total running time of the script:** (0 minutes 11.055 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.045 seconds)
**Total running time of the script:** (0 minutes 5.946 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 @@ -434,7 +434,7 @@ at each frequency, because we look only at the element that has the highest IRF
.. code-block:: none
[<matplotlib.lines.Line2D object at 0x7f486dcab0b0>]
[<matplotlib.lines.Line2D object at 0x7f87646d2d80>]
Expand Down Expand Up @@ -509,7 +509,7 @@ Compute critical layer and critical failure mode.
.. rst-class:: sphx-glr-timing

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

.. code-block:: none
ContinuousFiberCompositesFiles(rst=['/tmp/dataProcessingTemp140272390362880/03ab0e9e-646c-4193-9087-8c45b893b7c0/shell.rst'], composite={}, engineering_data='/tmp/dataProcessingTemp140272390362880/ca3249bb-92d1-46da-9460-72ff0d7651f1/material.engd', files_are_local=False)
ContinuousFiberCompositesFiles(rst=['/tmp/dataProcessingTemp140590687704832/723f52f2-d658-4dba-a66b-d848485e78ae/shell.rst'], composite={}, engineering_data='/tmp/dataProcessingTemp140590687704832/2f95f7dd-2f7e-4250-97ad-dc948bc52acc/material.engd', files_are_local=False)
Expand Down Expand Up @@ -271,7 +271,7 @@ With ACP Standalone (for constant material properties only):

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

**Total running time of the script:** (0 minutes 17.695 seconds)
**Total running time of the script:** (0 minutes 17.110 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 @@ -208,7 +208,7 @@ No mean stress correction is applied.
.. code-block:: none
[<matplotlib.lines.Line2D object at 0x7f486dc49700>]
[<matplotlib.lines.Line2D object at 0x7f87657c71d0>]
Expand Down Expand Up @@ -384,15 +384,15 @@ Identify the element with the maximum damage
.. code-block:: none
The element with highest damage is 27.
The highest damage value is 3.145482040392385e-07.
The highest damage value is 6.6504173963657e-07.
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 7.111 seconds)
**Total running time of the script:** (0 minutes 6.886 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 @@ -256,7 +256,7 @@ is extracted for the material `Honeycomb Aluminum Alloy`.
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 8.421 seconds)
**Total running time of the script:** (0 minutes 8.270 seconds)


.. _sphx_glr_download_examples_gallery_examples_013_thermal_example.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ The same expansion is possible for strains and stresses. For more information, s

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

**Total running time of the script:** (0 minutes 14.779 seconds)
**Total running time of the script:** (0 minutes 15.150 seconds)


.. _sphx_glr_download_examples_gallery_examples_014_cyclic_symmetry_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 13.897 seconds)
**Total running time of the script:** (0 minutes 13.935 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 @@ -6,7 +6,7 @@

Computation times
=================
**03:14.294** total execution time for 15 files **from examples/gallery_examples**:
**03:15.372** total execution time for 15 files **from examples/gallery_examples**:

.. container::

Expand All @@ -33,47 +33,47 @@ Computation times
- Time
- Mem (MB)
* - :ref:`sphx_glr_examples_gallery_examples_001_failure_operator_example.py` (``001_failure_operator_example.py``)
- 00:32.768
- 00:33.505
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_010_harmonic_example.py` (``010_harmonic_example.py``)
- 00:27.441
- 00:27.217
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_011_rst_workflow.py` (``011_rst_workflow.py``)
- 00:17.695
- 00:17.110
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_002_sampling_point_example.py` (``002_sampling_point_example.py``)
- 00:16.273
- 00:16.250
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_014_cyclic_symmetry_example.py` (``014_cyclic_symmetry_example.py``)
- 00:14.779
- 00:15.150
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_099_dpf_composite_failure_workflow.py` (``099_dpf_composite_failure_workflow.py``)
- 00:13.897
- 00:13.935
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py` (``007_interlaminar_normal_stress_example.py``)
- 00:12.375
- 00:12.585
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_008_assembly_example.py` (``008_assembly_example.py``)
- 00:11.293
- 00:11.055
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_004_get_material_properties_example.py` (``004_get_material_properties_example.py``)
- 00:08.971
- 00:09.276
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_013_thermal_example.py` (``013_thermal_example.py``)
- 00:08.421
- 00:08.270
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py` (``006_filter_composite_data_example.py``)
- 00:07.918
- 00:07.737
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_012_fatigue_example.py` (``012_fatigue_example.py``)
- 00:07.111
- 00:06.886
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py` (``009_short_fiber_orientation_tensor.py``)
- 00:06.045
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``005_get_layup_properties_example.py``)
- 00:04.735
- 00:05.946
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_003_short_fiber_example.py` (``003_short_fiber_example.py``)
- 00:04.571
- 00:05.628
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``005_get_layup_properties_example.py``)
- 00:04.821
- 0.0
36 changes: 18 additions & 18 deletions version/dev/_sources/sg_execution_times.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Computation times
=================
**03:14.294** total execution time for 15 files **from all galleries**:
**03:15.372** total execution time for 15 files **from all galleries**:

.. container::

Expand All @@ -33,47 +33,47 @@ Computation times
- Time
- Mem (MB)
* - :ref:`sphx_glr_examples_gallery_examples_001_failure_operator_example.py` (``../../examples/001_failure_operator_example.py``)
- 00:32.768
- 00:33.505
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_010_harmonic_example.py` (``../../examples/010_harmonic_example.py``)
- 00:27.441
- 00:27.217
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_011_rst_workflow.py` (``../../examples/011_rst_workflow.py``)
- 00:17.695
- 00:17.110
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_002_sampling_point_example.py` (``../../examples/002_sampling_point_example.py``)
- 00:16.273
- 00:16.250
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_014_cyclic_symmetry_example.py` (``../../examples/014_cyclic_symmetry_example.py``)
- 00:14.779
- 00:15.150
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_099_dpf_composite_failure_workflow.py` (``../../examples/099_dpf_composite_failure_workflow.py``)
- 00:13.897
- 00:13.935
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py` (``../../examples/007_interlaminar_normal_stress_example.py``)
- 00:12.375
- 00:12.585
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_008_assembly_example.py` (``../../examples/008_assembly_example.py``)
- 00:11.293
- 00:11.055
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_004_get_material_properties_example.py` (``../../examples/004_get_material_properties_example.py``)
- 00:08.971
- 00:09.276
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_013_thermal_example.py` (``../../examples/013_thermal_example.py``)
- 00:08.421
- 00:08.270
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py` (``../../examples/006_filter_composite_data_example.py``)
- 00:07.918
- 00:07.737
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_012_fatigue_example.py` (``../../examples/012_fatigue_example.py``)
- 00:07.111
- 00:06.886
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py` (``../../examples/009_short_fiber_orientation_tensor.py``)
- 00:06.045
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``../../examples/005_get_layup_properties_example.py``)
- 00:04.735
- 00:05.946
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_003_short_fiber_example.py` (``../../examples/003_short_fiber_example.py``)
- 00:04.571
- 00:05.628
- 0.0
* - :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``../../examples/005_get_layup_properties_example.py``)
- 00:04.821
- 0.0
Original file line number Diff line number Diff line change
Expand Up @@ -568,8 +568,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.13.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.13.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.13.2)"><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.13.2)"><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.14)"><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.14)"><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 @@ -556,11 +556,11 @@
<h1>core_model<a class="headerlink" href="#core-model" title="Link 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.13.0)"><span class="pre">Model</span></a></em><a class="headerlink" href="#ansys.dpf.composites.composite_model.CompositeModel.core_model" title="Link 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.13.2)"><span class="pre">Model</span></a></em><a class="headerlink" href="#ansys.dpf.composites.composite_model.CompositeModel.core_model" title="Link 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.13.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.13.2)"><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 @@ -585,7 +585,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.13.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.13.2)"><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 @@ -566,7 +566,7 @@ <h1>get_layup_operator<a class="headerlink" href="#get-layup-operator" title="Li
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.13.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.13.2)"><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 79fdffa

Please sign in to comment.