DOC: update development documentation e8dfb77

version/dev/.buildinfo

@@ -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: 4cb96e7a3a269c20fe00af8a98e05357
+config: 4b29727a6e544018047dcaecadf69755
 tags: 645f666f9bcd5a90fca523b33c5a78b7

version/dev/_sources/examples/gallery_examples/001_failure_operator_example.rst.txt

@@ -212,7 +212,7 @@ Scope failure evaluation by plies.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** ( 0 minutes  15.566 seconds)
+   **Total running time of the script:** ( 0 minutes  33.120 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_001_failure_operator_example.py:

version/dev/_sources/examples/gallery_examples/002_sampling_point_example.rst.txt

@@ -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.513 seconds)
+   **Total running time of the script:** ( 0 minutes  14.825 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_002_sampling_point_example.py:

version/dev/_sources/examples/gallery_examples/003_short_fiber_example.rst.txt

@@ -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.075 seconds)
+   **Total running time of the script:** ( 0 minutes  7.496 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_003_short_fiber_example.py:

version/dev/_sources/examples/gallery_examples/004_get_material_properties_example.rst.txt

@@ -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.690 seconds)
+   **Total running time of the script:** ( 0 minutes  8.901 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_004_get_material_properties_example.py:

version/dev/_sources/examples/gallery_examples/005_get_layup_properties_example.rst.txt

@@ -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.612 seconds)
+   **Total running time of the script:** ( 0 minutes  2.588 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_005_get_layup_properties_example.py:

version/dev/_sources/examples/gallery_examples/006_filter_composite_data_example.rst.txt

@@ -303,7 +303,7 @@ ID from an analysis ply.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** ( 0 minutes  3.492 seconds)
+   **Total running time of the script:** ( 0 minutes  6.207 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_006_filter_composite_data_example.py:

version/dev/_sources/examples/gallery_examples/007_interlaminar_normal_stress_example.rst.txt

@@ -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.253 seconds)
+   **Total running time of the script:** ( 0 minutes  13.481 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_007_interlaminar_normal_stress_example.py:

version/dev/_sources/examples/gallery_examples/008_assembly_example.rst.txt

@@ -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  4.746 seconds)
+   **Total running time of the script:** ( 0 minutes  9.324 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_008_assembly_example.py:

version/dev/_sources/examples/gallery_examples/009_short_fiber_orientation_tensor.rst.txt

@@ -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.405 seconds)
+   **Total running time of the script:** ( 0 minutes  10.065 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_009_short_fiber_orientation_tensor.py:

version/dev/_sources/examples/gallery_examples/010_harmonic_example.rst.txt

@@ -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 0x7f462c610b20>]
+    [<matplotlib.lines.Line2D object at 0x7f80f63fd1f0>]
 
 
 
@@ -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.065 seconds)
+   **Total running time of the script:** ( 0 minutes  24.598 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_010_harmonic_example.py:

version/dev/_sources/examples/gallery_examples/011_dpf_composite_failure_workflow.rst.txt

@@ -371,7 +371,7 @@ Plot the maximum and minimum values.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** ( 0 minutes  5.703 seconds)
+   **Total running time of the script:** ( 0 minutes  15.552 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_011_dpf_composite_failure_workflow.py:

version/dev/_sources/examples/gallery_examples/sg_execution_times.rst.txt

@@ -5,28 +5,28 @@
 
 Computation times
 =================
-**01:12.121** total execution time for **examples_gallery_examples** files:
+**02:26.156** 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:15.566 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_001_failure_operator_example.py` (``001_failure_operator_example.py``)                     | 00:33.120 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_010_harmonic_example.py` (``010_harmonic_example.py``)                                     | 00:11.065 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_010_harmonic_example.py` (``010_harmonic_example.py``)                                     | 00:24.598 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py` (``007_interlaminar_normal_stress_example.py``) | 00:08.253 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_011_dpf_composite_failure_workflow.py` (``011_dpf_composite_failure_workflow.py``)         | 00:15.552 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py` (``009_short_fiber_orientation_tensor.py``)         | 00:07.405 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_002_sampling_point_example.py` (``002_sampling_point_example.py``)                         | 00:14.825 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_002_sampling_point_example.py` (``002_sampling_point_example.py``)                         | 00:06.513 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py` (``007_interlaminar_normal_stress_example.py``) | 00:13.481 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_011_dpf_composite_failure_workflow.py` (``011_dpf_composite_failure_workflow.py``)         | 00:05.703 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py` (``009_short_fiber_orientation_tensor.py``)         | 00:10.065 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_003_short_fiber_example.py` (``003_short_fiber_example.py``)                               | 00:05.075 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_008_assembly_example.py` (``008_assembly_example.py``)                                     | 00:09.324 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_008_assembly_example.py` (``008_assembly_example.py``)                                     | 00:04.746 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_004_get_material_properties_example.py` (``004_get_material_properties_example.py``)       | 00:08.901 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_004_get_material_properties_example.py` (``004_get_material_properties_example.py``)       | 00:03.690 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_003_short_fiber_example.py` (``003_short_fiber_example.py``)                               | 00:07.496 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py` (``006_filter_composite_data_example.py``)           | 00:03.492 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py` (``006_filter_composite_data_example.py``)           | 00:06.207 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``005_get_layup_properties_example.py``)             | 00:00.612 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``005_get_layup_properties_example.py``)             | 00:02.588 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+

version/dev/_static/css/meilisearch.css

@@ -82,7 +82,7 @@ div[data-ds-theme] .searchbox input {
 .container {
   display: flex;
   justify-content: center;
-  align-items: center;
+  align-items: right;
 }
 
 div[data-ds-theme] .meilisearch-autocomplete {
@@ -92,23 +92,12 @@ div[data-ds-theme] .meilisearch-autocomplete {
 
 #search-bar-input {
   background-color: var(--pst-color-background);
-  border: 1px solid var(--pst-color-border);
-  border-radius: 0.25rem;
   color: var(--pst-color-text-base);
   font-size: var(--pst-font-size-icon);
   position: relative;
-  padding-left: 3rem;
-}
-
-.meilisearch-autocomplete::before {
-  content: "\f002";
-  font-family: "Font Awesome 6 Free";
-  position: absolute;
-  left: 8px;
-  top: 50%;
-  transform: translateY(-50%);
-  font-size: 1rem;
-  color: var(--pst-color-border);
+  padding-left: 1rem;
+  outline-color: var(--pst-color-border);
+  margin-left: 1rem;
 }
 
 .index-select {
@@ -197,4 +186,9 @@ div[data-ds-theme]
 
 .bd-search {
   margin-bottom: 200px;
+  gap: 0em;
+  border: 0px solid var(--pst-color-border);
+}
+#search-icon {
+  font-size: 1.5rem;
 }

version/dev/_static/js/meilisearch_theme_wrap.js

@@ -8,19 +8,49 @@ require.config({
 require(["docsSearchBar"], function (docsSearchBar) {
   document.body.style.overflow = "hidden !important";
   // Initialize the MeiliSearch bar with the given API key and host
-  // inspect the first value of index UID as default
-
   var theSearchBar = docsSearchBar({
     hostUrl: HOST_URL,
     apiKey: API_KEY,
     indexUid: indexUid,
     inputSelector: "#search-bar-input",
     debug: true, // Set debug to true if you want to inspect the dropdown
     meilisearchOptions: {
-      limit: 1000,
+      limit: 10,
     },
   });
 
+  // Function to show the magnifier icon
+  function showMagnifierIcon() {
+    var searchIcon = document.getElementById("search-icon");
+    searchIcon.classList.remove("fa-spinner", "fa-spin"); // Remove spinner classes
+    searchIcon.classList.add("fa-magnifying-glass"); // Add magnifier icon class
+  }
+
+  // Function to show the spinner icon
+  function showSpinnerIcon() {
+    var searchIcon = document.getElementById("search-icon");
+    if (searchIcon) {
+      searchIcon.classList.remove("fa-magnifying-glass"); // Remove magnifier icon class
+      searchIcon.classList.add("fa-spinner", "fa-spin"); // Add spinner classes
+    }
+  }
+
+  document
+    .getElementById("search-bar-input")
+    .addEventListener("input", function () {
+      const inputValue = this.value.trim(); // Trim whitespace from input value
+      // Show the spinner icon only when there is input and no suggestions
+      if (
+        inputValue &&
+        document.querySelectorAll(".dsb-suggestion").length === 0
+      ) {
+        showSpinnerIcon();
+      } else {
+        // Hide the spinner icon when there are suggestions
+        showMagnifierIcon();
+      }
+    });
+
   // Listen for changes in the dropdown selector and update the index uid and suggestion accordingly
   document
     .getElementById("indexUidSelector")
@@ -29,22 +59,4 @@ require(["docsSearchBar"], function (docsSearchBar) {
       theSearchBar.suggestionIndexUid = this.value;
       theSearchBar.autocomplete.autocomplete.setVal("");
     });
-
-  // Listen for changes in the search bar input and update the suggestion accordingly
-  document
-    .getElementById("search-bar-input")
-    .addEventListener("change", function () {
-      theSearchBar.suggestionIndexUid =
-        document.getElementById("indexUidSelector").value;
-    });
-
-  // Set the focus on the search bar input
-  document.getElementById("searchbar").focus();
-
-  // Set the focus on the dropdown selector
-  document
-    .getElementById("searchbar")
-    .addEventListener("indexUidSelector", function () {
-      theSearchBar.autocomplete.autocomplete.close();
-    });
 });

version/dev/api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.add_interlaminar_normal_stresses.html

@@ -644,7 +644,7 @@ <h1>add_interlaminar_normal_stresses<a class="headerlink" href="#add-interlamina
   <a href="https://sphinxdocs.ansys.com/version/stable/index.html"
     >Ansys Sphinx Theme</a
   >
-  0.12.2. <br />Last updated on
+  0.12.3. <br />Last updated on
   <span id="date"></span>
 </p>
 <script>

version/dev/api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_definition_labels.html

@@ -626,7 +626,7 @@ <h1>composite_definition_labels<a class="headerlink" href="#composite-definition
   <a href="https://sphinxdocs.ansys.com/version/stable/index.html"
     >Ansys Sphinx Theme</a
   >
-  0.12.2. <br />Last updated on
+  0.12.3. <br />Last updated on
   <span id="date"></span>
 </p>
 <script>

version/dev/api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_files.html

@@ -625,7 +625,7 @@ <h1>composite_files<a class="headerlink" href="#composite-files" title="Permalin
   <a href="https://sphinxdocs.ansys.com/version/stable/index.html"
     >Ansys Sphinx Theme</a
   >
-  0.12.2. <br />Last updated on
+  0.12.3. <br />Last updated on
   <span id="date"></span>
 </p>
 <script>

version/dev/api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.core_model.html

@@ -625,7 +625,7 @@ <h1>core_model<a class="headerlink" href="#core-model" title="Permalink to this
   <a href="https://sphinxdocs.ansys.com/version/stable/index.html"
     >Ansys Sphinx Theme</a
   >
-  0.12.2. <br />Last updated on
+  0.12.3. <br />Last updated on
   <span id="date"></span>
 </p>
 <script>

version/dev/api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.data_sources.html

@@ -625,7 +625,7 @@ <h1>data_sources<a class="headerlink" href="#data-sources" title="Permalink to t
   <a href="https://sphinxdocs.ansys.com/version/stable/index.html"
     >Ansys Sphinx Theme</a
   >
-  0.12.2. <br />Last updated on
+  0.12.3. <br />Last updated on
   <span id="date"></span>
 </p>
 <script>

version/dev/api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.evaluate_failure_criteria.html

@@ -649,7 +649,7 @@ <h1>evaluate_failure_criteria<a class="headerlink" href="#evaluate-failure-crite
   <a href="https://sphinxdocs.ansys.com/version/stable/index.html"
     >Ansys Sphinx Theme</a
   >
-  0.12.2. <br />Last updated on
+  0.12.3. <br />Last updated on
   <span id="date"></span>
 </p>
 <script>

version/dev/api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids.html

@@ -625,7 +625,7 @@ <h1>get_all_layered_element_ids<a class="headerlink" href="#get-all-layered-elem
   <a href="https://sphinxdocs.ansys.com/version/stable/index.html"
     >Ansys Sphinx Theme</a
   >
-  0.12.2. <br />Last updated on
+  0.12.3. <br />Last updated on
   <span id="date"></span>
 </p>
 <script>

version/dev/api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids_for_composite_definition_label.html

@@ -631,7 +631,7 @@ <h1>get_all_layered_element_ids_for_composite_definition_label<a class="headerli
   <a href="https://sphinxdocs.ansys.com/version/stable/index.html"
     >Ansys Sphinx Theme</a
   >
-  0.12.2. <br />Last updated on
+  0.12.3. <br />Last updated on
   <span id="date"></span>
 </p>
 <script>

version/dev/api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_analysis_plies.html

@@ -637,7 +637,7 @@ <h1>get_analysis_plies<a class="headerlink" href="#get-analysis-plies" title="Pe
   <a href="https://sphinxdocs.ansys.com/version/stable/index.html"
     >Ansys Sphinx Theme</a
   >
-  0.12.2. <br />Last updated on
+  0.12.3. <br />Last updated on
   <span id="date"></span>
 </p>
 <script>

version/dev/api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_constant_property_dict.html

@@ -642,7 +642,7 @@ <h1>get_constant_property_dict<a class="headerlink" href="#get-constant-property
   <a href="https://sphinxdocs.ansys.com/version/stable/index.html"
     >Ansys Sphinx Theme</a
   >
-  0.12.2. <br />Last updated on
+  0.12.3. <br />Last updated on
   <span id="date"></span>
 </p>
 <script>

version/dev/api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_info.html

@@ -635,7 +635,7 @@ <h1>get_element_info<a class="headerlink" href="#get-element-info" title="Permal
   <a href="https://sphinxdocs.ansys.com/version/stable/index.html"
     >Ansys Sphinx Theme</a
   >
-  0.12.2. <br />Last updated on
+  0.12.3. <br />Last updated on
   <span id="date"></span>
 </p>
 <script>

version/dev/api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_laminate_offset.html

@@ -635,7 +635,7 @@ <h1>get_element_laminate_offset<a class="headerlink" href="#get-element-laminate
   <a href="https://sphinxdocs.ansys.com/version/stable/index.html"
     >Ansys Sphinx Theme</a
   >
-  0.12.2. <br />Last updated on
+  0.12.3. <br />Last updated on
   <span id="date"></span>
 </p>
 <script>

version/dev/api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_layup_operator.html

@@ -631,7 +631,7 @@ <h1>get_layup_operator<a class="headerlink" href="#get-layup-operator" title="Pe
   <a href="https://sphinxdocs.ansys.com/version/stable/index.html"
     >Ansys Sphinx Theme</a
   >
-  0.12.2. <br />Last updated on
+  0.12.3. <br />Last updated on
   <span id="date"></span>
 </p>
 <script>