Skip to content

Commit

Permalink
DOC: update development documentation e0d770c
Browse files Browse the repository at this point in the history
  • Loading branch information
roosre committed Sep 26, 2023
1 parent 716e359 commit aa884b6
Show file tree
Hide file tree
Showing 73 changed files with 708 additions and 67 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: ae979f34dff61e9cd11a9e24f539c26a
config: b5c3f2b76442632f0f946a166b832495
tags: 645f666f9bcd5a90fca523b33c5a78b7
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
from ansys.dpf.composites.layup_info import (
AnalysisPlyInfoProvider,
get_all_analysis_ply_names,
get_dpf_material_id_by_analyis_ply_map,
get_dpf_material_id_by_analysis_ply_map,
)
from ansys.dpf.composites.select_indices import (
get_selected_indices,
Expand Down Expand Up @@ -123,7 +123,7 @@
# Note: It is not possible to get a DPF material ID for a
# given material name. It is only possible to get a DPF material
# ID from an analysis ply.
material_map = get_dpf_material_id_by_analyis_ply_map(
material_map = get_dpf_material_id_by_analysis_ply_map(
composite_model.get_mesh(), data_source_or_streams_provider=composite_model.data_sources.rst
)
ud_material_id = material_map["P1L1__ud_patch ns1"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
},
"outputs": [],
"source": [
"import ansys.dpf.core as dpf\nimport numpy as np\n\nfrom ansys.dpf.composites.composite_model import CompositeModel\nfrom ansys.dpf.composites.constants import Spot, Sym3x3TensorComponent\nfrom ansys.dpf.composites.example_helper import get_continuous_fiber_example_files\nfrom ansys.dpf.composites.layup_info import (\n AnalysisPlyInfoProvider,\n get_all_analysis_ply_names,\n get_dpf_material_id_by_analyis_ply_map,\n)\nfrom ansys.dpf.composites.select_indices import (\n get_selected_indices,\n get_selected_indices_by_analysis_ply,\n get_selected_indices_by_dpf_material_ids,\n)\nfrom ansys.dpf.composites.server_helpers import connect_to_or_start_server"
"import ansys.dpf.core as dpf\nimport numpy as np\n\nfrom ansys.dpf.composites.composite_model import CompositeModel\nfrom ansys.dpf.composites.constants import Spot, Sym3x3TensorComponent\nfrom ansys.dpf.composites.example_helper import get_continuous_fiber_example_files\nfrom ansys.dpf.composites.layup_info import (\n AnalysisPlyInfoProvider,\n get_all_analysis_ply_names,\n get_dpf_material_id_by_analysis_ply_map,\n)\nfrom ansys.dpf.composites.select_indices import (\n get_selected_indices,\n get_selected_indices_by_analysis_ply,\n get_selected_indices_by_dpf_material_ids,\n)\nfrom ansys.dpf.composites.server_helpers import connect_to_or_start_server"
]
},
{
Expand Down Expand Up @@ -177,7 +177,7 @@
},
"outputs": [],
"source": [
"material_map = get_dpf_material_id_by_analyis_ply_map(\n composite_model.get_mesh(), data_source_or_streams_provider=composite_model.data_sources.rst\n)\nud_material_id = material_map[\"P1L1__ud_patch ns1\"]\ncomponent = Sym3x3TensorComponent.TENSOR11\n\nmaterial_result_field = dpf.field.Field(location=dpf.locations.elemental, nature=dpf.natures.scalar)\nwith material_result_field.as_local_field() as local_result_field:\n element_ids = analysis_ply_info_provider.property_field.scoping.ids\n\n for element_id in element_ids:\n stress_data = stress_field.get_entity_data_by_id(element_id)\n element_info = composite_model.get_element_info(element_id)\n assert element_info is not None\n\n selected_indices = get_selected_indices_by_dpf_material_ids(element_info, [ud_material_id])\n\n value = np.max(stress_data[selected_indices][:, component])\n local_result_field.append([value], element_id)\n\ncomposite_model.get_mesh().plot(material_result_field)"
"material_map = get_dpf_material_id_by_analysis_ply_map(\n composite_model.get_mesh(), data_source_or_streams_provider=composite_model.data_sources.rst\n)\nud_material_id = material_map[\"P1L1__ud_patch ns1\"]\ncomponent = Sym3x3TensorComponent.TENSOR11\n\nmaterial_result_field = dpf.field.Field(location=dpf.locations.elemental, nature=dpf.natures.scalar)\nwith material_result_field.as_local_field() as local_result_field:\n element_ids = analysis_ply_info_provider.property_field.scoping.ids\n\n for element_id in element_ids:\n stress_data = stress_field.get_entity_data_by_id(element_id)\n element_info = composite_model.get_element_info(element_id)\n assert element_info is not None\n\n selected_indices = get_selected_indices_by_dpf_material_ids(element_info, [ud_material_id])\n\n value = np.max(stress_data[selected_indices][:, component])\n local_result_field.append([value], element_id)\n\ncomposite_model.get_mesh().plot(material_result_field)"
]
}
],
Expand Down
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
@@ -0,0 +1,6 @@
material\_names
===============

.. currentmodule:: ansys.dpf.composites.composite_model

.. autoproperty:: CompositeModel.material_names
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ CompositeModel
CompositeModel.composite_files
CompositeModel.core_model
CompositeModel.data_sources
CompositeModel.material_names
CompositeModel.material_operators


Expand Down
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 12.689 seconds)
**Total running time of the script:** ( 0 minutes 14.600 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 6.392 seconds)
**Total running time of the script:** ( 0 minutes 6.566 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.063 seconds)
**Total running time of the script:** ( 0 minutes 4.861 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.556 seconds)
**Total running time of the script:** ( 0 minutes 3.648 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.689 seconds)
**Total running time of the script:** ( 0 minutes 0.632 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 @@ -51,7 +51,7 @@ Import dependencies.
from ansys.dpf.composites.layup_info import (
AnalysisPlyInfoProvider,
get_all_analysis_ply_names,
get_dpf_material_id_by_analyis_ply_map,
get_dpf_material_id_by_analysis_ply_map,
)
from ansys.dpf.composites.select_indices import (
get_selected_indices,
Expand Down Expand Up @@ -269,7 +269,7 @@ ID from an analysis ply.
.. code-block:: default
material_map = get_dpf_material_id_by_analyis_ply_map(
material_map = get_dpf_material_id_by_analysis_ply_map(
composite_model.get_mesh(), data_source_or_streams_provider=composite_model.data_sources.rst
)
ud_material_id = material_map["P1L1__ud_patch ns1"]
Expand Down 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.482 seconds)
**Total running time of the script:** ( 0 minutes 3.551 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.778 seconds)
**Total running time of the script:** ( 0 minutes 8.527 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.932 seconds)
**Total running time of the script:** ( 0 minutes 4.658 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 7.914 seconds)
**Total running time of the script:** ( 0 minutes 7.425 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 0x7f8b1acaa580>]
[<matplotlib.lines.Line2D object at 0x7f6a34157d30>]
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.843 seconds)
**Total running time of the script:** ( 0 minutes 12.049 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 4.675 seconds)
**Total running time of the script:** ( 0 minutes 6.450 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:09.014** total execution time for **examples_gallery_examples** files:
**01:12.966** 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:12.689 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_001_failure_operator_example.py` (``001_failure_operator_example.py``) | 00:14.600 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_010_harmonic_example.py` (``010_harmonic_example.py``) | 00:11.843 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_010_harmonic_example.py` (``010_harmonic_example.py``) | 00:12.049 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py` (``007_interlaminar_normal_stress_example.py``) | 00:08.778 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py` (``007_interlaminar_normal_stress_example.py``) | 00:08.527 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py` (``009_short_fiber_orientation_tensor.py``) | 00:07.914 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py` (``009_short_fiber_orientation_tensor.py``) | 00:07.425 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_002_sampling_point_example.py` (``002_sampling_point_example.py``) | 00:06.392 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_002_sampling_point_example.py` (``002_sampling_point_example.py``) | 00:06.566 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_003_short_fiber_example.py` (``003_short_fiber_example.py``) | 00:05.063 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_011_dpf_composite_failure_workflow.py` (``011_dpf_composite_failure_workflow.py``) | 00:06.450 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_011_dpf_composite_failure_workflow.py` (``011_dpf_composite_failure_workflow.py``) | 00:04.675 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_003_short_fiber_example.py` (``003_short_fiber_example.py``) | 00:04.861 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_008_assembly_example.py` (``008_assembly_example.py``) | 00:03.932 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_008_assembly_example.py` (``008_assembly_example.py``) | 00:04.658 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_004_get_material_properties_example.py` (``004_get_material_properties_example.py``) | 00:03.556 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_004_get_material_properties_example.py` (``004_get_material_properties_example.py``) | 00:03.648 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py` (``006_filter_composite_data_example.py``) | 00:03.482 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py` (``006_filter_composite_data_example.py``) | 00:03.551 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``005_get_layup_properties_example.py``) | 00:00.689 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``005_get_layup_properties_example.py``) | 00:00.632 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
Original file line number Diff line number Diff line change
Expand Up @@ -448,6 +448,7 @@ <h3>Navigation</h3>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.composite_files.html">composite_files</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.core_model.html">core_model</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.data_sources.html">data_sources</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.material_names.html">material_names</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.material_operators.html">material_operators</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -448,6 +448,7 @@ <h3>Navigation</h3>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.composite_files.html">composite_files</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.core_model.html">core_model</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.data_sources.html">data_sources</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.material_names.html">material_names</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.material_operators.html">material_operators</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -448,6 +448,7 @@ <h3>Navigation</h3>
<li class="toctree-l3 current active"><a class="current reference internal" href="#">composite_files</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.core_model.html">core_model</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.data_sources.html">data_sources</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.material_names.html">material_names</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.material_operators.html">material_operators</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -448,6 +448,7 @@ <h3>Navigation</h3>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.composite_files.html">composite_files</a></li>
<li class="toctree-l3 current active"><a class="current reference internal" href="#">core_model</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.data_sources.html">data_sources</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.material_names.html">material_names</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.material_operators.html">material_operators</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<link rel="shortcut icon" href="../../_static/ansys-favicon.png"/>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="material_operators" href="ansys.dpf.composites.composite_model.CompositeModel.material_operators.html" />
<link rel="next" title="material_names" href="ansys.dpf.composites.composite_model.CompositeModel.material_names.html" />
<link rel="prev" title="core_model" href="ansys.dpf.composites.composite_model.CompositeModel.core_model.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
Expand Down Expand Up @@ -448,6 +448,7 @@ <h3>Navigation</h3>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.composite_files.html">composite_files</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.core_model.html">core_model</a></li>
<li class="toctree-l3 current active"><a class="current reference internal" href="#">data_sources</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.material_names.html">material_names</a></li>
<li class="toctree-l3"><a class="reference internal" href="ansys.dpf.composites.composite_model.CompositeModel.material_operators.html">material_operators</a></li>
</ul>
</li>
Expand Down
Loading

0 comments on commit aa884b6

Please sign in to comment.