DOC: update development documentation 947410f

version/dev/_downloads/04bd54519c3d452687a7b13010813c9c/012_fatigue_example.py

@@ -40,6 +40,13 @@
 of the user to verify that it works as expected. For more information, see the
 `fatpack package <https://pypi.org/project/fatpack/>`_,
 
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
+
 """
 
 

version/dev/_downloads/0da0415f0ed8299da464106d782b7d24/005_get_layup_properties_example.py

@@ -32,6 +32,13 @@
 
 To get the full layer information of an element, including results,
 consider using the :class:`SamplingPoint <.SamplingPoint>` class.
+
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
 """
 # %%
 # Set up analysis

version/dev/_downloads/11d8f6fae6bd340c37016860a2f9b2b8/004_get_material_properties_example.py

@@ -30,7 +30,15 @@
 implement a custom failure criterion. The failure criterion is computed for
 all layers and integration points. Finally, the elemental maximum is computed and shown.
 
-Note: Only constant material properties are currently supported.
+.. note::
+
+    Only constant material properties are currently supported.
+
+.. note::
+    When using a Workbench project,
+    use the :func:`.get_composite_files_from_workbench_result_folder`
+    method to obtain the input files.
+
 """
 
 # %%

version/dev/_downloads/2172528320958c063a3e74c3bab6e41c/001_failure_operator_example.py

@@ -38,6 +38,13 @@
 allows you to assess different type of materials and failure modes at once.
 The scoping enables you to evaluate the minimum and maximum failures per element
 or select a list of materials or plies.
+
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.get_composite_files_from_workbench_result_folder`
+    method to obtain the input files.
+
 """
 # %%
 # Set up analysis

version/dev/_downloads/2d0c8da7699e957883e862e6fce7cd1c/007_interlaminar_normal_stress_example.py

@@ -46,6 +46,12 @@
     :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py`
     shows how helper functions can be used to obtain composite result data.
 
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
 """
 
 # %%

version/dev/_downloads/3980e5ffa757dafc8f092eeee6f84947/002_sampling_point_example.py

@@ -36,6 +36,12 @@
 This example uses the :class:`Composite Model <.CompositeModel>` to scope a
 Sampling Point to a certain element and to visualize the laminate.
 
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.get_composite_files_from_workbench_result_folder`
+    method to obtain the input files.
+
 """
 
 # %%

version/dev/_downloads/4c486dc0d97fc4b3038705c75677aae3/010_harmonic_example.ipynb

@@ -4,7 +4,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "Postprocess a harmonic analysis {#harmonic_example}\n===============================\n\n::: {.note}\n::: {.title}\nNote\n:::\n\nWhen using a Workbench project, use the\n`.composite_files_from_workbench_harmonic_analysis`{.interpreted-text\nrole=\"func\"} method to obtain the input files.\n:::\n\nThis example shows how to evaluate failure criteria for a harmonic\nsimulation. It shows how to create a phase sweep to compute the maximum\nIRF in the frequency-phase space and shows how to identify the critical\nfailure mode and the critical layer.\n"
+        "Postprocess a harmonic analysis {#harmonic_example}\n===============================\n\nThis example shows how to evaluate failure criteria for a harmonic\nsimulation. It shows how to create a phase sweep to compute the maximum\nIRF in the frequency-phase space and shows how to identify the critical\nfailure mode and the critical layer.\n\n::: {.note}\n::: {.title}\nNote\n:::\n\nWhen using a Workbench project, use the\n`.composite_files_from_workbench_harmonic_analysis`{.interpreted-text\nrole=\"func\"} method to obtain the input files.\n:::\n"
       ]
     },
     {

version/dev/_downloads/57928fbea60dd74702eaf453ca24fc38/005_get_layup_properties_example.ipynb

@@ -4,7 +4,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "Lay-up properties {#layup_properties_plot}\n=================\n\nThis example shows how to efficiently extract elemental lay-up\nproperties such as thickness, angles, and analysis ply names. These are\ntypically used for layer-wise postprocessing and data filtering.\n\nTo get the full layer information of an element, including results,\nconsider using the `SamplingPoint <.SamplingPoint>`{.interpreted-text\nrole=\"class\"} class.\n"
+        "Lay-up properties {#layup_properties_plot}\n=================\n\nThis example shows how to efficiently extract elemental lay-up\nproperties such as thickness, angles, and analysis ply names. These are\ntypically used for layer-wise postprocessing and data filtering.\n\nTo get the full layer information of an element, including results,\nconsider using the `SamplingPoint <.SamplingPoint>`{.interpreted-text\nrole=\"class\"} class.\n\n::: {.note}\n::: {.title}\nNote\n:::\n\nWhen using a Workbench project, use the\n`.composite_files_from_workbench_harmonic_analysis`{.interpreted-text\nrole=\"func\"} method to obtain the input files.\n:::\n"
       ]
     },
     {

version/dev/_downloads/670b11ce26b761ff64735af981a9c12a/010_harmonic_example.py

@@ -26,16 +26,16 @@
 Postprocess a harmonic analysis
 -------------------------------
 
+This example shows how to evaluate failure criteria for a harmonic simulation.
+It shows how to create a phase sweep to compute the maximum IRF in the frequency-phase
+space and shows how to identify the critical failure mode and the critical layer.
+
 .. note::
 
     When using a Workbench project,
     use the :func:`.composite_files_from_workbench_harmonic_analysis`
     method to obtain the input files.
 
-This example shows how to evaluate failure criteria for a harmonic simulation.
-It shows how to create a phase sweep to compute the maximum IRF in the frequency-phase
-space and shows how to identify the critical failure mode and the critical layer.
-
 """
 
 

version/dev/_downloads/6aaf2b3459309a480ae0751cb9d8037d/014_cyclic_symmetry_example.py

@@ -33,6 +33,13 @@
 a custom failure criterion.
 
 The postprocessing of expanded sectors is not yet supported.
+
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
 """
 
 # %%

version/dev/_downloads/7c4a3fd561e2dcffe572d22b596f18e5/008_assembly_example.ipynb

@@ -4,7 +4,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "Postprocess an assembly {#assembly_example}\n=======================\n\nThis example shows how to postprocess an assembly with multiple\ncomposite parts. The assembly consists of a shell and solid composite\nmodel. The `Composite Model <.CompositeModel>`{.interpreted-text\nrole=\"class\"} class is used to access the data of the different parts.\n"
+        "Postprocess an assembly {#assembly_example}\n=======================\n\nThis example shows how to postprocess an assembly with multiple\ncomposite parts. The assembly consists of a shell and solid composite\nmodel. The `Composite Model <.CompositeModel>`{.interpreted-text\nrole=\"class\"} class is used to access the data of the different parts.\n\n::: {.note}\n::: {.title}\nNote\n:::\n\nWhen using a Workbench project, use the\n`.composite_files_from_workbench_harmonic_analysis`{.interpreted-text\nrole=\"func\"} method to obtain the input files.\n:::\n"
       ]
     },
     {

version/dev/_downloads/7c9b3047529f51fdfbee417c5683c0b2/002_sampling_point_example.ipynb

@@ -4,7 +4,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "Sampling point {#sampling_point_example}\n==============\n\nThis example extracts ply-wise laminate properties and results.\n\nThe `Sampling Point <.SamplingPoint>`{.interpreted-text role=\"class\"}\nclass is used to extract through-the-thickness data of the laminate,\nsuch as ply-wise properties, strains and stresses. It then implements\nbasic visualization to plot the laminate.\n\nThis example uses the\n`Composite Model <.CompositeModel>`{.interpreted-text role=\"class\"} to\nscope a Sampling Point to a certain element and to visualize the\nlaminate.\n"
+        "Sampling point {#sampling_point_example}\n==============\n\nThis example extracts ply-wise laminate properties and results.\n\nThe `Sampling Point <.SamplingPoint>`{.interpreted-text role=\"class\"}\nclass is used to extract through-the-thickness data of the laminate,\nsuch as ply-wise properties, strains and stresses. It then implements\nbasic visualization to plot the laminate.\n\nThis example uses the\n`Composite Model <.CompositeModel>`{.interpreted-text role=\"class\"} to\nscope a Sampling Point to a certain element and to visualize the\nlaminate.\n\n::: {.note}\n::: {.title}\nNote\n:::\n\nWhen using a Workbench project, use the\n`.get_composite_files_from_workbench_result_folder`{.interpreted-text\nrole=\"func\"} method to obtain the input files.\n:::\n"
       ]
     },
     {

version/dev/_downloads/8e7575c9204cf330ddf5389b896d6a7b/014_cyclic_symmetry_example.ipynb

@@ -4,7 +4,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "Cyclic symmetry {#cyclic_symmetry_example}\n===============\n\nThis example shows how to postprocess a cyclic symmetry analysis. The\ninitial (original) sector can be postprocessed with the same tools as a\nstandard analysis. The postprocessing workflow is demonstrated by\nrunning a failure analysis, extracting ply-wise stresses, and\nimplementing a custom failure criterion.\n\nThe postprocessing of expanded sectors is not yet supported.\n"
+        "Cyclic symmetry {#cyclic_symmetry_example}\n===============\n\nThis example shows how to postprocess a cyclic symmetry analysis. The\ninitial (original) sector can be postprocessed with the same tools as a\nstandard analysis. The postprocessing workflow is demonstrated by\nrunning a failure analysis, extracting ply-wise stresses, and\nimplementing a custom failure criterion.\n\nThe postprocessing of expanded sectors is not yet supported.\n\n::: {.note}\n::: {.title}\nNote\n:::\n\nWhen using a Workbench project, use the\n`.composite_files_from_workbench_harmonic_analysis`{.interpreted-text\nrole=\"func\"} method to obtain the input files.\n:::\n"
       ]
     },
     {

version/dev/_downloads/99691009d7dc22d455fb4951528be3f4/004_get_material_properties_example.ipynb

@@ -4,7 +4,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "Material properties and custom failure criterion {#material_properties}\n================================================\n\nThis example shows how to access constant material properties and how to\nimplement a custom failure criterion. The failure criterion is computed\nfor all layers and integration points. Finally, the elemental maximum is\ncomputed and shown.\n\nNote: Only constant material properties are currently supported.\n"
+        "Material properties and custom failure criterion {#material_properties}\n================================================\n\nThis example shows how to access constant material properties and how to\nimplement a custom failure criterion. The failure criterion is computed\nfor all layers and integration points. Finally, the elemental maximum is\ncomputed and shown.\n\n::: {.note}\n::: {.title}\nNote\n:::\n\nOnly constant material properties are currently supported.\n:::\n\n::: {.note}\n::: {.title}\nNote\n:::\n\nWhen using a Workbench project, use the\n`.get_composite_files_from_workbench_result_folder`{.interpreted-text\nrole=\"func\"} method to obtain the input files.\n:::\n"
       ]
     },
     {

version/dev/_downloads/99e34e4fb4305deb74fa33fbd83b8981/012_fatigue_example.ipynb

@@ -4,7 +4,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "Evaluate fatigue for a composite plate {#fatigue_plate_example}\n======================================\n\nThis example shows how to evaluate fatigue for a flat plate. It shows\nhow you can use PyPDF Composites to select specific layers and define a\ncustom combination method. For this example, the custom combination\nmethod is stress in fibre direction.\n\nA random load time series is created. Taking into account that the load\nis assumed proportional, rainflow counting is applied to the load time\nseries. Load ranges are then applied on the stress combination method,\nand damage is evaluated by using a dummy S-N curve.\n\nBe aware that the fatpack package is not developed by Ansys, so it is\nthe responsibility of the user to verify that it works as expected. For\nmore information, see the [fatpack\npackage](https://pypi.org/project/fatpack/),\n"
+        "Evaluate fatigue for a composite plate {#fatigue_plate_example}\n======================================\n\nThis example shows how to evaluate fatigue for a flat plate. It shows\nhow you can use PyPDF Composites to select specific layers and define a\ncustom combination method. For this example, the custom combination\nmethod is stress in fibre direction.\n\nA random load time series is created. Taking into account that the load\nis assumed proportional, rainflow counting is applied to the load time\nseries. Load ranges are then applied on the stress combination method,\nand damage is evaluated by using a dummy S-N curve.\n\nBe aware that the fatpack package is not developed by Ansys, so it is\nthe responsibility of the user to verify that it works as expected. For\nmore information, see the [fatpack\npackage](https://pypi.org/project/fatpack/),\n\n::: {.note}\n::: {.title}\nNote\n:::\n\nWhen using a Workbench project, use the\n`.composite_files_from_workbench_harmonic_analysis`{.interpreted-text\nrole=\"func\"} method to obtain the input files.\n:::\n"
       ]
     },
     {

version/dev/_downloads/9f63dcc312465189dcab4d8698a044bd/011_rst_workflow.py

@@ -45,6 +45,13 @@
 The postprocessing of MAPDL models is supported in 2024 R2 (DPF Server version 8.0)
 and later. A few advanced features are not supported with the RST only workflow.
 For more information, see :ref:`limitations`.
+
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
 """
 # %%
 # Set up analysis

version/dev/_downloads/adf87dd096add9a8ebb88eb4ce7f189b/006_filter_composite_data_example.py

@@ -37,6 +37,13 @@
 The examples show filtering data by layer, spot, and node, as well as material
 or analysis ply ID. To learn more about how layered result data is organized,
 see :ref:`select_indices`.
+
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
 """
 
 # %%

version/dev/_downloads/bb3177d94926216b91930e358a2e5ef9/001_failure_operator_example.ipynb

@@ -4,7 +4,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "Composite failure analysis {#failure_operator_example}\n==========================\n\nThis example shows how to analyze a composite structure by a combined\nfailure criterion.\n\nThe failure operator of DPF Composites computes the minimum and maximum\nfailure values and failure modes of a combined failure criterion. A\ncombined failure criterion is a selection of failure criteria such as\nPuck, Tsai-Wu, or face sheet wrinkling. For a list of all failure\ncriteria, see `failure_criteria`{.interpreted-text role=\"ref\"}.\n\nThe `Combined Failure Criterion\n<.failure_criteria.CombinedFailureCriterion>`{.interpreted-text\nrole=\"class\"} class allows you to assess different type of materials and\nfailure modes at once. The scoping enables you to evaluate the minimum\nand maximum failures per element or select a list of materials or plies.\n"
+        "Composite failure analysis {#failure_operator_example}\n==========================\n\nThis example shows how to analyze a composite structure by a combined\nfailure criterion.\n\nThe failure operator of DPF Composites computes the minimum and maximum\nfailure values and failure modes of a combined failure criterion. A\ncombined failure criterion is a selection of failure criteria such as\nPuck, Tsai-Wu, or face sheet wrinkling. For a list of all failure\ncriteria, see `failure_criteria`{.interpreted-text role=\"ref\"}.\n\nThe `Combined Failure Criterion\n<.failure_criteria.CombinedFailureCriterion>`{.interpreted-text\nrole=\"class\"} class allows you to assess different type of materials and\nfailure modes at once. The scoping enables you to evaluate the minimum\nand maximum failures per element or select a list of materials or plies.\n\n::: {.note}\n::: {.title}\nNote\n:::\n\nWhen using a Workbench project, use the\n`.get_composite_files_from_workbench_result_folder`{.interpreted-text\nrole=\"func\"} method to obtain the input files.\n:::\n"
       ]
     },
     {

version/dev/_downloads/d13337ce8445f69a22967b872b601ca2/011_rst_workflow.ipynb

@@ -4,7 +4,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "Failure analysis of an MAPDL (RST) model {#rst_workflow_example}\n========================================\n\nThis example shows the postprocessing of an MAPDL (RST) model with\nlayered elements that was not preprocessed by ACP. The difference\nbetween the RST-only and ACP-based workflow is that the section data are\nloaded from the RST file instead of the ACP layup file. This happens\nautomatically if the parameter [composite]{.title-ref} of the\n`.ContinuousFiberCompositesFiles`{.interpreted-text role=\"class\"} class\nis not set.\n\nThe engineering data file (XML or ENGD) with the material properties is\nneeded anyway. Otherwise, the material properties cannot be mapped. At\nthe end of this example, two workflows are shown on how to create the\nengineering data file based on a MAPDL model and how to set the material\nUUIDs in MAPDL.\n\n::: {.important}\n::: {.title}\nImportant\n:::\n\nThe material UUIDs in the engineering data file must be identical to the\nUUIDs in Mechanical APDL (RST file).\n:::\n\nThe postprocessing of MAPDL models is supported in 2024 R2 (DPF Server\nversion 8.0) and later. A few advanced features are not supported with\nthe RST only workflow. For more information, see\n`limitations`{.interpreted-text role=\"ref\"}.\n"
+        "Failure analysis of an MAPDL (RST) model {#rst_workflow_example}\n========================================\n\nThis example shows the postprocessing of an MAPDL (RST) model with\nlayered elements that was not preprocessed by ACP. The difference\nbetween the RST-only and ACP-based workflow is that the section data are\nloaded from the RST file instead of the ACP layup file. This happens\nautomatically if the parameter [composite]{.title-ref} of the\n`.ContinuousFiberCompositesFiles`{.interpreted-text role=\"class\"} class\nis not set.\n\nThe engineering data file (XML or ENGD) with the material properties is\nneeded anyway. Otherwise, the material properties cannot be mapped. At\nthe end of this example, two workflows are shown on how to create the\nengineering data file based on a MAPDL model and how to set the material\nUUIDs in MAPDL.\n\n::: {.important}\n::: {.title}\nImportant\n:::\n\nThe material UUIDs in the engineering data file must be identical to the\nUUIDs in Mechanical APDL (RST file).\n:::\n\nThe postprocessing of MAPDL models is supported in 2024 R2 (DPF Server\nversion 8.0) and later. A few advanced features are not supported with\nthe RST only workflow. For more information, see\n`limitations`{.interpreted-text role=\"ref\"}.\n\n::: {.note}\n::: {.title}\nNote\n:::\n\nWhen using a Workbench project, use the\n`.composite_files_from_workbench_harmonic_analysis`{.interpreted-text\nrole=\"func\"} method to obtain the input files.\n:::\n"
       ]
     },
     {