From 5a1eea62beb83c9ff0d589103c6eeb2ea066e62b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Roos?= Date: Tue, 15 Oct 2024 09:24:05 +0200 Subject: [PATCH 1/4] add note to use get_composite_files_from_workbench_result_folder for WB projects to all examples --- examples/001_failure_operator_example.py | 6 ++++++ examples/002_sampling_point_example.py | 5 +++++ examples/004_get_material_properties_example.py | 10 +++++++++- examples/005_get_layup_properties_example.py | 7 +++++++ examples/006_filter_composite_data_example.py | 7 +++++++ examples/007_interlaminar_normal_stress_example.py | 6 ++++++ examples/008_assembly_example.py | 6 ++++++ examples/010_harmonic_example.py | 8 ++++---- examples/011_rst_workflow.py | 7 +++++++ examples/012_fatigue_example.py | 7 +++++++ examples/014_cyclic_symmetry_example.py | 7 +++++++ 11 files changed, 71 insertions(+), 5 deletions(-) diff --git a/examples/001_failure_operator_example.py b/examples/001_failure_operator_example.py index b035b6da6..a3c1355ef 100644 --- a/examples/001_failure_operator_example.py +++ b/examples/001_failure_operator_example.py @@ -38,6 +38,12 @@ 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 diff --git a/examples/002_sampling_point_example.py b/examples/002_sampling_point_example.py index dc83ba3b6..ec43f0cf2 100644 --- a/examples/002_sampling_point_example.py +++ b/examples/002_sampling_point_example.py @@ -36,6 +36,11 @@ 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. + """ # %% diff --git a/examples/004_get_material_properties_example.py b/examples/004_get_material_properties_example.py index 5cb10fa77..2b186f784 100644 --- a/examples/004_get_material_properties_example.py +++ b/examples/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. + """ # %% diff --git a/examples/005_get_layup_properties_example.py b/examples/005_get_layup_properties_example.py index 306179756..20d341d01 100644 --- a/examples/005_get_layup_properties_example.py +++ b/examples/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 diff --git a/examples/006_filter_composite_data_example.py b/examples/006_filter_composite_data_example.py index 57fba8183..c9320dfd4 100644 --- a/examples/006_filter_composite_data_example.py +++ b/examples/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. + """ # %% diff --git a/examples/007_interlaminar_normal_stress_example.py b/examples/007_interlaminar_normal_stress_example.py index b155c5f8b..0b3a7cb46 100644 --- a/examples/007_interlaminar_normal_stress_example.py +++ b/examples/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. + """ # %% diff --git a/examples/008_assembly_example.py b/examples/008_assembly_example.py index 78028c182..06d858b96 100644 --- a/examples/008_assembly_example.py +++ b/examples/008_assembly_example.py @@ -31,6 +31,12 @@ :class:`Composite Model <.CompositeModel>` class is used to access the data of the different parts. +.. note:: + + When using a Workbench project, + use the :func:`.composite_files_from_workbench_harmonic_analysis` + method to obtain the input files. + """ # %% # Set up analysis diff --git a/examples/010_harmonic_example.py b/examples/010_harmonic_example.py index 7cc86b09e..c965b135d 100644 --- a/examples/010_harmonic_example.py +++ b/examples/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. - """ diff --git a/examples/011_rst_workflow.py b/examples/011_rst_workflow.py index 77b65df4f..7c219b0f1 100644 --- a/examples/011_rst_workflow.py +++ b/examples/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 diff --git a/examples/012_fatigue_example.py b/examples/012_fatigue_example.py index 42a988e6a..b5e38ad6a 100644 --- a/examples/012_fatigue_example.py +++ b/examples/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 `_, +.. note:: + + When using a Workbench project, + use the :func:`.composite_files_from_workbench_harmonic_analysis` + method to obtain the input files. + + """ diff --git a/examples/014_cyclic_symmetry_example.py b/examples/014_cyclic_symmetry_example.py index b3ee01921..a80b383df 100644 --- a/examples/014_cyclic_symmetry_example.py +++ b/examples/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. + """ # %% From 6bf15a2d1f45478751fc9ed60bb21b7df1073a81 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Roos?= <105842014+roosre@users.noreply.github.com> Date: Wed, 16 Oct 2024 07:19:59 +0200 Subject: [PATCH 2/4] Update 001_failure_operator_example.py --- examples/001_failure_operator_example.py | 1 + 1 file changed, 1 insertion(+) diff --git a/examples/001_failure_operator_example.py b/examples/001_failure_operator_example.py index a3c1355ef..b9063c1fb 100644 --- a/examples/001_failure_operator_example.py +++ b/examples/001_failure_operator_example.py @@ -40,6 +40,7 @@ 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. From 9840c54fa1f7f4864b136b25928215d9929a6d17 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Roos?= <105842014+roosre@users.noreply.github.com> Date: Wed, 16 Oct 2024 07:20:15 +0200 Subject: [PATCH 3/4] Update 002_sampling_point_example.py --- examples/002_sampling_point_example.py | 1 + 1 file changed, 1 insertion(+) diff --git a/examples/002_sampling_point_example.py b/examples/002_sampling_point_example.py index ec43f0cf2..95a95e1ea 100644 --- a/examples/002_sampling_point_example.py +++ b/examples/002_sampling_point_example.py @@ -37,6 +37,7 @@ 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. From 58fc001d9475fccffa5d723602715c1a02a02602 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Roos?= Date: Wed, 16 Oct 2024 10:21:14 +0200 Subject: [PATCH 4/4] run style checks --- examples/001_failure_operator_example.py | 2 +- examples/002_sampling_point_example.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/001_failure_operator_example.py b/examples/001_failure_operator_example.py index b9063c1fb..02dbca88c 100644 --- a/examples/001_failure_operator_example.py +++ b/examples/001_failure_operator_example.py @@ -40,7 +40,7 @@ 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. diff --git a/examples/002_sampling_point_example.py b/examples/002_sampling_point_example.py index 95a95e1ea..d728e7b0d 100644 --- a/examples/002_sampling_point_example.py +++ b/examples/002_sampling_point_example.py @@ -37,7 +37,7 @@ 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.