DOC: update development documentation a904b3c

ansys · Oct 9, 2023 · 5f2ea4c · 5f2ea4c
1 parent c5f4b83
commit 5f2ea4c
Show file tree

Hide file tree

Showing 559 changed files with 54,729 additions and 34,397 deletions.
diff --git a/version/dev/.buildinfo b/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: 54753e202c0f9c5626a7cdb289f37351
+config: a1f46fead32e7648c85454e05eab7206
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/version/dev/_images/sphx_glr_001_failure_operator_example_001.vtksz b/version/dev/_images/sphx_glr_001_failure_operator_example_001.vtksz
diff --git a/version/dev/_images/sphx_glr_001_failure_operator_example_002.vtksz b/version/dev/_images/sphx_glr_001_failure_operator_example_002.vtksz
diff --git a/version/dev/_images/sphx_glr_001_failure_operator_example_003.vtksz b/version/dev/_images/sphx_glr_001_failure_operator_example_003.vtksz
diff --git a/version/dev/_images/sphx_glr_003_short_fiber_example_001.vtksz b/version/dev/_images/sphx_glr_003_short_fiber_example_001.vtksz
diff --git a/version/dev/_images/sphx_glr_003_short_fiber_example_002.vtksz b/version/dev/_images/sphx_glr_003_short_fiber_example_002.vtksz
diff --git a/version/dev/_images/sphx_glr_003_short_fiber_example_003.vtksz b/version/dev/_images/sphx_glr_003_short_fiber_example_003.vtksz
diff --git a/version/dev/_images/sphx_glr_004_get_material_properties_example_001.vtksz b/version/dev/_images/sphx_glr_004_get_material_properties_example_001.vtksz
diff --git a/version/dev/_images/sphx_glr_006_filter_composite_data_example_001.vtksz b/version/dev/_images/sphx_glr_006_filter_composite_data_example_001.vtksz
diff --git a/version/dev/_images/sphx_glr_006_filter_composite_data_example_002.vtksz b/version/dev/_images/sphx_glr_006_filter_composite_data_example_002.vtksz
diff --git a/version/dev/_images/sphx_glr_006_filter_composite_data_example_003.vtksz b/version/dev/_images/sphx_glr_006_filter_composite_data_example_003.vtksz
diff --git a/version/dev/_images/sphx_glr_007_interlaminar_normal_stress_example_001.vtksz b/version/dev/_images/sphx_glr_007_interlaminar_normal_stress_example_001.vtksz
diff --git a/version/dev/_images/sphx_glr_007_interlaminar_normal_stress_example_002.vtksz b/version/dev/_images/sphx_glr_007_interlaminar_normal_stress_example_002.vtksz
diff --git a/version/dev/_images/sphx_glr_008_assembly_example_001.vtksz b/version/dev/_images/sphx_glr_008_assembly_example_001.vtksz
diff --git a/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_001.vtksz b/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_001.vtksz
diff --git a/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_002.vtksz b/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_002.vtksz
diff --git a/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_003.vtksz b/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_003.vtksz
diff --git a/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_004.vtksz b/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_004.vtksz
diff --git a/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_005.vtksz b/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_005.vtksz
diff --git a/version/dev/_images/sphx_glr_010_harmonic_example_001.vtksz b/version/dev/_images/sphx_glr_010_harmonic_example_001.vtksz
diff --git a/version/dev/_images/sphx_glr_011_dpf_composite_failure_workflow_001.vtksz b/version/dev/_images/sphx_glr_011_dpf_composite_failure_workflow_001.vtksz
diff --git a/...ion/dev/_sources/examples/gallery_examples/001_failure_operator_example.rst.txt b/...ion/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  31.692 seconds)
+   **Total running time of the script:** ( 0 minutes  15.575 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_001_failure_operator_example.py:

diff --git a/version/dev/_sources/examples/gallery_examples/002_sampling_point_example.rst.txt b/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  14.823 seconds)
+   **Total running time of the script:** ( 0 minutes  6.440 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_002_sampling_point_example.py:

diff --git a/version/dev/_sources/examples/gallery_examples/003_short_fiber_example.rst.txt b/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  6.417 seconds)
+   **Total running time of the script:** ( 0 minutes  4.756 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_003_short_fiber_example.py:

diff --git a/.../_sources/examples/gallery_examples/004_get_material_properties_example.rst.txt b/.../_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  9.360 seconds)
+   **Total running time of the script:** ( 0 minutes  3.860 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_004_get_material_properties_example.py:

diff --git a/...dev/_sources/examples/gallery_examples/005_get_layup_properties_example.rst.txt b/...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  2.562 seconds)
+   **Total running time of the script:** ( 0 minutes  1.454 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_005_get_layup_properties_example.py:

diff --git a/...ev/_sources/examples/gallery_examples/006_filter_composite_data_example.rst.txt b/...ev/_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  4.817 seconds)
+   **Total running time of the script:** ( 0 minutes  4.315 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_006_filter_composite_data_example.py:

diff --git a/...ources/examples/gallery_examples/007_interlaminar_normal_stress_example.rst.txt b/...ources/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  12.787 seconds)
+   **Total running time of the script:** ( 0 minutes  8.748 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_007_interlaminar_normal_stress_example.py:

diff --git a/version/dev/_sources/examples/gallery_examples/008_assembly_example.rst.txt b/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  9.281 seconds)
+   **Total running time of the script:** ( 0 minutes  4.101 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_008_assembly_example.py:

diff --git a/...v/_sources/examples/gallery_examples/009_short_fiber_orientation_tensor.rst.txt b/...v/_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  9.274 seconds)
+   **Total running time of the script:** ( 0 minutes  8.574 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_009_short_fiber_orientation_tensor.py:

diff --git a/version/dev/_sources/examples/gallery_examples/010_harmonic_example.rst.txt b/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 0x7f5476caf190>]
+    [<matplotlib.lines.Line2D object at 0x7f350b184880>]
 
 
 
@@ -484,7 +484,7 @@ Compute critical layer and critical failure mode.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** ( 0 minutes  25.451 seconds)
+   **Total running time of the script:** ( 0 minutes  12.773 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_010_harmonic_example.py:

diff --git a/...v/_sources/examples/gallery_examples/011_dpf_composite_failure_workflow.rst.txt b/...v/_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  15.455 seconds)
+   **Total running time of the script:** ( 0 minutes  5.910 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_011_dpf_composite_failure_workflow.py:

diff --git a/version/dev/_sources/examples/gallery_examples/sg_execution_times.rst.txt b/version/dev/_sources/examples/gallery_examples/sg_execution_times.rst.txt
@@ -5,28 +5,28 @@
 
 Computation times
 =================
-**02:21.919** total execution time for **examples_gallery_examples** files:
+**01:16.505** 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:31.692 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_001_failure_operator_example.py` (``001_failure_operator_example.py``)                     | 00:15.575 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_010_harmonic_example.py` (``010_harmonic_example.py``)                                     | 00:25.451 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_010_harmonic_example.py` (``010_harmonic_example.py``)                                     | 00:12.773 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_011_dpf_composite_failure_workflow.py` (``011_dpf_composite_failure_workflow.py``)         | 00:15.455 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py` (``007_interlaminar_normal_stress_example.py``) | 00:08.748 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_002_sampling_point_example.py` (``002_sampling_point_example.py``)                         | 00:14.823 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py` (``009_short_fiber_orientation_tensor.py``)         | 00:08.574 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py` (``007_interlaminar_normal_stress_example.py``) | 00:12.787 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_002_sampling_point_example.py` (``002_sampling_point_example.py``)                         | 00:06.440 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_004_get_material_properties_example.py` (``004_get_material_properties_example.py``)       | 00:09.360 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_011_dpf_composite_failure_workflow.py` (``011_dpf_composite_failure_workflow.py``)         | 00:05.910 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_008_assembly_example.py` (``008_assembly_example.py``)                                     | 00:09.281 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_003_short_fiber_example.py` (``003_short_fiber_example.py``)                               | 00:04.756 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py` (``009_short_fiber_orientation_tensor.py``)         | 00:09.274 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py` (``006_filter_composite_data_example.py``)           | 00:04.315 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_003_short_fiber_example.py` (``003_short_fiber_example.py``)                               | 00:06.417 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_008_assembly_example.py` (``008_assembly_example.py``)                                     | 00:04.101 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py` (``006_filter_composite_data_example.py``)           | 00:04.817 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_004_get_material_properties_example.py` (``004_get_material_properties_example.py``)       | 00:03.860 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``005_get_layup_properties_example.py``)             | 00:02.562 | 0.0 MB |
+| :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``005_get_layup_properties_example.py``)             | 00:01.454 | 0.0 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
diff --git a/version/dev/_static/css/ansys_sphinx_theme.css b/version/dev/_static/css/ansys_sphinx_theme.css
@@ -66,7 +66,7 @@ html[data-theme="light"] {
   --pst-color-success: rgb(40, 167, 69);
   --pst-color-text-base: rgb(0, 0, 0);
   --pst-color-text-muted: rgb(26, 24, 24);
-  --pst-color-border: #c9c9c9;
+  --pst-color-border: #a19d9d;
   --pst-color-shadow: rgb(216, 216, 216);
   --pst-color-info: var(--pst-color-link);
 
@@ -616,8 +616,6 @@ Navigation column (according to side column)
 ############################################
 */
 .col-lg-9 {
-  flex: 0 0 80%;
-  max-width: 80%;
   padding-right: 5px;
   padding-left: 20px;
 }
@@ -630,6 +628,7 @@ Navigation column (according to side column)
 .bd-main .bd-content .bd-article-container .bd-article {
   padding-left: 1rem;
   padding-top: 1rem;
+  padding-right: 1rem;
 }
 .bd-header .navbar-nav li a.nav-link {
   color: #ddd;
@@ -661,8 +660,9 @@ strong {
   font-weight: 900;
 }
 
-.bd-header .navbar-nav > .active > .nav-link {
-  border-bottom: 2px solid #fff;
+.bd-header .navbar-header-items__start {
+  width: fit-content;
+  padding-right: 3rem;
 }
 
 .navbar-nav li a:focus,
@@ -700,6 +700,15 @@ nav.bd-links li > a:hover {
   color: var(--pst-color-link) !important;
 }
 
+.bd-header .navbar-nav .dropdown button:hover {
+  color: white;
+}
+
+.dropdown-item:hover {
+  font-weight: bold;
+  background-color: transparent;
+}
+
 /*
 ##################
 icon, button, logo  
@@ -740,20 +749,71 @@ kbd {
   background-color: #f8f9fa;
 }
 
+/*
+#####################################
+icon, button, logo  for small screen
+#####################################
+*/
+@media screen and (max-width: 576px) {
+  html[data-theme="light"] .theme-switch-button span {
+    color: rgb(19, 18, 18) !important;
+  }
+  button.btn.version-switcher__button {
+    border-color: var(--pst-color-border);
+    color: var(--pst-color-text-base);
+    font-weight: 700;
+  }
+  button.btn.version-switcher__button {
+    border-color: var(--pst-color-border);
+    color: var(--pst-color-text-base);
+  }
+  button.version-switcher__button {
+    color: var(--pst-color-text-base);
+  }
+  .navbar-nav li a:focus,
+  .navbar-nav li a:hover,
+  .navbar-nav li.current > a {
+    color: var(--pst-color-text-base) !important;
+    font-weight: 700;
+  }
+  button,
+  input,
+  optgroup,
+  select,
+  textarea,
+  button:hover {
+    color: var(--pst-color-text-base);
+  }
+}
+
 .theme-switch-button span {
   color: #f8f9fa;
 }
 
-html[data-theme="light"] .theme-switch-button span:hover {
-  color: #0d0d0d;
+.theme-switch-button span:hover {
+  color: var(--ansysGold);
+  border-color: white;
+}
+
+.navbar-icon-links {
+  column-gap: 0.2rem;
+}
+
+.search-button-field {
+  color: white;
+  background-color: transparent;
+}
+
+.search-button-field:hover {
+  color: var(--pst-color-border);
 }
 
 /* make the github logo white */
 
 i.fa-github-square:before,
 i.fa-square-github:before {
   color: white;
-  font-size: 2rem;
+  font-size: 1rem;
 }
 
 .version-switcher__menu a.list-group-item:hover {
@@ -778,6 +838,9 @@ i.fa-square-github:before {
   color: white;
 }
 
+html[data-theme="light"] #pst-back-to-top {
+  background-color: var(--pst-color-link);
+}
 /*
 ##############################
 image padding before and after 
@@ -841,19 +904,23 @@ html[data-theme="dark"] .highlight pre {
 Sphinx design
 ##############
 */
+
+blockquote {
+  background-color: var(--pst-color-background);
+}
 .sd-sphinx-override,
 .sd-sphinx-override * {
-  background-color: transparent !important;
   font-size: medium;
   flex: auto;
 }
+
 /* Sphinx-design tab */
 
 /* Common styles for all screen sizes */
 .sd-tab-set > input:not(.focus-visible) + label {
   outline: none;
   font-size: large;
-  -webkit-tap-highlight-color: transparent;
+  -webkit-tap-highlight-color: var(--pst-color-background) !important;
   color: var(--pst-color-text-base);
 }
 
@@ -896,12 +963,13 @@ Sphinx design
 /* Common styles for all screen sizes */
 .sd-card .sd-card-text {
   font-family: var(--pst-font-family-base) !important;
+  background-color: var(--pst-color-background) !important;
 }
 
-.sd-card .sd-card-header {
+.bd-content .sd-card .sd-card-header {
   border: none;
-  background-color: white;
-  color: #150458 !important;
+  background-color: transparent;
+  color: var(--pst-color-text-base) !important;
   font-size: var(--pst-font-size-h5);
   font-weight: bold;
   font-family: var(--pst-font-family-base);
@@ -915,6 +983,16 @@ Sphinx design
   font-family: var(--pst-font-family-base);
 }
 
+.sd-card-title {
+  font-family: var(--pst-font-family-base-system);
+}
+
+.bd-content .sd-card .sd-card-body,
+.bd-content .sd-card .sd-card-footer,
+.bd-content .sd-card .sd-card-text {
+  background-color: transparent;
+}
+
 html[data-theme="dark"] .sd-shadow-sm {
   box-shadow: 0 0.1rem 1rem rgba(250, 250, 250, 0.6) !important;
 }
@@ -955,15 +1033,19 @@ html[data-theme="dark"] .sd-card-img-top[src*=".png"] {
 Sphinx-design dropdown
 */
 
-details.sd-dropdown .sd-summary-title {
+.bd-content details.sd-dropdown .sd-summary-title {
   border: 1px solid var(--pst-color-text-base) !important;
-  color: var(--sd-color-card-text) !important;
+  color: var(--pst-color-text-base) !important;
   font-family: var(monospace) !important;
   font-size: medium;
   text-align: left;
   padding-left: 1rem;
 }
 
+details.sd-dropdown summary.sd-card-header + div.sd-summary-content {
+  background-color: transparent;
+}
+
 /*
 #################################
 Right side toctree color and font
@@ -1047,3 +1129,7 @@ search hide match
 div#searchbox p.highlight-link a {
   background-color: var(--pst-color-search-match);
 }
+
+.header-article__inner {
+  padding: 0 1rem;
+}