Skip to content

Commit

Permalink
DOC: update development documentation d11e4be
Browse files Browse the repository at this point in the history
  • Loading branch information
roosre committed Sep 27, 2023
1 parent 49f4538 commit 5e8b66f
Show file tree
Hide file tree
Showing 161 changed files with 2,541 additions and 1,259 deletions.
2,056 changes: 1,031 additions & 1,025 deletions sitemap.xml

Large diffs are not rendered by default.

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
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 @@ -218,7 +218,7 @@ Scope failure evaluation by plies.

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

**Total running time of the script:** ( 0 minutes 28.855 seconds)
**Total running time of the script:** ( 0 minutes 25.059 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 16.513 seconds)
**Total running time of the script:** ( 0 minutes 13.322 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 @@ -235,7 +235,7 @@ Compute and plot the maximum failure value per element.

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

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

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

**Total running time of the script:** ( 0 minutes 7.900 seconds)
**Total running time of the script:** ( 0 minutes 7.390 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.782 seconds)
**Total running time of the script:** ( 0 minutes 1.729 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 @@ -273,7 +273,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 @@ -309,7 +309,7 @@ ID from an analysis ply.

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

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

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

**Total running time of the script:** ( 0 minutes 13.219 seconds)
**Total running time of the script:** ( 0 minutes 9.713 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 @@ -179,7 +179,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.905 seconds)
**Total running time of the script:** ( 0 minutes 6.780 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 @@ -302,7 +302,7 @@ Plot some components of the fiber orientation tensor.

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

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

**Total running time of the script:** ( 0 minutes 25.946 seconds)
**Total running time of the script:** ( 0 minutes 22.166 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 @@ -373,7 +373,7 @@ Plot the maximum and minimum values.

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

**Total running time of the script:** ( 0 minutes 13.646 seconds)
**Total running time of the script:** ( 0 minutes 12.460 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
=================
**02:09.959** total execution time for **examples_gallery_examples** files:
**01:50.396** 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:28.855 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_001_failure_operator_example.py` (``001_failure_operator_example.py``) | 00:25.059 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_010_harmonic_example.py` (``010_harmonic_example.py``) | 00:25.946 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_010_harmonic_example.py` (``010_harmonic_example.py``) | 00:22.166 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_002_sampling_point_example.py` (``002_sampling_point_example.py``) | 00:16.513 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_002_sampling_point_example.py` (``002_sampling_point_example.py``) | 00:13.322 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_011_dpf_composite_failure_workflow.py` (``011_dpf_composite_failure_workflow.py``) | 00:13.646 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_011_dpf_composite_failure_workflow.py` (``011_dpf_composite_failure_workflow.py``) | 00:12.460 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py` (``007_interlaminar_normal_stress_example.py``) | 00:13.219 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py` (``007_interlaminar_normal_stress_example.py``) | 00:09.713 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_004_get_material_properties_example.py` (``004_get_material_properties_example.py``) | 00:07.900 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_004_get_material_properties_example.py` (``004_get_material_properties_example.py``) | 00:07.390 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py` (``009_short_fiber_orientation_tensor.py``) | 00:07.216 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_008_assembly_example.py` (``008_assembly_example.py``) | 00:06.780 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_008_assembly_example.py` (``008_assembly_example.py``) | 00:06.905 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py` (``009_short_fiber_orientation_tensor.py``) | 00:04.842 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_003_short_fiber_example.py` (``003_short_fiber_example.py``) | 00:04.463 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_003_short_fiber_example.py` (``003_short_fiber_example.py``) | 00:04.724 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``005_get_layup_properties_example.py``) | 00:02.782 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py` (``006_filter_composite_data_example.py``) | 00:02.212 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py` (``006_filter_composite_data_example.py``) | 00:02.516 | 0.0 MB |
| :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``005_get_layup_properties_example.py``) | 00:01.729 | 0.0 MB |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
2 changes: 1 addition & 1 deletion version/0.3/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ Limitations
.. _Ansys Workbench: https://download.ansys.com/Current%20Release
.. _Import of Legacy Mechanical APDL Composite Models: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v231/en/acp_ug/acp_import_legacy_APDL_comp.html
.. _Compatibility: https://dpf.docs.pyansys.com/version/stable/getting_started/compatibility.html
.. _Ansys DPF: https://dpf.docs.pyansys.com/version/stable/
.. _Ansys DPF: https://dpf.docs.pyansys.com/version/stable/
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 5e8b66f

Please sign in to comment.