diff --git a/version/dev/_downloads/06082043848dd97eedadd25f3f52c2a3/011_rst_workflow.zip b/version/dev/_downloads/06082043848dd97eedadd25f3f52c2a3/011_rst_workflow.zip index 309fdbff0..949d85e35 100644 Binary files a/version/dev/_downloads/06082043848dd97eedadd25f3f52c2a3/011_rst_workflow.zip and b/version/dev/_downloads/06082043848dd97eedadd25f3f52c2a3/011_rst_workflow.zip differ diff --git a/version/dev/_downloads/11ba9ded9a0acf54c4f861149963385c/014_cyclic_symmetry_example.zip b/version/dev/_downloads/11ba9ded9a0acf54c4f861149963385c/014_cyclic_symmetry_example.zip index e86126a01..71fc1518e 100644 Binary files a/version/dev/_downloads/11ba9ded9a0acf54c4f861149963385c/014_cyclic_symmetry_example.zip and b/version/dev/_downloads/11ba9ded9a0acf54c4f861149963385c/014_cyclic_symmetry_example.zip differ diff --git a/version/dev/_downloads/22db00a3f064a1cfaa82c24a763eda42/005_get_layup_properties_example.zip b/version/dev/_downloads/22db00a3f064a1cfaa82c24a763eda42/005_get_layup_properties_example.zip index e24fde3d7..4b639b71a 100644 Binary files a/version/dev/_downloads/22db00a3f064a1cfaa82c24a763eda42/005_get_layup_properties_example.zip and b/version/dev/_downloads/22db00a3f064a1cfaa82c24a763eda42/005_get_layup_properties_example.zip differ diff --git a/version/dev/_downloads/2481d85388158be8d2f0db2cc842ad6d/010_harmonic_example.zip b/version/dev/_downloads/2481d85388158be8d2f0db2cc842ad6d/010_harmonic_example.zip index 82e2ddb25..5e29c1aa4 100644 Binary files a/version/dev/_downloads/2481d85388158be8d2f0db2cc842ad6d/010_harmonic_example.zip and b/version/dev/_downloads/2481d85388158be8d2f0db2cc842ad6d/010_harmonic_example.zip differ diff --git a/version/dev/_downloads/2e65b9281fef6fa6d0079a988272ffd7/099_dpf_composite_failure_workflow.zip b/version/dev/_downloads/2e65b9281fef6fa6d0079a988272ffd7/099_dpf_composite_failure_workflow.zip index e8a0e9212..415c9b46a 100644 Binary files a/version/dev/_downloads/2e65b9281fef6fa6d0079a988272ffd7/099_dpf_composite_failure_workflow.zip and b/version/dev/_downloads/2e65b9281fef6fa6d0079a988272ffd7/099_dpf_composite_failure_workflow.zip differ diff --git a/version/dev/_downloads/580520531ccb915b110be66a1df4aa7a/001_failure_operator_example.zip b/version/dev/_downloads/580520531ccb915b110be66a1df4aa7a/001_failure_operator_example.zip index 2dd202ca5..b86e4426a 100644 Binary files a/version/dev/_downloads/580520531ccb915b110be66a1df4aa7a/001_failure_operator_example.zip and b/version/dev/_downloads/580520531ccb915b110be66a1df4aa7a/001_failure_operator_example.zip differ diff --git a/version/dev/_downloads/5f8f78f4df09423299a7c4dc46409314/006_filter_composite_data_example.zip b/version/dev/_downloads/5f8f78f4df09423299a7c4dc46409314/006_filter_composite_data_example.zip index 83d1bfa42..5fa7f745b 100644 Binary files a/version/dev/_downloads/5f8f78f4df09423299a7c4dc46409314/006_filter_composite_data_example.zip and b/version/dev/_downloads/5f8f78f4df09423299a7c4dc46409314/006_filter_composite_data_example.zip differ diff --git a/version/dev/_downloads/675f27bf7817e74cb3738ead0ca88ae1/012_fatigue_example.zip b/version/dev/_downloads/675f27bf7817e74cb3738ead0ca88ae1/012_fatigue_example.zip index cb0708289..da8971fb3 100644 Binary files a/version/dev/_downloads/675f27bf7817e74cb3738ead0ca88ae1/012_fatigue_example.zip and b/version/dev/_downloads/675f27bf7817e74cb3738ead0ca88ae1/012_fatigue_example.zip differ diff --git a/version/dev/_downloads/8bbdd0639ab75734f24a77c9a3c2b12e/007_interlaminar_normal_stress_example.zip b/version/dev/_downloads/8bbdd0639ab75734f24a77c9a3c2b12e/007_interlaminar_normal_stress_example.zip index 0607e9628..4c8a95f25 100644 Binary files a/version/dev/_downloads/8bbdd0639ab75734f24a77c9a3c2b12e/007_interlaminar_normal_stress_example.zip and b/version/dev/_downloads/8bbdd0639ab75734f24a77c9a3c2b12e/007_interlaminar_normal_stress_example.zip differ diff --git a/version/dev/_downloads/8e5fa0d6f9171a181f50dce691b4a506/004_get_material_properties_example.zip b/version/dev/_downloads/8e5fa0d6f9171a181f50dce691b4a506/004_get_material_properties_example.zip index d08fd2417..c24c76a92 100644 Binary files a/version/dev/_downloads/8e5fa0d6f9171a181f50dce691b4a506/004_get_material_properties_example.zip and b/version/dev/_downloads/8e5fa0d6f9171a181f50dce691b4a506/004_get_material_properties_example.zip differ diff --git a/version/dev/_downloads/a3424d721d24538e13ccae45271a6812/013_thermal_example.zip b/version/dev/_downloads/a3424d721d24538e13ccae45271a6812/013_thermal_example.zip index 03f0d1420..24852b52f 100644 Binary files a/version/dev/_downloads/a3424d721d24538e13ccae45271a6812/013_thermal_example.zip and b/version/dev/_downloads/a3424d721d24538e13ccae45271a6812/013_thermal_example.zip differ diff --git a/version/dev/_downloads/a803e039e20f8505fa54025987d70490/008_assembly_example.zip b/version/dev/_downloads/a803e039e20f8505fa54025987d70490/008_assembly_example.zip index 03c409bde..35b7525b5 100644 Binary files a/version/dev/_downloads/a803e039e20f8505fa54025987d70490/008_assembly_example.zip and b/version/dev/_downloads/a803e039e20f8505fa54025987d70490/008_assembly_example.zip differ diff --git a/version/dev/_downloads/d3956153b87b58f221986b849a6b844b/009_short_fiber_orientation_tensor.zip b/version/dev/_downloads/d3956153b87b58f221986b849a6b844b/009_short_fiber_orientation_tensor.zip index 78a4cb027..ab9effe20 100644 Binary files a/version/dev/_downloads/d3956153b87b58f221986b849a6b844b/009_short_fiber_orientation_tensor.zip and b/version/dev/_downloads/d3956153b87b58f221986b849a6b844b/009_short_fiber_orientation_tensor.zip differ diff --git a/version/dev/_downloads/debbf6c5561a3af44e8fb8a1969f44c3/003_short_fiber_example.zip b/version/dev/_downloads/debbf6c5561a3af44e8fb8a1969f44c3/003_short_fiber_example.zip index 4618824f2..482b53654 100644 Binary files a/version/dev/_downloads/debbf6c5561a3af44e8fb8a1969f44c3/003_short_fiber_example.zip and b/version/dev/_downloads/debbf6c5561a3af44e8fb8a1969f44c3/003_short_fiber_example.zip differ diff --git a/version/dev/_downloads/fad9fc3907e684aecc38368b0126ab34/002_sampling_point_example.zip b/version/dev/_downloads/fad9fc3907e684aecc38368b0126ab34/002_sampling_point_example.zip index be8895c62..662524337 100644 Binary files a/version/dev/_downloads/fad9fc3907e684aecc38368b0126ab34/002_sampling_point_example.zip and b/version/dev/_downloads/fad9fc3907e684aecc38368b0126ab34/002_sampling_point_example.zip differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_001.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_001.vtksz index 71564c915..3e4b995f3 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_001.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_001.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_002.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_002.vtksz index 82859c541..a03e3d9a5 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_002.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_002.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_003.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_003.vtksz index bd92da4db..4d03a0756 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_003.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_003.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_001.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_001.vtksz index beeb4835a..69bad6518 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_001.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_001.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_002.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_002.vtksz index b06cf52cc..fcfac7fcc 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_002.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_002.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_003.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_003.vtksz index 806609ade..9cc11277d 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_003.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_003.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_004_get_material_properties_example_001.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_004_get_material_properties_example_001.vtksz index cc34e360e..55963f750 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_004_get_material_properties_example_001.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_004_get_material_properties_example_001.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_001.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_001.vtksz index 198cf7666..9fbd0007e 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_001.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_001.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_002.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_002.vtksz index 41d92dfc0..200526973 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_002.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_002.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_003.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_003.vtksz index f1401b738..08e21fbb0 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_003.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_003.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_004.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_004.vtksz index 9e6e99a8b..53b28dbbf 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_004.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_004.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_005.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_005.vtksz index 4873d8aba..71abe6067 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_005.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_005.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_007_interlaminar_normal_stress_example_001.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_007_interlaminar_normal_stress_example_001.vtksz index 61114a87d..6377416f3 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_007_interlaminar_normal_stress_example_001.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_007_interlaminar_normal_stress_example_001.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_007_interlaminar_normal_stress_example_002.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_007_interlaminar_normal_stress_example_002.vtksz index 43f7e9007..6dad43f0f 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_007_interlaminar_normal_stress_example_002.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_007_interlaminar_normal_stress_example_002.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_008_assembly_example_001.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_008_assembly_example_001.vtksz index f815ea341..10b948f50 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_008_assembly_example_001.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_008_assembly_example_001.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_008_assembly_example_002.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_008_assembly_example_002.vtksz index e98317911..1dc6d2d7c 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_008_assembly_example_002.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_008_assembly_example_002.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_001.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_001.vtksz index 337893f12..9a3b0ed95 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_001.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_001.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_002.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_002.vtksz index d125d7969..b2be18896 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_002.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_002.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_003.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_003.vtksz index 8117e6e50..f7c0c1504 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_003.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_003.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_004.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_004.vtksz index ef0cc663e..12c279ae2 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_004.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_004.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_005.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_005.vtksz index 5641f4ca6..c62d2f22c 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_005.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_005.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_010_harmonic_example_001.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_010_harmonic_example_001.vtksz index c267ebf1c..df1502930 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_010_harmonic_example_001.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_010_harmonic_example_001.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_011_rst_workflow_001.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_011_rst_workflow_001.vtksz index a9e4c852f..0c3fec1e3 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_011_rst_workflow_001.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_011_rst_workflow_001.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_012_fatigue_example_003.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_012_fatigue_example_003.vtksz index dea018e22..5f61a2180 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_012_fatigue_example_003.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_012_fatigue_example_003.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_013_thermal_example_001.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_013_thermal_example_001.vtksz index 6789dfc1c..51002bf6f 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_013_thermal_example_001.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_013_thermal_example_001.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_013_thermal_example_002.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_013_thermal_example_002.vtksz index 372a93ecc..44b707021 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_013_thermal_example_002.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_013_thermal_example_002.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_014_cyclic_symmetry_example_001.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_014_cyclic_symmetry_example_001.vtksz index fc4ed2aa6..156b4b98d 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_014_cyclic_symmetry_example_001.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_014_cyclic_symmetry_example_001.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_014_cyclic_symmetry_example_002.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_014_cyclic_symmetry_example_002.vtksz index 6cfb6202c..ae05b25ec 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_014_cyclic_symmetry_example_002.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_014_cyclic_symmetry_example_002.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_014_cyclic_symmetry_example_003.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_014_cyclic_symmetry_example_003.vtksz index 16b943cef..30dde1a11 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_014_cyclic_symmetry_example_003.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_014_cyclic_symmetry_example_003.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_014_cyclic_symmetry_example_004.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_014_cyclic_symmetry_example_004.vtksz index bdce7a0de..ef19f4d1f 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_014_cyclic_symmetry_example_004.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_014_cyclic_symmetry_example_004.vtksz differ diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_099_dpf_composite_failure_workflow_001.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_099_dpf_composite_failure_workflow_001.vtksz index 4bc91ee40..f8440fc09 100644 Binary files a/version/dev/_images/examples/gallery_examples/images/sphx_glr_099_dpf_composite_failure_workflow_001.vtksz and b/version/dev/_images/examples/gallery_examples/images/sphx_glr_099_dpf_composite_failure_workflow_001.vtksz differ diff --git a/version/dev/_images/sphx_glr_012_fatigue_example_001.png b/version/dev/_images/sphx_glr_012_fatigue_example_001.png index d3f3bfab1..ff1fba2e6 100644 Binary files a/version/dev/_images/sphx_glr_012_fatigue_example_001.png and b/version/dev/_images/sphx_glr_012_fatigue_example_001.png differ diff --git a/version/dev/_images/sphx_glr_012_fatigue_example_003.png b/version/dev/_images/sphx_glr_012_fatigue_example_003.png index 604fbbccf..88715de82 100644 Binary files a/version/dev/_images/sphx_glr_012_fatigue_example_003.png and b/version/dev/_images/sphx_glr_012_fatigue_example_003.png differ diff --git a/version/dev/_images/sphx_glr_012_fatigue_example_thumb.png b/version/dev/_images/sphx_glr_012_fatigue_example_thumb.png index be7d9e6fd..a0a68d86c 100644 Binary files a/version/dev/_images/sphx_glr_012_fatigue_example_thumb.png and b/version/dev/_images/sphx_glr_012_fatigue_example_thumb.png differ diff --git a/version/dev/_sources/examples/gallery_examples/001_failure_operator_example.rst.txt b/version/dev/_sources/examples/gallery_examples/001_failure_operator_example.rst.txt index 2a0069d03..d8ffc93c3 100644 --- a/version/dev/_sources/examples/gallery_examples/001_failure_operator_example.rst.txt +++ b/version/dev/_sources/examples/gallery_examples/001_failure_operator_example.rst.txt @@ -290,7 +290,7 @@ Scope failure evaluation by plies. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 11.642 seconds) + **Total running time of the script:** (0 minutes 12.061 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 index 8ca73ab67..011cce077 100644 --- 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 @@ -349,7 +349,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 4.837 seconds) + **Total running time of the script:** (0 minutes 4.888 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 index 011b00edf..07637e389 100644 --- 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 @@ -306,7 +306,7 @@ Compute and plot the maximum failure value per element. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 3.262 seconds) + **Total running time of the script:** (0 minutes 3.287 seconds) .. _sphx_glr_download_examples_gallery_examples_003_short_fiber_example.py: diff --git a/version/dev/_sources/examples/gallery_examples/004_get_material_properties_example.rst.txt b/version/dev/_sources/examples/gallery_examples/004_get_material_properties_example.rst.txt index 417f7ddec..714270e6e 100644 --- a/version/dev/_sources/examples/gallery_examples/004_get_material_properties_example.rst.txt +++ b/version/dev/_sources/examples/gallery_examples/004_get_material_properties_example.rst.txt @@ -212,7 +212,7 @@ Implement a custom failure criterion: basic max strain .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 3.523 seconds) + **Total running time of the script:** (0 minutes 3.610 seconds) .. _sphx_glr_download_examples_gallery_examples_004_get_material_properties_example.py: diff --git a/version/dev/_sources/examples/gallery_examples/005_get_layup_properties_example.rst.txt b/version/dev/_sources/examples/gallery_examples/005_get_layup_properties_example.rst.txt index b30654661..e65854f6a 100644 --- a/version/dev/_sources/examples/gallery_examples/005_get_layup_properties_example.rst.txt +++ b/version/dev/_sources/examples/gallery_examples/005_get_layup_properties_example.rst.txt @@ -168,7 +168,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 1.399 seconds) + **Total running time of the script:** (0 minutes 1.484 seconds) .. _sphx_glr_download_examples_gallery_examples_005_get_layup_properties_example.py: diff --git a/version/dev/_sources/examples/gallery_examples/006_filter_composite_data_example.rst.txt b/version/dev/_sources/examples/gallery_examples/006_filter_composite_data_example.rst.txt index 7ff34ea03..76183b04d 100644 --- a/version/dev/_sources/examples/gallery_examples/006_filter_composite_data_example.rst.txt +++ b/version/dev/_sources/examples/gallery_examples/006_filter_composite_data_example.rst.txt @@ -523,7 +523,7 @@ in the material direction in this ply. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 4.682 seconds) + **Total running time of the script:** (0 minutes 4.636 seconds) .. _sphx_glr_download_examples_gallery_examples_006_filter_composite_data_example.py: diff --git a/version/dev/_sources/examples/gallery_examples/007_interlaminar_normal_stress_example.rst.txt b/version/dev/_sources/examples/gallery_examples/007_interlaminar_normal_stress_example.rst.txt index f7747e383..2b8b6af23 100644 --- a/version/dev/_sources/examples/gallery_examples/007_interlaminar_normal_stress_example.rst.txt +++ b/version/dev/_sources/examples/gallery_examples/007_interlaminar_normal_stress_example.rst.txt @@ -313,7 +313,7 @@ Plot s3 at the mid-plane of a certain ply. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 7.347 seconds) + **Total running time of the script:** (0 minutes 7.360 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 index 8090093e8..700ec171c 100644 --- a/version/dev/_sources/examples/gallery_examples/008_assembly_example.rst.txt +++ b/version/dev/_sources/examples/gallery_examples/008_assembly_example.rst.txt @@ -262,7 +262,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.157 seconds) + **Total running time of the script:** (0 minutes 4.148 seconds) .. _sphx_glr_download_examples_gallery_examples_008_assembly_example.py: diff --git a/version/dev/_sources/examples/gallery_examples/009_short_fiber_orientation_tensor.rst.txt b/version/dev/_sources/examples/gallery_examples/009_short_fiber_orientation_tensor.rst.txt index 562eafdaa..2ead1a9c8 100644 --- a/version/dev/_sources/examples/gallery_examples/009_short_fiber_orientation_tensor.rst.txt +++ b/version/dev/_sources/examples/gallery_examples/009_short_fiber_orientation_tensor.rst.txt @@ -432,7 +432,7 @@ Plot some components of the fiber orientation tensor. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 5.877 seconds) + **Total running time of the script:** (0 minutes 5.827 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 index 7a7114550..a29cbad54 100644 --- a/version/dev/_sources/examples/gallery_examples/010_harmonic_example.rst.txt +++ b/version/dev/_sources/examples/gallery_examples/010_harmonic_example.rst.txt @@ -434,7 +434,7 @@ at each frequency, because we look only at the element that has the highest IRF .. code-block:: none - [] + [] @@ -509,7 +509,7 @@ Compute critical layer and critical failure mode. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 10.117 seconds) + **Total running time of the script:** (0 minutes 9.928 seconds) .. _sphx_glr_download_examples_gallery_examples_010_harmonic_example.py: diff --git a/version/dev/_sources/examples/gallery_examples/011_rst_workflow.rst.txt b/version/dev/_sources/examples/gallery_examples/011_rst_workflow.rst.txt index 511db0ad1..e2400ddd4 100644 --- a/version/dev/_sources/examples/gallery_examples/011_rst_workflow.rst.txt +++ b/version/dev/_sources/examples/gallery_examples/011_rst_workflow.rst.txt @@ -119,7 +119,7 @@ Get input files (RST and material.engd but skip the ACP layup file). .. code-block:: none - ContinuousFiberCompositesFiles(rst=['/tmp/dataProcessingTemp139708755609344/a4733703-6376-414f-b879-81871fe66518/shell.rst'], composite={}, engineering_data='/tmp/dataProcessingTemp139708755609344/3847b466-7cf5-4884-897f-f92474fde801/material.engd', files_are_local=False) + ContinuousFiberCompositesFiles(rst=['/tmp/dataProcessingTemp140506698876672/95327c57-c6c7-47d6-a27c-fd5bbb15ff04/shell.rst'], composite={}, engineering_data='/tmp/dataProcessingTemp140506698876672/3263d946-7a3b-42f8-a6f7-357cc93adb26/material.engd', files_are_local=False) @@ -271,7 +271,7 @@ With ACP Standalone (for constant material properties only): .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 5.110 seconds) + **Total running time of the script:** (0 minutes 5.043 seconds) .. _sphx_glr_download_examples_gallery_examples_011_rst_workflow.py: diff --git a/version/dev/_sources/examples/gallery_examples/012_fatigue_example.rst.txt b/version/dev/_sources/examples/gallery_examples/012_fatigue_example.rst.txt index be1950ac8..99f5840db 100644 --- a/version/dev/_sources/examples/gallery_examples/012_fatigue_example.rst.txt +++ b/version/dev/_sources/examples/gallery_examples/012_fatigue_example.rst.txt @@ -208,7 +208,7 @@ No mean stress correction is applied. .. code-block:: none - [] + [] @@ -384,7 +384,7 @@ Identify the element with the maximum damage .. code-block:: none The element with highest damage is 27. - The highest damage value is 1.3175724629612316e-06. + The highest damage value is 6.384855047637062e-07. @@ -392,7 +392,7 @@ Identify the element with the maximum damage .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 3.564 seconds) + **Total running time of the script:** (0 minutes 3.799 seconds) .. _sphx_glr_download_examples_gallery_examples_012_fatigue_example.py: diff --git a/version/dev/_sources/examples/gallery_examples/013_thermal_example.rst.txt b/version/dev/_sources/examples/gallery_examples/013_thermal_example.rst.txt index 19bb90ed5..fcc703192 100644 --- a/version/dev/_sources/examples/gallery_examples/013_thermal_example.rst.txt +++ b/version/dev/_sources/examples/gallery_examples/013_thermal_example.rst.txt @@ -256,7 +256,7 @@ is extracted for the material `Honeycomb Aluminum Alloy`. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 4.427 seconds) + **Total running time of the script:** (0 minutes 4.181 seconds) .. _sphx_glr_download_examples_gallery_examples_013_thermal_example.py: diff --git a/version/dev/_sources/examples/gallery_examples/014_cyclic_symmetry_example.rst.txt b/version/dev/_sources/examples/gallery_examples/014_cyclic_symmetry_example.rst.txt index 2f5389bd5..39ddc9b6a 100644 --- a/version/dev/_sources/examples/gallery_examples/014_cyclic_symmetry_example.rst.txt +++ b/version/dev/_sources/examples/gallery_examples/014_cyclic_symmetry_example.rst.txt @@ -374,7 +374,7 @@ The same expansion is possible for strains and stresses. For more information, s .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 5.728 seconds) + **Total running time of the script:** (0 minutes 7.394 seconds) .. _sphx_glr_download_examples_gallery_examples_014_cyclic_symmetry_example.py: diff --git a/version/dev/_sources/examples/gallery_examples/099_dpf_composite_failure_workflow.rst.txt b/version/dev/_sources/examples/gallery_examples/099_dpf_composite_failure_workflow.rst.txt index de51d4e7a..96acf0314 100644 --- a/version/dev/_sources/examples/gallery_examples/099_dpf_composite_failure_workflow.rst.txt +++ b/version/dev/_sources/examples/gallery_examples/099_dpf_composite_failure_workflow.rst.txt @@ -395,7 +395,7 @@ Plot the maximum and minimum values. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 4.414 seconds) + **Total running time of the script:** (0 minutes 4.671 seconds) .. _sphx_glr_download_examples_gallery_examples_099_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 index 3e28c26c4..060c05fd3 100644 --- a/version/dev/_sources/examples/gallery_examples/sg_execution_times.rst.txt +++ b/version/dev/_sources/examples/gallery_examples/sg_execution_times.rst.txt @@ -6,7 +6,7 @@ Computation times ================= -**01:20.085** total execution time for 15 files **from examples/gallery_examples**: +**01:22.317** total execution time for 15 files **from examples/gallery_examples**: .. container:: @@ -33,47 +33,47 @@ Computation times - Time - Mem (MB) * - :ref:`sphx_glr_examples_gallery_examples_001_failure_operator_example.py` (``001_failure_operator_example.py``) - - 00:11.642 + - 00:12.061 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_010_harmonic_example.py` (``010_harmonic_example.py``) - - 00:10.117 + - 00:09.928 + - 0.0 + * - :ref:`sphx_glr_examples_gallery_examples_014_cyclic_symmetry_example.py` (``014_cyclic_symmetry_example.py``) + - 00:07.394 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py` (``007_interlaminar_normal_stress_example.py``) - - 00:07.347 + - 00:07.360 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py` (``009_short_fiber_orientation_tensor.py``) - - 00:05.877 - - 0.0 - * - :ref:`sphx_glr_examples_gallery_examples_014_cyclic_symmetry_example.py` (``014_cyclic_symmetry_example.py``) - - 00:05.728 + - 00:05.827 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_011_rst_workflow.py` (``011_rst_workflow.py``) - - 00:05.110 + - 00:05.043 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_002_sampling_point_example.py` (``002_sampling_point_example.py``) - - 00:04.837 + - 00:04.888 + - 0.0 + * - :ref:`sphx_glr_examples_gallery_examples_099_dpf_composite_failure_workflow.py` (``099_dpf_composite_failure_workflow.py``) + - 00:04.671 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py` (``006_filter_composite_data_example.py``) - - 00:04.682 + - 00:04.636 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_013_thermal_example.py` (``013_thermal_example.py``) - - 00:04.427 - - 0.0 - * - :ref:`sphx_glr_examples_gallery_examples_099_dpf_composite_failure_workflow.py` (``099_dpf_composite_failure_workflow.py``) - - 00:04.414 + - 00:04.181 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_008_assembly_example.py` (``008_assembly_example.py``) - - 00:04.157 + - 00:04.148 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_012_fatigue_example.py` (``012_fatigue_example.py``) - - 00:03.564 + - 00:03.799 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_004_get_material_properties_example.py` (``004_get_material_properties_example.py``) - - 00:03.523 + - 00:03.610 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_003_short_fiber_example.py` (``003_short_fiber_example.py``) - - 00:03.262 + - 00:03.287 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``005_get_layup_properties_example.py``) - - 00:01.399 + - 00:01.484 - 0.0 diff --git a/version/dev/_sources/sg_execution_times.rst.txt b/version/dev/_sources/sg_execution_times.rst.txt index 30a2cfa9c..606f7a8a6 100644 --- a/version/dev/_sources/sg_execution_times.rst.txt +++ b/version/dev/_sources/sg_execution_times.rst.txt @@ -6,7 +6,7 @@ Computation times ================= -**01:20.085** total execution time for 15 files **from all galleries**: +**01:22.317** total execution time for 15 files **from all galleries**: .. container:: @@ -33,47 +33,47 @@ Computation times - Time - Mem (MB) * - :ref:`sphx_glr_examples_gallery_examples_001_failure_operator_example.py` (``../../examples/001_failure_operator_example.py``) - - 00:11.642 + - 00:12.061 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_010_harmonic_example.py` (``../../examples/010_harmonic_example.py``) - - 00:10.117 + - 00:09.928 + - 0.0 + * - :ref:`sphx_glr_examples_gallery_examples_014_cyclic_symmetry_example.py` (``../../examples/014_cyclic_symmetry_example.py``) + - 00:07.394 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py` (``../../examples/007_interlaminar_normal_stress_example.py``) - - 00:07.347 + - 00:07.360 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py` (``../../examples/009_short_fiber_orientation_tensor.py``) - - 00:05.877 - - 0.0 - * - :ref:`sphx_glr_examples_gallery_examples_014_cyclic_symmetry_example.py` (``../../examples/014_cyclic_symmetry_example.py``) - - 00:05.728 + - 00:05.827 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_011_rst_workflow.py` (``../../examples/011_rst_workflow.py``) - - 00:05.110 + - 00:05.043 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_002_sampling_point_example.py` (``../../examples/002_sampling_point_example.py``) - - 00:04.837 + - 00:04.888 + - 0.0 + * - :ref:`sphx_glr_examples_gallery_examples_099_dpf_composite_failure_workflow.py` (``../../examples/099_dpf_composite_failure_workflow.py``) + - 00:04.671 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py` (``../../examples/006_filter_composite_data_example.py``) - - 00:04.682 + - 00:04.636 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_013_thermal_example.py` (``../../examples/013_thermal_example.py``) - - 00:04.427 - - 0.0 - * - :ref:`sphx_glr_examples_gallery_examples_099_dpf_composite_failure_workflow.py` (``../../examples/099_dpf_composite_failure_workflow.py``) - - 00:04.414 + - 00:04.181 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_008_assembly_example.py` (``../../examples/008_assembly_example.py``) - - 00:04.157 + - 00:04.148 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_012_fatigue_example.py` (``../../examples/012_fatigue_example.py``) - - 00:03.564 + - 00:03.799 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_004_get_material_properties_example.py` (``../../examples/004_get_material_properties_example.py``) - - 00:03.523 + - 00:03.610 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_003_short_fiber_example.py` (``../../examples/003_short_fiber_example.py``) - - 00:03.262 + - 00:03.287 - 0.0 * - :ref:`sphx_glr_examples_gallery_examples_005_get_layup_properties_example.py` (``../../examples/005_get_layup_properties_example.py``) - - 00:01.399 + - 00:01.484 - 0.0 diff --git a/version/dev/_static/search.json b/version/dev/_static/search.json index 7c7a23db1..107c10cfd 100644 --- a/version/dev/_static/search.json +++ b/version/dev/_static/search.json @@ -1,1095 +1,857 @@ [ { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.active.html#active", - "title": "active", - "section": "active", - "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.active.html#ansys.dpf.composites.failure_criteria.HoffmanCriterion.active", - "title": "active > active > active", - "section": "active > active", - "text": "property HoffmanCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rfind", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rfind.html#rfind", - "title": "rfind", - "section": "rfind", - "text": "Return the highest index in S where substring sub is found, such that sub is contained within S[start:end].\nOptional arguments start and end are interpreted as in slice notation.\nReturn -1 on failure.\nrfind" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rfind", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rfind.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.rfind", - "title": "rfind > rfind > rfind", - "section": "rfind > rfind", - "text": "FailureMeasureEnum.rfind(sub, [start, [end]], /)\n\nReturn the highest index in S where substring sub is found, such that sub is contained within S[start:end].\n\nOptional arguments start and end are interpreted as in slice notation.\nReturn -1 on failure.\n\n!! processed by numpydoc !!" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e13", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e13.html#wf_e13", - "title": "wf_e13", - "section": "wf_e13", - "text": "Weighting factor of the failure mode e13.\nfloat\nwf_e13\nfloat" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e13", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e13.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e13", - "title": "wf_e13 > wf_e13 > wf_e13", - "section": "wf_e13 > wf_e13", - "text": "property MaxStrainCriterion.wf_e13: float\n\nWeighting factor of the failure mode e13.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.ply_type", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.ply_type.html#ply_type", - "title": "ply_type", - "section": "ply_type", - "text": "ply_type" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.ply_type", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.ply_type.html#ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.ply_type", - "title": "ply_type > ply_type > ply_type", - "section": "ply_type > ply_type", - "text": "MaterialMetadata.ply_type: str | None = None\n\n" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.vMs", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.vMs.html#vms", - "title": "vMs", - "section": "vMs", - "text": "vMs" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.vMs", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.vMs.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.vMs", - "title": "vMs > vMs > vMs", - "section": "vMs > vMs", - "text": "FailureModeEnum.vMs = 1102\n\n" - }, - { - "objectID": "api/select_indices", - "href": "api/select_indices.html#select-elementary-indices", - "title": "Select elementary indices", - "section": "Select elementary indices", - "text": "This module provides functions to filter elementary data.\nA layered element has the following number of elementary data points:\nIn the preceding definition, number_of_spots indicates the number of through-the-thickness\nintegration points per layer. number_of_spots is controlled by keyoption 8, which\nindicates how much output is written. For example, you might write output for only 'bottom'\nand 'top' or for 'bottom', 'top', and 'mid'.\nEach elementary data point can have multiple components. For example, it might have one component\nfor scalar data or six components for symmetrical 3x3 tensors. The elementary data of an element\nis available as a 2D vector with shape (num_elementary_data, number_of_components).\nHere are some examples:\nGet the stress output for a layered shell element (181, four nodes) with five layers and\nkeyoption 8 = 2. Write the output for 'bot', 'top', and 'mid'.\nnumber_of_layers = 5\nnumber_of_spots = 3 (bottom, top, and middle)\nnumber_of_nodes_per_spot_plane = 4 (equal to number of nodes)\nnumber_of_components = 6\nThus, num_elementary_data = number_of_layers * number_of_spots * number_of_nodes_per_spot_plane\n= 60.\nGet the stress output for a layered solid element (185, eight nodes) with seven layers and\nkeyoption 8 = 1. Write the output for 'bot' and 'top'.\nnumber_of_layers = 7\nnumber_of_spots = 2 (bottom and top)\nnumber_of_nodes_per_spot_plane = 4\nnumber_of_components = 6\nThus, num_elementary_data = number_of_layers * number_of_spots * number_of_nodes_per_spot_plane\n= 56.\nThe functions in this module compute an array of elementary indices for a given selection of\nlayers, nodes, spots, DPF material IDs, or analysis plies. These elementary indices can be used\nto index the first axis of the elementary data array. For usage information, see\nsphx_glr_examples_gallery_examples_006_filter_composite_data_example.py.\nget_selected_indices(element_info[, layers, ...])\nGet elementary indices based on element information, layers, nodes, and spots.\nget_selected_indices_by_analysis_ply(...)\nGet selected indices by analysis ply.\nget_selected_indices_by_dpf_material_ids(...)\nGet selected indices by DPF material IDs.\nSelect elementary indices\nnumber_of_spots\nnumber_of_spots\nkeyoption 8\n'bottom'\n'top'\n'bottom'\n'top'\n'mid'\n(num_elementary_data, number_of_components)\nkeyoption 8 = 2\n'bot'\n'top'\n'mid'\nnumber_of_layers\nnumber_of_spots\nnumber_of_nodes_per_spot_plane\nnumber_of_components\nnum_elementary_data = number_of_layers * number_of_spots * number_of_nodes_per_spot_plane\nkeyoption 8 = 1\n'bot'\n'top'\nnumber_of_layers\nnumber_of_spots\nnumber_of_nodes_per_spot_plane\nnumber_of_components\nnum_elementary_data = number_of_layers * number_of_spots * number_of_nodes_per_spot_plane\nget_selected_indices\nget_selected_indices_by_analysis_ply\nget_selected_indices_by_dpf_material_ids" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hd", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hd.html#hd", - "title": "hd", - "section": "hd", - "text": "hd" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hd", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hd.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.hd", - "title": "hd > hd > hd", - "section": "hd > hd", - "text": "FailureModeEnum.hd = 603\n\n" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_thicknesses", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_thicknesses.html#get_layer_thicknesses", - "title": "get_layer_thicknesses", - "section": "get_layer_thicknesses", - "text": "Get thicknesses for all layers. Returns None if element is not layered.\nelement_id (int) – Element Id/Label\nOptional[ndarray[Any, dtype[float64]]]\nget_layer_thicknesses\nint\nOptional\nndarray\nAny\ndtype\nfloat64" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_thicknesses", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_thicknesses.html#ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_thicknesses", - "title": "get_layer_thicknesses > get_layer_thicknesses > get_layer_thicknesses", - "section": "get_layer_thicknesses > get_layer_thicknesses", - "text": "LayupPropertiesProvider.get_layer_thicknesses(element_id)\n\nGet thicknesses for all layers. Returns None if element is not layered.\n\nParameters\n\nelement_id (int) – Element Id/Label\n\nReturn type\n\nOptional[ndarray[Any, dtype[float64]]]\n\n!! processed by numpydoc !!" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.write_data_for_full_element_scope", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.write_data_for_full_element_scope.html#write_data_for_full_element_scope", - "title": "write_data_for_full_element_scope", - "section": "write_data_for_full_element_scope", - "text": "Whether to write the data for all element labels in the element scope.\nThis makes sense if an element scope is explicitly requested\nbut the actual scope where postprocessing has happened is smaller,\nperhaps due to ply scoping.\nwrite_data_for_full_element_scope" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.write_data_for_full_element_scope", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.write_data_for_full_element_scope.html#ansys.dpf.composites.result_definition.ResultDefinitionScope.write_data_for_full_element_scope", - "title": "write_data_for_full_element_scope > write_data_for_full_element_scope > write_data_for_full_element_scope", - "section": "write_data_for_full_element_scope > write_data_for_full_element_scope", - "text": "ResultDefinitionScope.write_data_for_full_element_scope: bool = True\n\nWhether to write the data for all element labels in the element scope.\n\nThis makes sense if an element scope is explicitly requested\nbut the actual scope where postprocessing has happened is smaller,\nperhaps due to ply scoping.\n\n!! processed by numpydoc !!" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K.html#thermal_conductivity_k", - "title": "Thermal_Conductivity_K", - "section": "Thermal_Conductivity_K", - "text": "Thermal_Conductivity_K" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K", - "title": "Thermal_Conductivity_K > Thermal_Conductivity_K > Thermal_Conductivity_K", - "section": "Thermal_Conductivity_K > Thermal_Conductivity_K", - "text": "MaterialProperty.Thermal_Conductivity_K: str = 'thermal_conductivity_isotropic'\n\n" - }, - { - "objectID": "examples/gallery_examples/001_failure_operator_example", - "href": "examples/gallery_examples/001_failure_operator_example.html#composite-failure-analysis", - "title": "Composite failure analysis", - "section": "Composite failure analysis", - "text": "This example shows how to analyze a composite structure by a combined failure criterion.\nThe failure operator of DPF Composites computes the minimum and maximum failure values\nand failure modes of a combined failure criterion. A combined failure criterion is a selection of\nfailure criteria such as Puck, Tsai-Wu, or face sheet wrinkling. For a list of all\nfailure criteria, see failure_criteria.\nThe Combined Failure Criterion class\nallows you to assess different type of materials and failure modes at once.\nThe scoping enables you to evaluate the minimum and maximum failures per element\nor select a list of materials or plies.\nWhen using a Workbench project,\nuse the get_composite_files_from_workbench_result_folder()\nmethod to obtain the input files.\nComposite failure analysis\nCombined Failure Criterion\nget_composite_files_from_workbench_result_folder()" - }, - { - "objectID": "examples/gallery_examples/001_failure_operator_example", - "href": "examples/gallery_examples/001_failure_operator_example.html#set-up-analysis", - "title": "Composite failure analysis > Set up analysis", - "section": "Set up analysis", - "text": "Setting up the analysis consists of loading Ansys libraries, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries.\nStart a DPF server and copy the example files into the current working directory.\nSet up analysis" - }, - { - "objectID": "examples/gallery_examples/001_failure_operator_example", - "href": "examples/gallery_examples/001_failure_operator_example.html#configure-combined-failure-criterion", - "title": "Composite failure analysis > Configure combined failure criterion", - "section": "Configure combined failure criterion", - "text": "Configure the combined failure criterion.\nConfigure combined failure criterion" - }, - { - "objectID": "examples/gallery_examples/001_failure_operator_example", - "href": "examples/gallery_examples/001_failure_operator_example.html#set-up-model-and-evaluate-failures", - "title": "Composite failure analysis > Set up model and evaluate failures", - "section": "Set up model and evaluate failures", - "text": "Set up the composite model.\nEvaluate failures for the entire model\nScope failure evaluation to a certain element scope.\nScope failure evaluation by plies.\nTotal running time of the script: (0 minutes 11.642 seconds)\nDownload Jupyter notebook: 001_failure_operator_example.ipynb\nDownload Python source code: 001_failure_operator_example.py\nDownload zipped: 001_failure_operator_example.zip\nGallery generated by Sphinx-Gallery\nSet up model and evaluate failures\nDownload Jupyter notebook: 001_failure_operator_example.ipynb\nDownload Python source code: 001_failure_operator_example.py\nDownload zipped: 001_failure_operator_example.zip" - }, - { - "objectID": "api/result_definition", - "href": "api/result_definition.html#result-definition", - "title": "Result definition", - "section": "Result definition", - "text": "ResultDefinition(name, ...[, measure, ...])\nRepresents the result definition of DPF Composites.\nResultDefinitionScope(composite_definition)\nProvides the result definition scope.\nFailureMeasureEnum(value[, names, module, ...])\nProvides available failure measures.\nResult definition\nResultDefinition\nResultDefinitionScope\nFailureMeasureEnum" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_dict.html#to_dict", - "title": "to_dict", - "section": "to_dict", - "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_dict", - "title": "to_dict > to_dict > to_dict", - "section": "to_dict > to_dict", - "text": "TsaiWuCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.count", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.count.html#count", - "title": "count", - "section": "count", - "text": "Return the number of non-overlapping occurrences of substring sub in string S[start:end].\nOptional arguments start and end are interpreted as in slice notation.\ncount" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.count", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.count.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.count", - "title": "count > count > count", - "section": "count > count", - "text": "FailureMeasureEnum.count(sub, [start, [end]], /)\n\nReturn the number of non-overlapping occurrences of substring sub in string S[start:end].\n\nOptional arguments start and end are interpreted as in slice notation.\n\n!! processed by numpydoc !!" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.stress_strain_eval_mode", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.stress_strain_eval_mode.html#stress_strain_eval_mode", - "title": "stress_strain_eval_mode", - "section": "stress_strain_eval_mode", - "text": "Results loaded from a result (RST) file by default.\nYou can set this property to \"mapdl_live\" to activate on-the-fly\nstrain and stress evaluation. This property can be used if the result\nfile contains only the primary results (deformations).\nstr\nstress_strain_eval_mode\n\"mapdl_live\"\nstr" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.stress_strain_eval_mode", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.stress_strain_eval_mode.html#ansys.dpf.composites.result_definition.ResultDefinition.stress_strain_eval_mode", - "title": "stress_strain_eval_mode > stress_strain_eval_mode > stress_strain_eval_mode", - "section": "stress_strain_eval_mode > stress_strain_eval_mode", - "text": "property ResultDefinition.stress_strain_eval_mode: str\n\nResults loaded from a result (RST) file by default.\n\nYou can set this property to \"mapdl_live\" to activate on-the-fly\nstrain and stress evaluation. This property can be used if the result\nfile contains only the primary results (deformations).\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR22", - "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR22.html#tensor22", - "title": "TENSOR22", - "section": "TENSOR22", - "text": "TENSOR22" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR22", - "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR22.html#ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR22", - "title": "TENSOR22 > TENSOR22 > TENSOR22", - "section": "TENSOR22 > TENSOR22", - "text": "Sym3x3TensorComponent.TENSOR22 = 1\n\n" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aY", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aY.html#thermal_expansion_coefficients_ay", - "title": "Thermal_Expansion_Coefficients_aY", - "section": "Thermal_Expansion_Coefficients_aY", - "text": "Thermal_Expansion_Coefficients_aY" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aY", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aY.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aY", - "title": "Thermal_Expansion_Coefficients_aY > Thermal_Expansion_Coefficients_aY > Thermal_Expansion_Coefficients_aY", - "section": "Thermal_Expansion_Coefficients_aY > Thermal_Expansion_Coefficients_aY", - "text": "MaterialProperty.Thermal_Expansion_Coefficients_aY: str = 'coefficient_thermal_expansion_y'\n\n" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s13", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s13.html#s13", - "title": "s13", - "section": "s13", - "text": "Out-of-plane shear stresses s13 of each ply.\nndarray[Any, dtype[float64]]\ns13\nndarray\nAny\ndtype\nfloat64" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s13", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s13.html#ansys.dpf.composites.sampling_point.SamplingPoint.s13", - "title": "s13 > s13 > s13", - "section": "s13 > s13", - "text": "property SamplingPoint.s13: ndarray[Any, dtype[float64]]\n\nOut-of-plane shear stresses s13 of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmt", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmt.html#wf_lmt", + "title": "wf_lmt", + "section": "wf_lmt", + "text": "Weighting factor of matrix failure due to tension (lmt).\nfloat\nwf_lmt\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_metadata", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_metadata.html#material_metadata", - "title": "material_metadata", - "section": "material_metadata", - "text": "DPF material ID to metadata map of the materials.\nThis data can be used to filter analysis plies\nor element layers by ply type, material name etc.\nNote: ply type is only available in DPF server version 9.0 (2025 R1 pre0) and later.\ndict[int, MaterialMetadata]\nmaterial_metadata\ndict\nint\nMaterialMetadata" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmt", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmt.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmt", + "title": "wf_lmt > wf_lmt > wf_lmt", + "section": "wf_lmt > wf_lmt", + "text": "property LaRCCriterion.wf_lmt: float\n\nWeighting factor of matrix failure due to tension (lmt).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_metadata", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_metadata.html#ansys.dpf.composites.composite_model.CompositeModel.material_metadata", - "title": "material_metadata > material_metadata > material_metadata", - "section": "material_metadata > material_metadata", - "text": "property CompositeModel.material_metadata: dict[int, MaterialMetadata]\n\nDPF material ID to metadata map of the materials.\n\nThis data can be used to filter analysis plies\nor element layers by ply type, material name etc.\n\nNote: ply type is only available in DPF server version 9.0 (2025 R1 pre0) and later.\n\nReturn type\n\ndict[int, MaterialMetadata]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.format_map", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.format_map.html#format_map", + "title": "format_map", + "section": "format_map", + "text": "Return a formatted version of the string, using substitutions from mapping.\nThe substitutions are identified by braces (‘{’ and ‘}’).\nformat_map" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_dict.html#to_dict", - "title": "to_dict", - "section": "to_dict", - "text": "Return the combined failure criterion as a dictionary.\ndict[str, Any]\nJSON dictionary that can be used for the result definition\nof the DPF Composites Failure evaluator operator.\nto_dict\ndict\nstr\nAny" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.format_map", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.format_map.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.format_map", + "title": "format_map > format_map > format_map", + "section": "format_map > format_map", + "text": "FailureMeasureEnum.format_map(mapping, /)\n\nReturn a formatted version of the string, using substitutions from mapping.\nThe substitutions are identified by braces (‘{’ and ‘}’).\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_dict", - "title": "to_dict > to_dict > to_dict", - "section": "to_dict > to_dict", - "text": "CombinedFailureCriterion.to_dict()\n\nReturn the combined failure criterion as a dictionary.\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\nJSON dictionary that can be used for the result definition\nof the DPF Composites Failure evaluator operator.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmA", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmA.html#pma", + "title": "pmA", + "section": "pmA", + "text": "pmA" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.files_are_local", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.files_are_local.html#files_are_local", - "title": "files_are_local", - "section": "files_are_local", - "text": "files_are_local" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmA", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmA.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.pmA", + "title": "pmA > pmA > pmA", + "section": "pmA > pmA", + "text": "FailureModeEnum.pmA = 802\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.files_are_local", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.files_are_local.html#ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.files_are_local", - "title": "files_are_local > files_are_local > files_are_local", - "section": "files_are_local > files_are_local", - "text": "ContinuousFiberCompositesFiles.files_are_local: bool = True\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmc.html#wf_pmc", + "title": "wf_pmc", + "section": "wf_pmc", + "text": "Weighting factor of the matrix failure (pmc) mode.\nfloat\nwf_pmc\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_json.html#to_json", - "title": "to_json", - "section": "to_json", - "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmc.html#ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmc", + "title": "wf_pmc > wf_pmc > wf_pmc", + "section": "wf_pmc > wf_pmc", + "text": "property PuckCriterion.wf_pmc: float\n\nWeighting factor of the matrix failure (pmc) mode.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_json.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_json", - "title": "to_json > to_json > to_json", - "section": "to_json > to_json", - "text": "MaxStrainCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2c", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2c.html#e2c", + "title": "e2c", + "section": "e2c", + "text": "e2c" }, { - "objectID": "api/failure_criteria", - "href": "api/failure_criteria.html#failure-criteria", - "title": "Failure criteria", - "section": "Failure criteria", - "text": "CombinedFailureCriterion([name, ...])\nDefines the combined failure criterion.\nCoreFailureCriterion(*[, include_ins, wf])\nDefines the core shear failure criterion for core materials like foam and honeycomb.\nCuntzeCriterion(*[, cfc, cft, cma, cmb, ...])\nDefines the Cuntze criterion for uni-directional orthotropic reinforced materials.\nFaceSheetWrinklingCriterion(*[, ...])\nDefines the face sheet wrinkling criterion for sandwiches (laminate with cores).\nHashinCriterion(*[, hf, hm, hd, dim, wf_hf, ...])\nDefines the Hashin failure criterion for UD reinforced materials.\nHoffmanCriterion(*[, active, wf, dim])\nDefines the Hoffman failure criterion for orthotropic reinforced materials.\nLaRCCriterion(*[, lft, lfc, lmt, lmc, dim, ...])\nDefines the LaRC failure criterion for UD reinforced materials.\nMaxStrainCriterion(*[, e1, e2, e3, e12, ...])\nDefines the maximum strain failure criterion for orthotropic reinforced materials.\nMaxStressCriterion(*[, s1, s2, s3, s12, ...])\nDefines the maximum stress failure criterion for orthotropic reinforced materials.\nPuckCriterion(*[, pf, pma, pmb, pmc, pd, ...])\nDefines the Puck failure criterion for UD reinforced materials.\nShearCrimpingCriterion(*[, kc, kf, wf])\nDefines the shear crimping failure criterion for sandwich structures.\nTsaiHillCriterion(*[, active, wf, dim])\nDefines the Tsai-Hill failure criterion for orthotropic reinforced materials.\nTsaiWuCriterion(*[, active, wf, dim])\nDefines the Tsai-Wu failure criterion for orthotropic reinforced materials.\nVonMisesCriterion(*[, vme, vms, wf_vme, ...])\nDefines the von Mises criterion for isotropic materials.\nFailureModeEnum(value[, names, module, ...])\n\nFailure criteria\nCombinedFailureCriterion\nCoreFailureCriterion\nCuntzeCriterion\nFaceSheetWrinklingCriterion\nHashinCriterion\nHoffmanCriterion\nLaRCCriterion\nMaxStrainCriterion\nMaxStressCriterion\nPuckCriterion\nShearCrimpingCriterion\nTsaiHillCriterion\nTsaiWuCriterion\nVonMisesCriterion\nFailureModeEnum" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2c", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2c.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e2c", + "title": "e2c > e2c > e2c", + "section": "e2c > e2c", + "text": "FailureModeEnum.e2c = 122\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_json.html#to_json", + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.to_json.html#to_json", "title": "to_json", "section": "to_json", "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_json.html#ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_json", + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.to_json.html#ansys.dpf.composites.failure_criteria.HashinCriterion.to_json", "title": "to_json > to_json > to_json", "section": "to_json > to_json", - "text": "FaceSheetWrinklingCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" + "text": "HashinCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lmc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lmc.html#lmc", - "title": "lmc", - "section": "lmc", - "text": "Whether to activate the failure evaluation of the matrix due to compression.\nbool\nlmc\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.ANGLE", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.ANGLE.html#angle", + "title": "ANGLE", + "section": "ANGLE", + "text": "ANGLE" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lmc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lmc.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.lmc", - "title": "lmc > lmc > lmc", - "section": "lmc > lmc", - "text": "property LaRCCriterion.lmc: bool\n\nWhether to activate the failure evaluation of the matrix due to compression.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.ANGLE", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.ANGLE.html#ansys.dpf.composites.layup_info.LayupProperty.ANGLE", + "title": "ANGLE > ANGLE > ANGLE", + "section": "ANGLE > ANGLE", + "text": "LayupProperty.ANGLE = 0\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3t", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3t.html#e3t", - "title": "e3t", - "section": "e3t", - "text": "e3t" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.dim", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.dim.html#dim", + "title": "dim", + "section": "dim", + "text": "Specifies which formulation of the failure criterion is used.\nint\ndim\nint" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3t", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3t.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e3t", - "title": "e3t > e3t > e3t", - "section": "e3t > e3t", - "text": "FailureModeEnum.e3t = 131\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.dim", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.dim.html#ansys.dpf.composites.failure_criteria.TsaiWuCriterion.dim", + "title": "dim > dim > dim", + "section": "dim > dim", + "text": "property TsaiWuCriterion.dim: int\n\nSpecifies which formulation of the failure criterion is used.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hm", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hm.html#wf_hm", - "title": "wf_hm", - "section": "wf_hm", - "text": "Whether to activate the failure evaluation regarding matrix failure.\nfloat\nwf_hm\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.html#elementinfo", + "title": "ElementInfo", + "section": "ElementInfo", + "text": "Provides lay-up information for an element.\nUse the ElementInfoProvider class to obtain the\nElementInfo class for an element.\nid (int) – Element ID or label.\nn_layers (int) – Number of layers. For non-layered elements, the value is 1.\nn_corner_nodes (int) – Number of corner nodes (without midside nodes).\nn_spots (int) – Number of spots (through-the-thickness integration points) per layer.\nelement_type (int) – APDL element type. For example, 181 for layered shells.\ndpf_material_ids (numpy.ndarray[Any, numpy.dtype[numpy.int64]]) – List of DPF material IDs for all layers.\nis_shell (bool) – Whether the element is a shell element.\nnumber_of_nodes_per_spot_plane (int) – Number of nodes per output plane. The value is equal\nto n_corner_nodes for shell elements and n_corner_nodes\ndivided by two for layered solid elements. The value is equal to -1\nfor non-layered elements.\nElementInfo.id\n\nElementInfo.n_layers\n\nElementInfo.n_corner_nodes\n\nElementInfo.n_spots\n\nElementInfo.is_layered\n\nElementInfo.element_type\n\nElementInfo.dpf_material_ids\n\nElementInfo.is_shell\n\nElementInfo.number_of_nodes_per_spot_plane\n\nElementInfo\nElementInfoProvider\nElementInfo\n1\n181\nn_corner_nodes\nn_corner_nodes\n-1\nElementInfo.id\nElementInfo.n_layers\nElementInfo.n_corner_nodes\nElementInfo.n_spots\nElementInfo.is_layered\nElementInfo.element_type\nElementInfo.dpf_material_ids\nElementInfo.is_shell\nElementInfo.number_of_nodes_per_spot_plane" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hm", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hm.html#ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hm", - "title": "wf_hm > wf_hm > wf_hm", - "section": "wf_hm > wf_hm", - "text": "property HashinCriterion.wf_hm: float\n\nWhether to activate the failure evaluation regarding matrix failure.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.html#ansys.dpf.composites.layup_info.ElementInfo", + "title": "ElementInfo > ElementInfo > ElementInfo", + "section": "ElementInfo > ElementInfo", + "text": "class ansys.dpf.composites.layup_info.ElementInfo(id, n_layers, n_corner_nodes, n_spots, is_layered, element_type, dpf_material_ids, is_shell, number_of_nodes_per_spot_plane)\n\nProvides lay-up information for an element.\n\nUse the ElementInfoProvider class to obtain the\nElementInfo class for an element.\n\nParameters\n\nid (int) – Element ID or label.\n\nn_layers (int) – Number of layers. For non-layered elements, the value is 1.\n\nn_corner_nodes (int) – Number of corner nodes (without midside nodes).\n\nn_spots (int) – Number of spots (through-the-thickness integration points) per layer.\n\nelement_type (int) – APDL element type. For example, 181 for layered shells.\n\ndpf_material_ids (numpy.ndarray[Any, numpy.dtype[numpy.int64]]) – List of DPF material IDs for all layers.\n\nis_shell (bool) – Whether the element is a shell element.\n\nnumber_of_nodes_per_spot_plane (int) – Number of nodes per output plane. The value is equal\nto n_corner_nodes for shell elements and n_corner_nodes\ndivided by two for layered solid elements. The value is equal to -1\nfor non-layered elements.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nElementInfo.id\n\n\n\nElementInfo.n_layers\n\n\n\nElementInfo.n_corner_nodes\n\n\n\nElementInfo.n_spots\n\n\n\nElementInfo.is_layered\n\n\n\nElementInfo.element_type\n\n\n\nElementInfo.dpf_material_ids\n\n\n\nElementInfo.is_shell\n\n\n\nElementInfo.number_of_nodes_per_spot_plane\n\n\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_indices", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_indices.html#get_indices", - "title": "get_indices", - "section": "get_indices", - "text": "Get the indices of the selected spots (interfaces) for each ply.\nThe indices are sorted from bottom to top.\nFor instance, this method can be used to access the stresses at the bottom of each ply.\nspots (Collection[Spot], default: (, , )) – Collection of spots. Only the indices of the bottom interfaces of plies\nare returned if [Spot.BOTTOM] is set.\nSequence[int]\nget_indices\nCollection\nSpot\n(, , )\n[Spot.BOTTOM]\nSequence\nint" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.element_scope", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.element_scope.html#element_scope", + "title": "element_scope", + "section": "element_scope", + "text": "element_scope" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_indices", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_indices.html#ansys.dpf.composites.sampling_point.SamplingPoint.get_indices", - "title": "get_indices > get_indices > get_indices", - "section": "get_indices > get_indices", - "text": "SamplingPoint.get_indices(spots=(Spot.BOTTOM, Spot.MIDDLE, Spot.TOP))\n\nGet the indices of the selected spots (interfaces) for each ply.\n\nThe indices are sorted from bottom to top.\nFor instance, this method can be used to access the stresses at the bottom of each ply.\n\nParameters\n\nspots (Collection[Spot], default: (, , )) – Collection of spots. Only the indices of the bottom interfaces of plies\nare returned if [Spot.BOTTOM] is set.\n\nExamples\n\n>>> ply_top_indices = sampling_point.get_indices([Spot.TOP])\n\nReturn type\n\nSequence[int]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.element_scope", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.element_scope.html#ansys.dpf.composites.result_definition.ResultDefinitionScope.element_scope", + "title": "element_scope > element_scope > element_scope", + "section": "element_scope > element_scope", + "text": "ResultDefinitionScope.element_scope: Sequence[int]\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.to_json", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.to_json.html#to_json", - "title": "to_json", - "section": "to_json", - "text": "Convert the dictionary representation of the result definition to a JSON dictionary.\nstr\nto_json\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R11", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R11.html#hill_yield_criterion_r11", + "title": "Hill_Yield_Criterion_R11", + "section": "Hill_Yield_Criterion_R11", + "text": "Hill_Yield_Criterion_R11" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.to_json", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.to_json.html#ansys.dpf.composites.result_definition.ResultDefinition.to_json", - "title": "to_json > to_json > to_json", - "section": "to_json > to_json", - "text": "ResultDefinition.to_json()\n\nConvert the dictionary representation of the result definition to a JSON dictionary.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R11", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R11.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R11", + "title": "Hill_Yield_Criterion_R11 > Hill_Yield_Criterion_R11 > Hill_Yield_Criterion_R11", + "section": "Hill_Yield_Criterion_R11 > Hill_Yield_Criterion_R11", + "text": "MaterialProperty.Hill_Yield_Criterion_R11: str = 'yield_stress_ratio_x_hill_criterion'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2t", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2t.html#s2t", - "title": "s2t", - "section": "s2t", - "text": "s2t" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s12", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s12.html#s12", + "title": "s12", + "section": "s12", + "text": "s12" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2t", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2t.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s2t", - "title": "s2t > s2t > s2t", - "section": "s2t > s2t", - "text": "FailureModeEnum.s2t = 221\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s12", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s12.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s12", + "title": "s12 > s12 > s12", + "section": "s12 > s12", + "text": "FailureModeEnum.s12 = 240\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_yz", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_yz.html#tsai_wu_constant_yz", - "title": "Tsai_Wu_Constant_yz", - "section": "Tsai_Wu_Constant_yz", - "text": "Tsai_Wu_Constant_yz" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.active.html#active", + "title": "active", + "section": "active", + "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_yz", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_yz.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_yz", - "title": "Tsai_Wu_Constant_yz > Tsai_Wu_Constant_yz > Tsai_Wu_Constant_yz", - "section": "Tsai_Wu_Constant_yz > Tsai_Wu_Constant_yz", - "text": "MaterialProperty.Tsai_Wu_Constant_yz: str = 'coupling_coef_yz_tsai_wu'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.active.html#ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.active", + "title": "active > active > active", + "section": "active > active", + "text": "property FaceSheetWrinklingCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmb", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmb.html#wf_cmb", - "title": "wf_cmb", - "section": "wf_cmb", - "text": "Weighting factor of matrix failure due to compression (cmb).\nfloat\nwf_cmb\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s1", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s1.html#s1", + "title": "s1", + "section": "s1", + "text": "Stresses in the material 1 direction of each ply.\nndarray[Any, dtype[float64]]\ns1\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmb", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmb.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmb", - "title": "wf_cmb > wf_cmb > wf_cmb", - "section": "wf_cmb > wf_cmb", - "text": "property CuntzeCriterion.wf_cmb: float\n\nWeighting factor of matrix failure due to compression (cmb).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s1", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s1.html#ansys.dpf.composites.sampling_point.SamplingPoint.s1", + "title": "s1 > s1 > s1", + "section": "s1 > s1", + "text": "property SamplingPoint.s1: ndarray[Any, dtype[float64]]\n\nStresses in the material 1 direction of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.html#facesheetwrinklingcriterion", - "title": "FaceSheetWrinklingCriterion", - "section": "FaceSheetWrinklingCriterion", - "text": "Defines the face sheet wrinkling criterion for sandwiches (laminate with cores).\nhomogeneous_core_coeff (float, default: 0.5) – Wrinkling coefficient (reduction factor) for homogeneous core materials.\nhoneycomb_core_coeff (float, default: 0.33) – Wrinkling coefficient (reduction factor) for honeycombs. The default is 0.33.\nwf (float, default: 1.0) – Weighting factor of the failure mode (wb or wt). The default is 0.5.\nFaceSheetWrinklingCriterion.to_dict()\n\nFaceSheetWrinklingCriterion.to_json()\n\nFaceSheetWrinklingCriterion.active\nThe failure criterion is suppressed if active is False.\nFaceSheetWrinklingCriterion.homogeneous_core_coeff\nWrinkling coefficient (reduction factor) for homogeneous core materials.\nFaceSheetWrinklingCriterion.honeycomb_core_coeff\nWrinkling coefficient (reduction factor) for honeycombs.\nFaceSheetWrinklingCriterion.name\nName of the failure criterion.\nFaceSheetWrinklingCriterion.wf\nWeighting factor of the failure mode (wb or wt).\nFaceSheetWrinklingCriterion\nfloat\n0.5\nfloat\n0.33\n0.33\nfloat\n1.0\n0.5\nFaceSheetWrinklingCriterion.to_dict\nFaceSheetWrinklingCriterion.to_json\nFaceSheetWrinklingCriterion.active\nFaceSheetWrinklingCriterion.homogeneous_core_coeff\nFaceSheetWrinklingCriterion.honeycomb_core_coeff\nFaceSheetWrinklingCriterion.name\nFaceSheetWrinklingCriterion.wf" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.homogeneous_core_coeff", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.homogeneous_core_coeff.html#homogeneous_core_coeff", + "title": "homogeneous_core_coeff", + "section": "homogeneous_core_coeff", + "text": "Wrinkling coefficient (reduction factor) for homogeneous core materials.\nfloat\nhomogeneous_core_coeff\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.html#ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion", - "title": "FaceSheetWrinklingCriterion > FaceSheetWrinklingCriterion > FaceSheetWrinklingCriterion", - "section": "FaceSheetWrinklingCriterion > FaceSheetWrinklingCriterion", - "text": "class ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion(*, homogeneous_core_coeff=0.5, honeycomb_core_coeff=0.33, wf=1.0)\n\nDefines the face sheet wrinkling criterion for sandwiches (laminate with cores).\n\nParameters\n\nhomogeneous_core_coeff (float, default: 0.5) – Wrinkling coefficient (reduction factor) for homogeneous core materials.\n\nhoneycomb_core_coeff (float, default: 0.33) – Wrinkling coefficient (reduction factor) for honeycombs. The default is 0.33.\n\nwf (float, default: 1.0) – Weighting factor of the failure mode (wb or wt). The default is 0.5.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nFaceSheetWrinklingCriterion.to_dict()\n\n\n\nFaceSheetWrinklingCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nFaceSheetWrinklingCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nFaceSheetWrinklingCriterion.homogeneous_core_coeff\n\nWrinkling coefficient (reduction factor) for homogeneous core materials.\n\nFaceSheetWrinklingCriterion.honeycomb_core_coeff\n\nWrinkling coefficient (reduction factor) for honeycombs.\n\nFaceSheetWrinklingCriterion.name\n\nName of the failure criterion.\n\nFaceSheetWrinklingCriterion.wf\n\nWeighting factor of the failure mode (wb or wt).\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.homogeneous_core_coeff", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.homogeneous_core_coeff.html#ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.homogeneous_core_coeff", + "title": "homogeneous_core_coeff > homogeneous_core_coeff > homogeneous_core_coeff", + "section": "homogeneous_core_coeff > homogeneous_core_coeff", + "text": "property FaceSheetWrinklingCriterion.homogeneous_core_coeff: float\n\nWrinkling coefficient (reduction factor) for homogeneous core materials.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.vme", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.vme.html#vme", - "title": "vme", - "section": "vme", - "text": "Whether to activate the von Mises strain criterion.\nbool\nvme\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hd", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hd.html#wf_hd", + "title": "wf_hd", + "section": "wf_hd", + "text": "Whether to activate the failure evaluation regarding delamination if dim is equal to 3.\nfloat\nwf_hd\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.vme", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.vme.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.vme", - "title": "vme > vme > vme", - "section": "vme > vme", - "text": "property VonMisesCriterion.vme: bool\n\nWhether to activate the von Mises strain criterion.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hd", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hd.html#ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hd", + "title": "wf_hd > wf_hd > wf_hd", + "section": "wf_hd > wf_hd", + "text": "property HashinCriterion.wf_hd: float\n\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.engineering_data", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.engineering_data.html#engineering_data", - "title": "engineering_data", - "section": "engineering_data", - "text": "engineering_data" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hf.html#hf", + "title": "hf", + "section": "hf", + "text": "Whether to activate the failure evaluation regarding fiber failure.\nbool\nhf\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.engineering_data", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.engineering_data.html#ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.engineering_data", - "title": "engineering_data > engineering_data > engineering_data", - "section": "engineering_data > engineering_data", - "text": "ContinuousFiberCompositesFiles.engineering_data: str | PathLike[str]\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hf.html#ansys.dpf.composites.failure_criteria.HashinCriterion.hf", + "title": "hf > hf > hf", + "section": "hf > hf", + "text": "property HashinCriterion.hf: bool\n\nWhether to activate the failure evaluation regarding fiber failure.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.maketrans", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.maketrans.html#maketrans", - "title": "maketrans", - "section": "maketrans", - "text": "Return a translation table usable for str.translate().\nIf there is only one argument, it must be a dictionary mapping Unicode\nordinals (integers) or characters to Unicode ordinals, strings or None.\nCharacter keys will be then converted to ordinals.\nIf there are two arguments, they must be strings of equal length, and\nin the resulting dictionary, each character in x will be mapped to the\ncharacter at the same position in y. If there is a third argument, it\nmust be a string, whose characters will be mapped to None in the result.\nmaketrans" + "objectID": "intro", + "href": "intro.html#getting-started", + "title": "Getting started", + "section": "Getting started", + "text": "Getting started" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.maketrans", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.maketrans.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.maketrans", - "title": "maketrans > maketrans > maketrans", - "section": "maketrans > maketrans", - "text": "static FailureMeasureEnum.maketrans(x, y=, z=, /)\n\nReturn a translation table usable for str.translate().\n\nIf there is only one argument, it must be a dictionary mapping Unicode\nordinals (integers) or characters to Unicode ordinals, strings or None.\nCharacter keys will be then converted to ordinals.\nIf there are two arguments, they must be strings of equal length, and\nin the resulting dictionary, each character in x will be mapped to the\ncharacter at the same position in y. If there is a third argument, it\nmust be a string, whose characters will be mapped to None in the result.\n\n!! processed by numpydoc !!" + "objectID": "intro", + "href": "intro.html#installation", + "title": "Getting started > Installation", + "section": "Installation", + "text": "PyDPF - Composites supports Ansys version 2023 R1 and later. Make sure you have a licensed copy of Ansys installed. See\nCompatibility to understand which ansys-dpf-composites version corresponds to which Ansys version.\nInstall the ansys-dpf-composites package with pip:\nTo install the optional dependencies used in the examples, add the [examples] suffix when installing the package:\nSpecific versions can be installed by specifying the version in the pip command. For example, Ansys 2023 R1 requires ansys-dpf-composites version 0.1.0:\nYou should use a virtual environment,\nbecause it keeps Python packages isolated from your system Python.\nInstallation\nansys-dpf-composites\nansys-dpf-composites\npip\n[examples]" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_layup_operator", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_layup_operator.html#get_layup_operator", - "title": "get_layup_operator", - "section": "get_layup_operator", - "text": "Get the lay-up operator.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nOperator\nget_layup_operator\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nOperator" + "objectID": "intro", + "href": "intro.html#examples", + "title": "Getting started > Examples", + "section": "Examples", + "text": "The examples/index section provides these basic examples for getting started:\nsphx_glr_examples_gallery_examples_001_failure_operator_example.py\nsphx_glr_examples_gallery_examples_002_sampling_point_example.py\nAt the end of each example, there is a button for downloading the example’s Python source code.\nInput files, such as the results file and composite definition, are downloaded from a Git\nrepository when running the example.\nFor larger models, initializing the CompositeModel class can be slow because it\nautomatically creates many different providers that are not needed in all workflows.\nConsider using the Lay-up information classes directly.\nExamples\nCompositeModel" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_layup_operator", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_layup_operator.html#ansys.dpf.composites.composite_model.CompositeModel.get_layup_operator", - "title": "get_layup_operator > get_layup_operator > get_layup_operator", - "section": "get_layup_operator > get_layup_operator", - "text": "CompositeModel.get_layup_operator(composite_definition_label=None)\n\nGet the lay-up operator.\n\nParameters\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\n\nReturn type\n\nOperator\n\n!! processed by numpydoc !!" + "objectID": "intro", + "href": "intro.html#start-from-a-local-ansys-workbench-project", + "title": "Getting started > Start from a local Ansys Workbench project", + "section": "Start from a local Ansys Workbench project", + "text": "To get started on a local Ansys Workbench project, first determine the result folder by\nright-clicking the solution object in Ansys Mechanical and selecting Open Solver Files Directory.\nThen call the get_composite_files_from_workbench_result_folder() function with this folder.\nThis code shows how to set up a project from Workbench, create a basic failure plot, and display\ndetailed output for a sampling point:\nStart from a local Ansys Workbench project\nget_composite_files_from_workbench_result_folder()" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E2", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E2.html#engineering_constants_e2", - "title": "Engineering_Constants_E2", - "section": "Engineering_Constants_E2", - "text": "Engineering_Constants_E2" + "objectID": "intro", + "href": "intro.html#compatibility", + "title": "Getting started > Compatibility", + "section": "Compatibility", + "text": "The following table shows which ansys-dpf-composites version is compatible with which server version (Ansys version). See Get DPF Docker image to get the pre-releases.\nBy default the DPF server is started from the latest Ansys installer. To choose a specific Ansys version or connect to an existing server, use the appropriate arguments for connect_to_or_start_server()\nServer version\nansys.dpf.composites Python module version\n9.0 (Ansys 2025 R1 pre0)\n0.3.0 and later\n8.1 (Ansys 2024 R2 pre1)\n0.3.0 and later\n8.0 (Ansys 2024 R2 pre0)\n0.3.0 and later\n7.0 (Ansys 2024 R1)\n0.3.0 and later\n7.0 (Ansys 2024 R1 pre0)\n0.3.0 and later\n6.2 (Ansys 2023 R2)\n0.2.0 and 0.3\n6.1 (Ansys 2023 R2 pre1)\n0.2.0 and 0.3\n6.0 (Ansys 2023 R2 pre0)\nNot available. The composites plugin is not part of the Ansys 2023 R2 pre0 release.\n5.0 (Ansys 2023 R1)\n0.1.0\nCompatibility\nansys-dpf-composites\nconnect_to_or_start_server()" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E2", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E2.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E2", - "title": "Engineering_Constants_E2 > Engineering_Constants_E2 > Engineering_Constants_E2", - "section": "Engineering_Constants_E2 > Engineering_Constants_E2", - "text": "MaterialProperty.Engineering_Constants_E2: str = 'young_modulus_y_direction'\n\n" + "objectID": "intro", + "href": "intro.html#getting-the-dpf-server-docker-image", + "title": "Getting started > Getting the DPF server Docker image", + "section": "Getting the DPF server Docker image", + "text": "Follow the steps described in the DPF documentation in the section Run DPF Server in A Docker Container.\nMake sure you also download the composites plugin (e.g ansys_dpf_composites_lin_v2024.1.pre0.zip).\nAfter following the preceding steps, you should have a running DPF Docker container that listens to port 50052.\nGetting the DPF server Docker image\nansys_dpf_composites_lin_v2024.1.pre0.zip" }, { - "objectID": "examples/gallery_examples/009_short_fiber_orientation_tensor", - "href": "examples/gallery_examples/009_short_fiber_orientation_tensor.html#plot-of-the-orientation-tensor-for-short-fiber-composites", - "title": "Plot of the orientation tensor for short fiber composites", - "section": "Plot of the orientation tensor for short fiber composites", - "text": "This example shows how to reconstruct and plot the components\nof the fiber orientation tensor in the global coordinate system.\nFor more details about the fiber orientation tensor,\nrefer to the Short Fiber Composites help.\nTo run this example you first need to install the SciPy package.\nPlot of the orientation tensor for short fiber composites" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pd", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pd.html#wf_pd", + "title": "wf_pd", + "section": "wf_pd", + "text": "Weighting factor of the delamination failure (pd) mode.\nfloat\nwf_pd\nfloat" }, { - "objectID": "examples/gallery_examples/009_short_fiber_orientation_tensor", - "href": "examples/gallery_examples/009_short_fiber_orientation_tensor.html#set-up-analysis", - "title": "Plot of the orientation tensor for short fiber composites > Set up analysis", - "section": "Set up analysis", - "text": "Setting up the analysis consists of loading Ansys libraries, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries.\nStart a DPF server and copy the example files into the current working directory.\nThese files are needed:\nMechanical APDL result (RST) file containing the simulation results\nMechanical APDL input file (DS.DAT) containing the fiber orientation tensor data\nSet up analysis" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pd", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pd.html#ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pd", + "title": "wf_pd > wf_pd > wf_pd", + "section": "wf_pd > wf_pd", + "text": "property PuckCriterion.wf_pd: float\n\nWeighting factor of the delamination failure (pd) mode.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/009_short_fiber_orientation_tensor", - "href": "examples/gallery_examples/009_short_fiber_orientation_tensor.html#set-up-data-sources", - "title": "Plot of the orientation tensor for short fiber composites > Set up data sources", - "section": "Set up data sources", - "text": "Set up the data sources.\nSet up data sources" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e23", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e23.html#wf_e23", + "title": "wf_e23", + "section": "wf_e23", + "text": "Weighting factor of the failure mode e23.\nfloat\nwf_e23\nfloat" }, { - "objectID": "examples/gallery_examples/009_short_fiber_orientation_tensor", - "href": "examples/gallery_examples/009_short_fiber_orientation_tensor.html#initialize-dpf-model", - "title": "Plot of the orientation tensor for short fiber composites > Initialize DPF model", - "section": "Initialize DPF model", - "text": "Initialize the DPF model.\nShould your mesh contain both solid and shell elements, for visualization purposes\nit can be useful to scope the mesh to the solid ones.\nInitialize DPF model" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e23", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e23.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e23", + "title": "wf_e23 > wf_e23 > wf_e23", + "section": "wf_e23 > wf_e23", + "text": "property MaxStrainCriterion.wf_e23: float\n\nWeighting factor of the failure mode e23.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/009_short_fiber_orientation_tensor", - "href": "examples/gallery_examples/009_short_fiber_orientation_tensor.html#plot-input-data", - "title": "Plot of the orientation tensor for short fiber composites > Plot input data", - "section": "Plot input data", - "text": "Plot the two largest eigenvalues (a11 and a22) of the fiber orientation tensor.\nNote that the plots reveal the presence of a weld line in the middle of the specimen.\nPlot input data" + "objectID": "examples/gallery_examples/004_get_material_properties_example", + "href": "examples/gallery_examples/004_get_material_properties_example.html#material-properties-and-custom-failure-criterion", + "title": "Material properties and custom failure criterion", + "section": "Material properties and custom failure criterion", + "text": "This example shows how to access constant material properties and how to\nimplement a custom failure criterion. The failure criterion is computed for\nall layers and integration points. Finally, the elemental maximum is computed and shown.\nOnly constant material properties are currently supported.\nWhen using a Workbench project,\nuse the get_composite_files_from_workbench_result_folder()\nmethod to obtain the input files.\nMaterial properties and custom failure criterion\nget_composite_files_from_workbench_result_folder()" }, { - "objectID": "examples/gallery_examples/009_short_fiber_orientation_tensor", - "href": "examples/gallery_examples/009_short_fiber_orientation_tensor.html#compute-results", - "title": "Plot of the orientation tensor for short fiber composites > Compute results", - "section": "Compute results", - "text": "Reconstruct the fiber orientation tensor in the global coordinate system.\nCompute results" + "objectID": "examples/gallery_examples/004_get_material_properties_example", + "href": "examples/gallery_examples/004_get_material_properties_example.html#script", + "title": "Material properties and custom failure criterion > Script", + "section": "Script", + "text": "Import dependencies\nStart a server and get the examples files.\nThis will copy the example files into the current working directory.\nSet up the composite model\nGet dictionary that maps dpf_material_id to properties\nThe creation of the dictionary is currently quite slow and\nshould be done before using the properties in a loop.\nCurrently only constant properties are supported.\nFor variable material properties, the default value is returned.\nGet strain field\nImplement a custom failure criterion: basic max strain\nTotal running time of the script: (0 minutes 3.610 seconds)\nDownload Jupyter notebook: 004_get_material_properties_example.ipynb\nDownload Python source code: 004_get_material_properties_example.py\nDownload zipped: 004_get_material_properties_example.zip\nGallery generated by Sphinx-Gallery\nScript\nDownload Jupyter notebook: 004_get_material_properties_example.ipynb\nDownload Python source code: 004_get_material_properties_example.py\nDownload zipped: 004_get_material_properties_example.zip" }, { - "objectID": "examples/gallery_examples/009_short_fiber_orientation_tensor", - "href": "examples/gallery_examples/009_short_fiber_orientation_tensor.html#plot-results", - "title": "Plot of the orientation tensor for short fiber composites > Plot results", - "section": "Plot results", - "text": "Plot some components of the fiber orientation tensor.\nTotal running time of the script: (0 minutes 5.877 seconds)\nDownload Jupyter notebook: 009_short_fiber_orientation_tensor.ipynb\nDownload Python source code: 009_short_fiber_orientation_tensor.py\nDownload zipped: 009_short_fiber_orientation_tensor.zip\nGallery generated by Sphinx-Gallery\nPlot results\nDownload Jupyter notebook: 009_short_fiber_orientation_tensor.ipynb\nDownload Python source code: 009_short_fiber_orientation_tensor.py\nDownload zipped: 009_short_fiber_orientation_tensor.zip" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_container_helper_op", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_container_helper_op.html#material_container_helper_op", + "title": "material_container_helper_op", + "section": "material_container_helper_op", + "text": "Get material container helper operator.\nThis operator can be used to access metadata of the materials.\nReturn value is None if the server version does not support this operator.\nThe minimum version is 2024 R1-pre0 (7.1).\nOperator\nmaterial_container_helper_op\nOperator" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE_REF_SURFACE", - "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE_REF_SURFACE.html#failure_value_ref_surface", - "title": "FAILURE_VALUE_REF_SURFACE", - "section": "FAILURE_VALUE_REF_SURFACE", - "text": "FAILURE_VALUE_REF_SURFACE" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_container_helper_op", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_container_helper_op.html#ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_container_helper_op", + "title": "material_container_helper_op > material_container_helper_op > material_container_helper_op", + "section": "material_container_helper_op > material_container_helper_op", + "text": "property MaterialOperators.material_container_helper_op: Operator\n\nGet material container helper operator.\n\nThis operator can be used to access metadata of the materials.\nReturn value is None if the server version does not support this operator.\nThe minimum version is 2024 R1-pre0 (7.1).\n\nReturn type\n\nOperator\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE_REF_SURFACE", - "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE_REF_SURFACE.html#ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE_REF_SURFACE", - "title": "FAILURE_VALUE_REF_SURFACE > FAILURE_VALUE_REF_SURFACE > FAILURE_VALUE_REF_SURFACE", - "section": "FAILURE_VALUE_REF_SURFACE > FAILURE_VALUE_REF_SURFACE", - "text": "FailureOutput.FAILURE_VALUE_REF_SURFACE = 4\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.server_helpers.upload_short_fiber_composite_files_to_server", + "href": "api/_autosummary/ansys.dpf.composites.server_helpers.upload_short_fiber_composite_files_to_server.html#upload_short_fiber_composite_files_to_server", + "title": "upload_short_fiber_composite_files_to_server", + "section": "upload_short_fiber_composite_files_to_server", + "text": "Upload short fiber composites files to server.\ndata_files (ShortFiberCompositesFiles)\nserver (BaseServer)\nShortFiberCompositesFiles\nupload_short_fiber_composite_files_to_server\nShortFiberCompositesFiles\nBaseServer\nShortFiberCompositesFiles" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.html#materialmetadata", - "title": "MaterialMetadata", - "section": "MaterialMetadata", - "text": "Material metadata such as name and ply type.\ndpf_material_id (int) – Material index in the DPF materials container.\nmaterial_name (str) – Name of the material. Is empty if the name is not available.\nply_type (str | None) – Ply type. One of regular, woven, honeycomb_core,\nisotropic_homogeneous_core, orthotropic_homogeneous_core,\nisotropic, adhesive, undefined. Regular stands for uni-directional.\nNone if the DPF server older than 2025 R1 pre 0 (9.0).\nsolver_material_id (int | None) – Material index of the solver.\nNone if DPF server older than 2024 R1 pre 0 (8.0).\nMaterialMetadata.dpf_material_id\n\nMaterialMetadata.material_name\n\nMaterialMetadata.ply_type\n\nMaterialMetadata.solver_material_id\n\nMaterialMetadata\nMaterialMetadata.dpf_material_id\nMaterialMetadata.material_name\nMaterialMetadata.ply_type\nMaterialMetadata.solver_material_id" + "objectID": "api/_autosummary/ansys.dpf.composites.server_helpers.upload_short_fiber_composite_files_to_server", + "href": "api/_autosummary/ansys.dpf.composites.server_helpers.upload_short_fiber_composite_files_to_server.html#ansys.dpf.composites.server_helpers.upload_short_fiber_composite_files_to_server", + "title": "upload_short_fiber_composite_files_to_server > upload_short_fiber_composite_files_to_server > upload_short_fiber_composite_files_to_server", + "section": "upload_short_fiber_composite_files_to_server > upload_short_fiber_composite_files_to_server", + "text": "ansys.dpf.composites.server_helpers.upload_short_fiber_composite_files_to_server(data_files, server)\n\nUpload short fiber composites files to server.\n\nParameters\n\ndata_files (ShortFiberCompositesFiles)\n\nserver (BaseServer)\n\nReturn type\n\nShortFiberCompositesFiles\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.html#ansys.dpf.composites.layup_info.material_properties.MaterialMetadata", - "title": "MaterialMetadata > MaterialMetadata > MaterialMetadata", - "section": "MaterialMetadata > MaterialMetadata", - "text": "class ansys.dpf.composites.layup_info.material_properties.MaterialMetadata(dpf_material_id=0, material_name='', ply_type=None, solver_material_id=None)\n\nMaterial metadata such as name and ply type.\n\nParameters\n\ndpf_material_id (int) – Material index in the DPF materials container.\n\nmaterial_name (str) – Name of the material. Is empty if the name is not available.\n\nply_type (str | None) – Ply type. One of regular, woven, honeycomb_core,\nisotropic_homogeneous_core, orthotropic_homogeneous_core,\nisotropic, adhesive, undefined. Regular stands for uni-directional.\nNone if the DPF server older than 2025 R1 pre 0 (9.0).\n\nsolver_material_id (int | None) – Material index of the solver.\nNone if DPF server older than 2024 R1 pre 0 (8.0).\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nMaterialMetadata.dpf_material_id\n\n\n\nMaterialMetadata.material_name\n\n\n\nMaterialMetadata.ply_type\n\n\n\nMaterialMetadata.solver_material_id\n\n\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.html#shortfibercompositesfiles", + "title": "ShortFiberCompositesFiles", + "section": "ShortFiberCompositesFiles", + "text": "Provides the container for short fiber composite file paths.\nShortFiberCompositesFiles.files_are_local\n\nShortFiberCompositesFiles.rst\n\nShortFiberCompositesFiles.dsdat\n\nShortFiberCompositesFiles.engineering_data\n\nShortFiberCompositesFiles\nShortFiberCompositesFiles.files_are_local\nShortFiberCompositesFiles.rst\nShortFiberCompositesFiles.dsdat\nShortFiberCompositesFiles.engineering_data" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.MIXED", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.MIXED.html#mixed", - "title": "MIXED", - "section": "MIXED", - "text": "MIXED" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.html#ansys.dpf.composites.data_sources.ShortFiberCompositesFiles", + "title": "ShortFiberCompositesFiles > ShortFiberCompositesFiles > ShortFiberCompositesFiles", + "section": "ShortFiberCompositesFiles > ShortFiberCompositesFiles", + "text": "class ansys.dpf.composites.data_sources.ShortFiberCompositesFiles(rst, dsdat, engineering_data, files_are_local=True)\n\nProvides the container for short fiber composite file paths.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nShortFiberCompositesFiles.files_are_local\n\n\n\nShortFiberCompositesFiles.rst\n\n\n\nShortFiberCompositesFiles.dsdat\n\n\n\nShortFiberCompositesFiles.engineering_data\n\n\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.MIXED", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.MIXED.html#ansys.dpf.composites.layup_info.LayupModelContextType.MIXED", - "title": "MIXED > MIXED > MIXED", - "section": "MIXED > MIXED", - "text": "LayupModelContextType.MIXED = 3\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.svm", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.svm.html#svm", + "title": "svm", + "section": "svm", + "text": "svm" }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.add_results_to_plot", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.add_results_to_plot.html#add_results_to_plot", - "title": "add_results_to_plot", - "section": "add_results_to_plot", - "text": "Add results (strain, stress, or failure values) to an Axes object.\naxes (Any) – Matplotlib Axes object.\ncomponents (Sequence[str]) – List of result components. Valid components for\nstrain are \"e1\", \"e2\", \"e3\", \"e12\", \"e13\",\nand \"e23\" Valid components for stress are \"s1\", \"s2\",\n\"s3\", \"s12\", \"s13\", and \"s23\". Valid components\nfor failure are \"inverse_reserve_factor\", \"reserve_factor\",\nand \"margin_of_safety\".\nspots (Collection[Spot], default: (, )) – Collection of spots (interfaces).\ncore_scale_factor (float, default: 1.0) – Factor for scaling the thickness of core plies.\ntitle (str, default: '') – Title of the plot. This parameter is ignored if empty.\nxlabel (str, default: '') – Becomes the label of the x-axis. This parameter is ignored if empty.\nNone\nadd_results_to_plot\nAxes\nAny\nAxes\nSequence\nstr\n\"e1\"\n\"e2\"\n\"e3\"\n\"e12\"\n\"e13\"\n\"e23\"\n\"s1\",\n\"s2\"\n\"s3\"\n\"s12\"\n\"s13\"\n\"s23\"\n\"inverse_reserve_factor\"\n\"reserve_factor\"\n\"margin_of_safety\"\nCollection\nSpot\n(, )\nfloat\n1.0\nstr\n''\nstr\n''\nNone" + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.svm", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.svm.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.svm", + "title": "svm > svm > svm", + "section": "svm > svm", + "text": "FailureModeEnum.svm = 202\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.add_results_to_plot", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.add_results_to_plot.html#ansys.dpf.composites.sampling_point.SamplingPoint.add_results_to_plot", - "title": "add_results_to_plot > add_results_to_plot > add_results_to_plot", - "section": "add_results_to_plot > add_results_to_plot", - "text": "SamplingPoint.add_results_to_plot(axes, components, spots=(Spot.BOTTOM, Spot.TOP), core_scale_factor=1.0, title='', xlabel='')\n\nAdd results (strain, stress, or failure values) to an Axes object.\n\nParameters\n\naxes (Any) – Matplotlib Axes object.\n\ncomponents (Sequence[str]) – List of result components. Valid components for\nstrain are \"e1\", \"e2\", \"e3\", \"e12\", \"e13\",\nand \"e23\" Valid components for stress are \"s1\", \"s2\",\n\"s3\", \"s12\", \"s13\", and \"s23\". Valid components\nfor failure are \"inverse_reserve_factor\", \"reserve_factor\",\nand \"margin_of_safety\".\n\nspots (Collection[Spot], default: (, )) – Collection of spots (interfaces).\n\ncore_scale_factor (float, default: 1.0) – Factor for scaling the thickness of core plies.\n\ntitle (str, default: '') – Title of the plot. This parameter is ignored if empty.\n\nxlabel (str, default: '') – Becomes the label of the x-axis. This parameter is ignored if empty.\n\nExamples\n\n>>> import matplotlib.pyplot as plt\n>>> fig, ax1 = plt.subplots()\n>>> sampling_point.add_results_to_plot(ax1,\n [\"s13\", \"s23\", \"s3\"],\n [Spot.BOTTOM, Spot.TOP],\n 0.1, \"Interlaminar Stresses\", \"[MPa]\")\n\nReturn type\n\nNone\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu13", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu13.html#engineering_constants_nu13", + "title": "Engineering_Constants_nu13", + "section": "Engineering_Constants_nu13", + "text": "Engineering_Constants_nu13" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.rst_files", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.rst_files.html#rst_files", - "title": "rst_files", - "section": "rst_files", - "text": "Path of the result (RST) files.\nlist[Union[str, PathLike[str]]]\nrst_files\nlist\nUnion\nstr\nPathLike\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu13", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu13.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu13", + "title": "Engineering_Constants_nu13 > Engineering_Constants_nu13 > Engineering_Constants_nu13", + "section": "Engineering_Constants_nu13 > Engineering_Constants_nu13", + "text": "MaterialProperty.Engineering_Constants_nu13: str = 'poisson_ratio_xz'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.rst_files", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.rst_files.html#ansys.dpf.composites.result_definition.ResultDefinition.rst_files", - "title": "rst_files > rst_files > rst_files", - "section": "rst_files > rst_files", - "text": "property ResultDefinition.rst_files: list[str | PathLike[str]]\n\nPath of the result (RST) files.\n\nReturn type\n\nlist[Union[str, PathLike[str]]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZc.html#ezc", + "title": "eZc", + "section": "eZc", + "text": "Global compressive strain limit in material direction 3.\nfloat\neZc\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hf.html#wf_hf", - "title": "wf_hf", - "section": "wf_hf", - "text": "Whether to activate the failure evaluation regarding fiber failure.\nfloat\nwf_hf\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZc.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZc", + "title": "eZc > eZc > eZc", + "section": "eZc > eZc", + "text": "property MaxStrainCriterion.eZc: float\n\nGlobal compressive strain limit in material direction 3.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hf.html#ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hf", - "title": "wf_hf > wf_hf > wf_hf", - "section": "wf_hf > wf_hf", - "text": "property HashinCriterion.wf_hf: float\n\nWhether to activate the failure evaluation regarding fiber failure.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.sc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.sc.html#sc", + "title": "sc", + "section": "sc", + "text": "sc" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.spots_per_ply", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.spots_per_ply.html#spots_per_ply", - "title": "spots_per_ply", - "section": "spots_per_ply", - "text": "Number of through-the-thickness integration points per ply.\nint\nspots_per_ply\nint" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.sc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.sc.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.sc", + "title": "sc > sc > sc", + "section": "sc > sc", + "text": "FailureModeEnum.sc = 330\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.spots_per_ply", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.spots_per_ply.html#ansys.dpf.composites.sampling_point.SamplingPoint.spots_per_ply", - "title": "spots_per_ply > spots_per_ply > spots_per_ply", - "section": "spots_per_ply > spots_per_ply", - "text": "property SamplingPoint.spots_per_ply: int\n\nNumber of through-the-thickness integration points per ply.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R22", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R22.html#hill_yield_criterion_r22", + "title": "Hill_Yield_Criterion_R22", + "section": "Hill_Yield_Criterion_R22", + "text": "Hill_Yield_Criterion_R22" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s2", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s2.html#s2", - "title": "s2", - "section": "s2", - "text": "Stresses in the material 2 direction of each ply.\nndarray[Any, dtype[float64]]\ns2\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R22", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R22.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R22", + "title": "Hill_Yield_Criterion_R22 > Hill_Yield_Criterion_R22 > Hill_Yield_Criterion_R22", + "section": "Hill_Yield_Criterion_R22 > Hill_Yield_Criterion_R22", + "text": "MaterialProperty.Hill_Yield_Criterion_R22: str = 'yield_stress_ratio_y_hill_criterion'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s2", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s2.html#ansys.dpf.composites.sampling_point.SamplingPoint.s2", - "title": "s2 > s2 > s2", - "section": "s2 > s2", - "text": "property SamplingPoint.s2: ndarray[Any, dtype[float64]]\n\nStresses in the material 2 direction of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.html#maxstresscriterion", + "title": "MaxStressCriterion", + "section": "MaxStressCriterion", + "text": "Defines the maximum stress failure criterion for orthotropic reinforced materials.\ns1 (bool, default: True) – Whether to activate the failure evaluation regarding the stress in the material 1 direction.\ns2 (bool, default: True) – Whether to activate the failure evaluation regarding the stress in the material 2 direction.\ns3 (bool, default: False) – Whether to activate the failure evaluation regarding the stress in the material 3 direction (out-of-plane).\ns12 (bool, default: True) – Whether to activate the failure evaluation regarding the in-plane shear stress s12.\ns13 (bool, default: False) – Whether to activate the failure evaluation regarding the interlaminar shear stress s13.\ns23 (bool, default: False) – Whether to activate the failure evaluation regarding the interlaminar shear stress s23.\nwf_s1 (float, default: 1.0) – Weighting factor of the failure mode s1.\nwf_s2 (float, default: 1.0) – Weighting factor of the failure mode s2.\nwf_s3 (float, default: 1.0) – Weighting factor of the failure mode s3.\nwf_s12 (float, default: 1.0) – Weighting factor of the failure mode s12.\nwf_s13 (float, default: 1.0) – Weighting factor of the failure mode s13.\nwf_s23 (float, default: 1.0) – Weighting factor of the failure mode s23.\nMaxStressCriterion.to_dict()\n\nMaxStressCriterion.to_json()\n\nMaxStressCriterion.active\nThe failure criterion is suppressed if active is False.\nMaxStressCriterion.name\nName of the failure criterion.\nMaxStressCriterion.s1\nWhether to activate the failure evaluation regarding the stress in the material 1 direction.\nMaxStressCriterion.s12\nWhether to activate the failure evaluation regarding the in-plane shear stress s12.\nMaxStressCriterion.s13\nWhether to activate the failure evaluation regarding the interlaminar shear stress s13.\nMaxStressCriterion.s2\nWhether to activate the failure evaluation regarding the stress in the material 2 direction.\nMaxStressCriterion.s23\nWhether to activate the failure evaluation regarding the interlaminar shear stress s23.\nMaxStressCriterion.s3\nWhether to activate the failure evaluation regarding the stress in the material 3 direction (out-of-plane).\nMaxStressCriterion.wf_s1\nWeighting factor of the failure mode s1.\nMaxStressCriterion.wf_s12\nWeighting factor of the failure mode s12.\nMaxStressCriterion.wf_s13\nWeighting factor of the failure mode s13.\nMaxStressCriterion.wf_s2\nWeighting factor of the failure mode s2.\nMaxStressCriterion.wf_s23\nWeighting factor of the failure mode s23.\nMaxStressCriterion.wf_s3\nWeighting factor of the failure mode s3.\nMaxStressCriterion\nbool\nTrue\nbool\nTrue\nbool\nFalse\nbool\nTrue\nbool\nFalse\nbool\nFalse\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nMaxStressCriterion.to_dict\nMaxStressCriterion.to_json\nMaxStressCriterion.active\nMaxStressCriterion.name\nMaxStressCriterion.s1\nMaxStressCriterion.s12\nMaxStressCriterion.s13\nMaxStressCriterion.s2\nMaxStressCriterion.s23\nMaxStressCriterion.s3\nMaxStressCriterion.wf_s1\nMaxStressCriterion.wf_s12\nMaxStressCriterion.wf_s13\nMaxStressCriterion.wf_s2\nMaxStressCriterion.wf_s23\nMaxStressCriterion.wf_s3" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1t", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1t.html#s1t", - "title": "s1t", - "section": "s1t", - "text": "s1t" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion", + "title": "MaxStressCriterion > MaxStressCriterion > MaxStressCriterion", + "section": "MaxStressCriterion > MaxStressCriterion", + "text": "class ansys.dpf.composites.failure_criteria.MaxStressCriterion(*, s1=True, s2=True, s3=False, s12=True, s13=False, s23=False, wf_s1=1.0, wf_s2=1.0, wf_s3=1.0, wf_s12=1.0, wf_s13=1.0, wf_s23=1.0)\n\nDefines the maximum stress failure criterion for orthotropic reinforced materials.\n\nParameters\n\ns1 (bool, default: True) – Whether to activate the failure evaluation regarding the stress in the material 1 direction.\n\ns2 (bool, default: True) – Whether to activate the failure evaluation regarding the stress in the material 2 direction.\n\ns3 (bool, default: False) – Whether to activate the failure evaluation regarding the stress in the material 3 direction (out-of-plane).\n\ns12 (bool, default: True) – Whether to activate the failure evaluation regarding the in-plane shear stress s12.\n\ns13 (bool, default: False) – Whether to activate the failure evaluation regarding the interlaminar shear stress s13.\n\ns23 (bool, default: False) – Whether to activate the failure evaluation regarding the interlaminar shear stress s23.\n\nwf_s1 (float, default: 1.0) – Weighting factor of the failure mode s1.\n\nwf_s2 (float, default: 1.0) – Weighting factor of the failure mode s2.\n\nwf_s3 (float, default: 1.0) – Weighting factor of the failure mode s3.\n\nwf_s12 (float, default: 1.0) – Weighting factor of the failure mode s12.\n\nwf_s13 (float, default: 1.0) – Weighting factor of the failure mode s13.\n\nwf_s23 (float, default: 1.0) – Weighting factor of the failure mode s23.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nMaxStressCriterion.to_dict()\n\n\n\nMaxStressCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nMaxStressCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nMaxStressCriterion.name\n\nName of the failure criterion.\n\nMaxStressCriterion.s1\n\nWhether to activate the failure evaluation regarding the stress in the material 1 direction.\n\nMaxStressCriterion.s12\n\nWhether to activate the failure evaluation regarding the in-plane shear stress s12.\n\nMaxStressCriterion.s13\n\nWhether to activate the failure evaluation regarding the interlaminar shear stress s13.\n\nMaxStressCriterion.s2\n\nWhether to activate the failure evaluation regarding the stress in the material 2 direction.\n\nMaxStressCriterion.s23\n\nWhether to activate the failure evaluation regarding the interlaminar shear stress s23.\n\nMaxStressCriterion.s3\n\nWhether to activate the failure evaluation regarding the stress in the material 3 direction (out-of-plane).\n\nMaxStressCriterion.wf_s1\n\nWeighting factor of the failure mode s1.\n\nMaxStressCriterion.wf_s12\n\nWeighting factor of the failure mode s12.\n\nMaxStressCriterion.wf_s13\n\nWeighting factor of the failure mode s13.\n\nMaxStressCriterion.wf_s2\n\nWeighting factor of the failure mode s2.\n\nMaxStressCriterion.wf_s23\n\nWeighting factor of the failure mode s23.\n\nMaxStressCriterion.wf_s3\n\nWeighting factor of the failure mode s3.\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1t", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1t.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s1t", - "title": "s1t > s1t > s1t", - "section": "s1t > s1t", - "text": "FailureModeEnum.s1t = 211\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.time", + "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.time.html#time", + "title": "time", + "section": "time", + "text": "time" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.reserve_factor", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.reserve_factor.html#reserve_factor", - "title": "reserve_factor", - "section": "reserve_factor", - "text": "Lowest reserve factor of each ply.\nThis attribute is equivalent to the safety factor.\nndarray[Any, dtype[float64]]\nreserve_factor\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.time", + "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.time.html#ansys.dpf.composites.composite_scope.CompositeScope.time", + "title": "time > time > time", + "section": "time > time", + "text": "CompositeScope.time: float | None = None\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.reserve_factor", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.reserve_factor.html#ansys.dpf.composites.sampling_point.SamplingPoint.reserve_factor", - "title": "reserve_factor > reserve_factor > reserve_factor", - "section": "reserve_factor > reserve_factor", - "text": "property SamplingPoint.reserve_factor: ndarray[Any, dtype[float64]]\n\nLowest reserve factor of each ply.\n\nThis attribute is equivalent to the safety factor.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.mapping", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.mapping.html#mapping", + "title": "mapping", + "section": "mapping", + "text": "mapping" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.tw", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.tw.html#tw", - "title": "tw", - "section": "tw", - "text": "tw" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.mapping", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.mapping.html#ansys.dpf.composites.data_sources.CompositeDefinitionFiles.mapping", + "title": "mapping > mapping > mapping", + "section": "mapping > mapping", + "text": "CompositeDefinitionFiles.mapping: str | PathLike[str] | None = None\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.tw", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.tw.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.tw", - "title": "tw > tw > tw", - "section": "tw > tw", - "text": "FailureModeEnum.tw = 400\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.islower", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.islower.html#islower", + "title": "islower", + "section": "islower", + "text": "Return True if the string is a lowercase string, False otherwise.\nA string is lowercase if all cased characters in the string are lowercase and\nthere is at least one cased character in the string.\nislower" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.offsets", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.offsets.html#offsets", - "title": "offsets", - "section": "offsets", - "text": "Z coordinates for each interface and ply.\nndarray[Any, dtype[float64]]\noffsets\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.islower", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.islower.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.islower", + "title": "islower > islower > islower", + "section": "islower > islower", + "text": "FailureMeasureEnum.islower(/)\n\nReturn True if the string is a lowercase string, False otherwise.\n\nA string is lowercase if all cased characters in the string are lowercase and\nthere is at least one cased character in the string.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.offsets", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.offsets.html#ansys.dpf.composites.sampling_point.SamplingPoint.offsets", - "title": "offsets > offsets > offsets", - "section": "offsets > offsets", - "text": "property SamplingPoint.offsets: ndarray[Any, dtype[float64]]\n\nZ coordinates for each interface and ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.html#analysisplyinfoprovider", + "title": "AnalysisPlyInfoProvider", + "section": "AnalysisPlyInfoProvider", + "text": "AnalysisPlyInfoProvider. Can be used to compute the layer indices of a given analysis ply.\nmesh (MeshedRegion) – DPF MeshedRegion with lay-up information.\nname (str) – Analysis Ply Name\nAnalysisPlyInfoProvider.get_layer_index_by_element_id(...)\nGet the layer index for the analysis ply in a given element.\nAnalysisPlyInfoProvider.ply_element_ids()\nReturn list of element labels of the analysis ply.\nAnalysisPlyInfoProvider\nMeshedRegion\nstr\nAnalysisPlyInfoProvider.get_layer_index_by_element_id\nAnalysisPlyInfoProvider.ply_element_ids" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxz", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxz.html#esxz", - "title": "eSxz", - "section": "eSxz", - "text": "Global strain limit in material direction 13.\nfloat\neSxz\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.html#ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider", + "title": "AnalysisPlyInfoProvider > AnalysisPlyInfoProvider > AnalysisPlyInfoProvider", + "section": "AnalysisPlyInfoProvider > AnalysisPlyInfoProvider", + "text": "class ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider(mesh, name)\n\nAnalysisPlyInfoProvider. Can be used to compute the layer indices of a given analysis ply.\n\nParameters\n\nmesh (MeshedRegion) – DPF MeshedRegion with lay-up information.\n\nname (str) – Analysis Ply Name\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nAnalysisPlyInfoProvider.get_layer_index_by_element_id(...)\n\nGet the layer index for the analysis ply in a given element.\n\nAnalysisPlyInfoProvider.ply_element_ids()\n\nReturn list of element labels of the analysis ply.\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxz", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxz.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxz", - "title": "eSxz > eSxz > eSxz", - "section": "eSxz > eSxz", - "text": "property MaxStrainCriterion.eSxz: float\n\nGlobal strain limit in material direction 13.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.vms", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.vms.html#vms", + "title": "vms", + "section": "vms", + "text": "Whether to activate the von Mises stress criterion.\nbool\nvms\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.html#samplingpointfigure", - "title": "SamplingPointFigure", - "section": "SamplingPointFigure", - "text": "Provides the sampling point figure and axes.\nSamplingPointFigure.figure\n\nSamplingPointFigure.axes\n\nSamplingPointFigure\nSamplingPointFigure.figure\nSamplingPointFigure.axes" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.vms", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.vms.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.vms", + "title": "vms > vms > vms", + "section": "vms > vms", + "text": "property VonMisesCriterion.vms: bool\n\nWhether to activate the von Mises stress criterion.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.html#ansys.dpf.composites.sampling_point.SamplingPointFigure", - "title": "SamplingPointFigure > SamplingPointFigure > SamplingPointFigure", - "section": "SamplingPointFigure > SamplingPointFigure", - "text": "class ansys.dpf.composites.sampling_point.SamplingPointFigure(figure, axes)\n\nProvides the sampling point figure and axes.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nSamplingPointFigure.figure\n\n\n\nSamplingPointFigure.axes\n\n\n\n" + "objectID": "api/select_indices", + "href": "api/select_indices.html#select-elementary-indices", + "title": "Select elementary indices", + "section": "Select elementary indices", + "text": "This module provides functions to filter elementary data.\nA layered element has the following number of elementary data points:\nIn the preceding definition, number_of_spots indicates the number of through-the-thickness\nintegration points per layer. number_of_spots is controlled by keyoption 8, which\nindicates how much output is written. For example, you might write output for only 'bottom'\nand 'top' or for 'bottom', 'top', and 'mid'.\nEach elementary data point can have multiple components. For example, it might have one component\nfor scalar data or six components for symmetrical 3x3 tensors. The elementary data of an element\nis available as a 2D vector with shape (num_elementary_data, number_of_components).\nHere are some examples:\nGet the stress output for a layered shell element (181, four nodes) with five layers and\nkeyoption 8 = 2. Write the output for 'bot', 'top', and 'mid'.\nnumber_of_layers = 5\nnumber_of_spots = 3 (bottom, top, and middle)\nnumber_of_nodes_per_spot_plane = 4 (equal to number of nodes)\nnumber_of_components = 6\nThus, num_elementary_data = number_of_layers * number_of_spots * number_of_nodes_per_spot_plane\n= 60.\nGet the stress output for a layered solid element (185, eight nodes) with seven layers and\nkeyoption 8 = 1. Write the output for 'bot' and 'top'.\nnumber_of_layers = 7\nnumber_of_spots = 2 (bottom and top)\nnumber_of_nodes_per_spot_plane = 4\nnumber_of_components = 6\nThus, num_elementary_data = number_of_layers * number_of_spots * number_of_nodes_per_spot_plane\n= 56.\nThe functions in this module compute an array of elementary indices for a given selection of\nlayers, nodes, spots, DPF material IDs, or analysis plies. These elementary indices can be used\nto index the first axis of the elementary data array. For usage information, see\nsphx_glr_examples_gallery_examples_006_filter_composite_data_example.py.\nget_selected_indices(element_info[, layers, ...])\nGet elementary indices based on element information, layers, nodes, and spots.\nget_selected_indices_by_analysis_ply(...)\nGet selected indices by analysis ply.\nget_selected_indices_by_dpf_material_ids(...)\nGet selected indices by DPF material IDs.\nSelect elementary indices\nnumber_of_spots\nnumber_of_spots\nkeyoption 8\n'bottom'\n'top'\n'bottom'\n'top'\n'mid'\n(num_elementary_data, number_of_components)\nkeyoption 8 = 2\n'bot'\n'top'\n'mid'\nnumber_of_layers\nnumber_of_spots\nnumber_of_nodes_per_spot_plane\nnumber_of_components\nnum_elementary_data = number_of_layers * number_of_spots * number_of_nodes_per_spot_plane\nkeyoption 8 = 1\n'bot'\n'top'\nnumber_of_layers\nnumber_of_spots\nnumber_of_nodes_per_spot_plane\nnumber_of_components\nnum_elementary_data = number_of_layers * number_of_spots * number_of_nodes_per_spot_plane\nget_selected_indices\nget_selected_indices_by_analysis_ply\nget_selected_indices_by_dpf_material_ids" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s1", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s1.html#s1", - "title": "s1", - "section": "s1", - "text": "Whether to activate the failure evaluation regarding the stress in the material 1 direction.\nbool\ns1\nbool" + "objectID": "api/layup_info", + "href": "api/layup_info.html#lay-up-information", + "title": "Lay-up information", + "section": "Lay-up information", + "text": "General features to access information on the composite lay-up.\nadd_layup_info_to_mesh(data_sources, ...[, ...])\nAdd lay-up information to the mesh.\nget_element_info_provider(mesh, ...[, ...])\nGet ElementInfoProvider Object.\nget_dpf_material_id_by_analyis_ply_map(mesh, ...)\nGet Dict that maps analysis ply names to dpf_material_ids.\nAnalysisPlyInfoProvider(mesh, name)\nAnalysisPlyInfoProvider.\nElementInfoProvider(mesh, layer_indices, ...)\nProvider for ElementInfo.\nElementInfo(id, n_layers, n_corner_nodes, ...)\nProvides lay-up information for an element.\nLayupPropertiesProvider(layup_provider, mesh)\nProvider for lay-up properties.\nLayerProperty(value[, names, module, ...])\nProvides the layer properties available.\nLayupProperty(value[, names, module, ...])\nEnum for lay-up properties.\nLayupModelContextType(value[, names, ...])\nType of the lay-up information.\nLay-up information\nadd_layup_info_to_mesh\nget_element_info_provider\nElementInfoProvider\nget_dpf_material_id_by_analyis_ply_map\nAnalysisPlyInfoProvider\nElementInfoProvider\nElementInfo\nElementInfo\nLayupPropertiesProvider\nLayerProperty\nLayupProperty\nLayupModelContextType" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s1", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s1.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.s1", - "title": "s1 > s1 > s1", - "section": "s1 > s1", - "text": "property MaxStressCriterion.s1: bool\n\nWhether to activate the failure evaluation regarding the stress in the material 1 direction.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/layup_info", + "href": "api/layup_info.html#material-properties", + "title": "Lay-up information > Material properties", + "section": "Material properties", + "text": "A note on material ids: in the PyDPF - Composites module,\nmaterials are reference by their dpf_material_id. The dpf_material_id\nis generated based on the materials present in the result file.\nThe dpf_material_id can be different from the material id used in the solver.\nElementInfo contains the dpf_material_id for the materials\nof a given element. The dpf_material_id for a given analysis ply can be obtained\nby calling get_dpf_material_id_by_analyis_ply_map(). A lookup by\nmaterial name is currently not available.\nThe sphx_glr_examples_gallery_examples_004_get_material_properties_example.py\nexample shows how to evaluate material properties.\nget_constant_property(material_property, ...)\nGet a constant material property.\nget_all_dpf_material_ids(mesh, ...)\nGet all DPF material IDs.\nget_constant_property_dict(...)\nGet a dictionary with constant properties.\nMaterialProperty(value[, names, module, ...])\nProvides the material properties that are available.\nMaterialMetadata([dpf_material_id, ...])\nMaterial metadata such as name and ply type.\nMaterial properties\ndpf_material_id\ndpf_material_id\ndpf_material_id\nElementInfo\ndpf_material_id\ndpf_material_id\nget_dpf_material_id_by_analyis_ply_map()\nget_constant_property\nget_all_dpf_material_ids\nget_constant_property_dict\nMaterialProperty\nMaterialMetadata" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR11", - "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR11.html#tensor11", - "title": "TENSOR11", - "section": "TENSOR11", - "text": "TENSOR11" + "objectID": "api/layup_info", + "href": "api/layup_info.html#material-operators", + "title": "Lay-up information > Material operators", + "section": "Material operators", + "text": "MaterialOperators(material_provider, ...)\nProvides the container for material-related operators.\nget_material_operators(rst_data_source, ...)\nGet material properties related to operators.\nMaterial operators\nMaterialOperators\nget_material_operators" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR11", - "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR11.html#ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR11", - "title": "TENSOR11 > TENSOR11 > TENSOR11", - "section": "TENSOR11 > TENSOR11", - "text": "Sym3x3TensorComponent.TENSOR11 = 0\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_names", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_names.html#material_names", + "title": "material_names", + "section": "material_names", + "text": "Material name to DPF material ID map.\nThis property can be used to filter analysis plies\nor element layers by material name.\ndict[str, int]\nmaterial_names\ndict\nstr\nint" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.to_json.html#to_json", - "title": "to_json", - "section": "to_json", - "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_names", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_names.html#ansys.dpf.composites.composite_model.CompositeModel.material_names", + "title": "material_names > material_names > material_names", + "section": "material_names > material_names", + "text": "property CompositeModel.material_names: dict[str, int]\n\nMaterial name to DPF material ID map.\n\nThis property can be used to filter analysis plies\nor element layers by material name.\n\nReturn type\n\ndict[str, int]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.to_json.html#ansys.dpf.composites.failure_criteria.PuckCriterion.to_json", - "title": "to_json > to_json > to_json", - "section": "to_json > to_json", - "text": "PuckCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1.html#s1", + "title": "s1", + "section": "s1", + "text": "s1" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.af", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.af.html#af", - "title": "af", - "section": "af", - "text": "af" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s1", + "title": "s1 > s1 > s1", + "section": "s1 > s1", + "text": "FailureModeEnum.s1 = 210\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.af", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.af.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.af", - "title": "af > af > af", - "section": "af > af", - "text": "FailureModeEnum.af = 1203\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_element_laminate_offset", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_element_laminate_offset.html#get_element_laminate_offset", + "title": "get_element_laminate_offset", + "section": "get_element_laminate_offset", + "text": "Get laminate offset of element. Returns None if element is not layered.\nelement_id (int) – Element Id/Label\nOptional[float64]\nget_element_laminate_offset\nint\nOptional\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmc.html#wf_lmc", - "title": "wf_lmc", - "section": "wf_lmc", - "text": "Weighting factor of matrix failure due to compression (lmc).\nfloat\nwf_lmc\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_element_laminate_offset", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_element_laminate_offset.html#ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_element_laminate_offset", + "title": "get_element_laminate_offset > get_element_laminate_offset > get_element_laminate_offset", + "section": "get_element_laminate_offset > get_element_laminate_offset", + "text": "LayupPropertiesProvider.get_element_laminate_offset(element_id)\n\nGet laminate offset of element. Returns None if element is not layered.\n\nParameters\n\nelement_id (int) – Element Id/Label\n\nReturn type\n\nOptional[float64]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmc.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmc", - "title": "wf_lmc > wf_lmc > wf_lmc", - "section": "wf_lmc > wf_lmc", - "text": "property LaRCCriterion.wf_lmc: float\n\nWeighting factor of matrix failure due to compression (lmc).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hm", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hm.html#wf_hm", + "title": "wf_hm", + "section": "wf_hm", + "text": "Whether to activate the failure evaluation regarding matrix failure.\nfloat\nwf_hm\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isnumeric", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isnumeric.html#isnumeric", - "title": "isnumeric", - "section": "isnumeric", - "text": "Return True if the string is a numeric string, False otherwise.\nA string is numeric if all characters in the string are numeric and there is at\nleast one character in the string.\nisnumeric" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hm", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hm.html#ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hm", + "title": "wf_hm > wf_hm > wf_hm", + "section": "wf_hm > wf_hm", + "text": "property HashinCriterion.wf_hm: float\n\nWhether to activate the failure evaluation regarding matrix failure.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isnumeric", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isnumeric.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isnumeric", - "title": "isnumeric > isnumeric > isnumeric", - "section": "isnumeric > isnumeric", - "text": "FailureMeasureEnum.isnumeric(/)\n\nReturn True if the string is a numeric string, False otherwise.\n\nA string is numeric if all characters in the string are numeric and there is at\nleast one character in the string.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_dict.html#to_dict", + "title": "to_dict", + "section": "to_dict", + "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_a", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_a.html#thermal_expansion_coefficients_a", - "title": "Thermal_Expansion_Coefficients_a", - "section": "Thermal_Expansion_Coefficients_a", - "text": "Thermal_Expansion_Coefficients_a" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_dict", + "title": "to_dict > to_dict > to_dict", + "section": "to_dict > to_dict", + "text": "VonMisesCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_a", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_a.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_a", - "title": "Thermal_Expansion_Coefficients_a > Thermal_Expansion_Coefficients_a > Thermal_Expansion_Coefficients_a", - "section": "Thermal_Expansion_Coefficients_a > Thermal_Expansion_Coefficients_a", - "text": "MaterialProperty.Thermal_Expansion_Coefficients_a: str = 'coefficient_thermal_expansion'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.html#failuremeasureenum", + "title": "FailureMeasureEnum", + "section": "FailureMeasureEnum", + "text": "Provides available failure measures.\nFailureMeasureEnum.encode(/[, encoding, errors])\nEncode the string using the codec registered for encoding.\nFailureMeasureEnum.replace(old, new, /[, count])\nReturn a copy with all occurrences of substring old replaced by new.\nFailureMeasureEnum.split(/[, sep, maxsplit])\nReturn a list of the substrings in the string, using sep as the separator string.\nFailureMeasureEnum.rsplit(/[, sep, maxsplit])\nReturn a list of the substrings in the string, using sep as the separator string.\nFailureMeasureEnum.join(iterable, /)\nConcatenate any number of strings.\nFailureMeasureEnum.capitalize(/)\nReturn a capitalized version of the string.\nFailureMeasureEnum.casefold(/)\nReturn a version of the string suitable for caseless comparisons.\nFailureMeasureEnum.title(/)\nReturn a version of the string where each word is titlecased.\nFailureMeasureEnum.center(width[, fillchar])\nReturn a centered string of length width.\nFailureMeasureEnum.count(sub[, start[, end]], /)\nReturn the number of non-overlapping occurrences of substring sub in string S[start:end].\nFailureMeasureEnum.expandtabs(/[, tabsize])\nReturn a copy where all tab characters are expanded using spaces.\nFailureMeasureEnum.find(sub[, start[, end]], /)\nReturn the lowest index in S where substring sub is found, such that sub is contained within S[start:end].\nFailureMeasureEnum.partition(sep, /)\nPartition the string into three parts using the given separator.\nFailureMeasureEnum.index(sub[, start[, end]], /)\nReturn the lowest index in S where substring sub is found, such that sub is contained within S[start:end].\nFailureMeasureEnum.ljust(width[, fillchar])\nReturn a left-justified string of length width.\nFailureMeasureEnum.lower(/)\nReturn a copy of the string converted to lowercase.\nFailureMeasureEnum.lstrip([chars])\nReturn a copy of the string with leading whitespace removed.\nFailureMeasureEnum.rfind(sub[, start[, end]], /)\nReturn the highest index in S where substring sub is found, such that sub is contained within S[start:end].\nFailureMeasureEnum.rindex(sub[, start[, end]], /)\nReturn the highest index in S where substring sub is found, such that sub is contained within S[start:end].\nFailureMeasureEnum.rjust(width[, fillchar])\nReturn a right-justified string of length width.\nFailureMeasureEnum.rstrip([chars])\nReturn a copy of the string with trailing whitespace removed.\nFailureMeasureEnum.rpartition(sep, /)\nPartition the string into three parts using the given separator.\nFailureMeasureEnum.splitlines(/[, keepends])\nReturn a list of the lines in the string, breaking at line boundaries.\nFailureMeasureEnum.strip([chars])\nReturn a copy of the string with leading and trailing whitespace removed.\nFailureMeasureEnum.swapcase(/)\nConvert uppercase characters to lowercase and lowercase characters to uppercase.\nFailureMeasureEnum.translate(table, /)\nReplace each character in the string using the given translation table.\nFailureMeasureEnum.upper(/)\nReturn a copy of the string converted to uppercase.\nFailureMeasureEnum.startswith(prefix[, ...)\nReturn True if the string starts with the specified prefix, False otherwise.\nFailureMeasureEnum.endswith(suffix[, start[, ...)\nReturn True if the string ends with the specified suffix, False otherwise.\nFailureMeasureEnum.removeprefix(prefix, /)\nReturn a str with the given prefix string removed if present.\nFailureMeasureEnum.removesuffix(suffix, /)\nReturn a str with the given suffix string removed if present.\nFailureMeasureEnum.isascii(/)\nReturn True if all characters in the string are ASCII, False otherwise.\nFailureMeasureEnum.islower(/)\nReturn True if the string is a lowercase string, False otherwise.\nFailureMeasureEnum.isupper(/)\nReturn True if the string is an uppercase string, False otherwise.\nFailureMeasureEnum.istitle(/)\nReturn True if the string is a title-cased string, False otherwise.\nFailureMeasureEnum.isspace(/)\nReturn True if the string is a whitespace string, False otherwise.\nFailureMeasureEnum.isdecimal(/)\nReturn True if the string is a decimal string, False otherwise.\nFailureMeasureEnum.isdigit(/)\nReturn True if the string is a digit string, False otherwise.\nFailureMeasureEnum.isnumeric(/)\nReturn True if the string is a numeric string, False otherwise.\nFailureMeasureEnum.isalpha(/)\nReturn True if the string is an alphabetic string, False otherwise.\nFailureMeasureEnum.isalnum(/)\nReturn True if the string is an alpha-numeric string, False otherwise.\nFailureMeasureEnum.isidentifier(/)\nReturn True if the string is a valid Python identifier, False otherwise.\nFailureMeasureEnum.isprintable(/)\nReturn True if the string is printable, False otherwise.\nFailureMeasureEnum.zfill(width, /)\nPad a numeric string with zeros on the left, to fill a field of the given width.\nFailureMeasureEnum.format(*args, **kwargs)\nReturn a formatted version of the string, using substitutions from args and kwargs.\nFailureMeasureEnum.format_map(mapping, /)\nReturn a formatted version of the string, using substitutions from mapping.\nFailureMeasureEnum.maketrans(x[, y, z])\nReturn a translation table usable for str.translate().\nFailureMeasureEnum.INVERSE_RESERVE_FACTOR\n\nFailureMeasureEnum.MARGIN_OF_SAFETY\n\nFailureMeasureEnum.RESERVE_FACTOR\n\nFailureMeasureEnum\nFailureMeasureEnum.encode\nFailureMeasureEnum.replace\nFailureMeasureEnum.split\nFailureMeasureEnum.rsplit\nFailureMeasureEnum.join\nFailureMeasureEnum.capitalize\nFailureMeasureEnum.casefold\nFailureMeasureEnum.title\nFailureMeasureEnum.center\nFailureMeasureEnum.count\nFailureMeasureEnum.expandtabs\nFailureMeasureEnum.find\nFailureMeasureEnum.partition\nFailureMeasureEnum.index\nFailureMeasureEnum.ljust\nFailureMeasureEnum.lower\nFailureMeasureEnum.lstrip\nFailureMeasureEnum.rfind\nFailureMeasureEnum.rindex\nFailureMeasureEnum.rjust\nFailureMeasureEnum.rstrip\nFailureMeasureEnum.rpartition\nFailureMeasureEnum.splitlines\nFailureMeasureEnum.strip\nFailureMeasureEnum.swapcase\nFailureMeasureEnum.translate\nFailureMeasureEnum.upper\nFailureMeasureEnum.startswith\nFailureMeasureEnum.endswith\nFailureMeasureEnum.removeprefix\nFailureMeasureEnum.removesuffix\nFailureMeasureEnum.isascii\nFailureMeasureEnum.islower\nFailureMeasureEnum.isupper\nFailureMeasureEnum.istitle\nFailureMeasureEnum.isspace\nFailureMeasureEnum.isdecimal\nFailureMeasureEnum.isdigit\nFailureMeasureEnum.isnumeric\nFailureMeasureEnum.isalpha\nFailureMeasureEnum.isalnum\nFailureMeasureEnum.isidentifier\nFailureMeasureEnum.isprintable\nFailureMeasureEnum.zfill\nFailureMeasureEnum.format\nFailureMeasureEnum.format_map\nFailureMeasureEnum.maketrans\nFailureMeasureEnum.INVERSE_RESERVE_FACTOR\nFailureMeasureEnum.MARGIN_OF_SAFETY\nFailureMeasureEnum.RESERVE_FACTOR" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e2", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e2.html#e2", - "title": "e2", - "section": "e2", - "text": "Activates the failure evaluation regarding the strain in the material 2 direction.\nbool\ne2\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.html#ansys.dpf.composites.result_definition.FailureMeasureEnum", + "title": "FailureMeasureEnum > FailureMeasureEnum > FailureMeasureEnum", + "section": "FailureMeasureEnum > FailureMeasureEnum", + "text": "class ansys.dpf.composites.result_definition.FailureMeasureEnum(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nProvides available failure measures.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nFailureMeasureEnum.encode(/[, encoding, errors])\n\nEncode the string using the codec registered for encoding.\n\nFailureMeasureEnum.replace(old, new, /[, count])\n\nReturn a copy with all occurrences of substring old replaced by new.\n\nFailureMeasureEnum.split(/[, sep, maxsplit])\n\nReturn a list of the substrings in the string, using sep as the separator string.\n\nFailureMeasureEnum.rsplit(/[, sep, maxsplit])\n\nReturn a list of the substrings in the string, using sep as the separator string.\n\nFailureMeasureEnum.join(iterable, /)\n\nConcatenate any number of strings.\n\nFailureMeasureEnum.capitalize(/)\n\nReturn a capitalized version of the string.\n\nFailureMeasureEnum.casefold(/)\n\nReturn a version of the string suitable for caseless comparisons.\n\nFailureMeasureEnum.title(/)\n\nReturn a version of the string where each word is titlecased.\n\nFailureMeasureEnum.center(width[, fillchar])\n\nReturn a centered string of length width.\n\nFailureMeasureEnum.count(sub[, start[, end]], /)\n\nReturn the number of non-overlapping occurrences of substring sub in string S[start:end].\n\nFailureMeasureEnum.expandtabs(/[, tabsize])\n\nReturn a copy where all tab characters are expanded using spaces.\n\nFailureMeasureEnum.find(sub[, start[, end]], /)\n\nReturn the lowest index in S where substring sub is found, such that sub is contained within S[start:end].\n\nFailureMeasureEnum.partition(sep, /)\n\nPartition the string into three parts using the given separator.\n\nFailureMeasureEnum.index(sub[, start[, end]], /)\n\nReturn the lowest index in S where substring sub is found, such that sub is contained within S[start:end].\n\nFailureMeasureEnum.ljust(width[, fillchar])\n\nReturn a left-justified string of length width.\n\nFailureMeasureEnum.lower(/)\n\nReturn a copy of the string converted to lowercase.\n\nFailureMeasureEnum.lstrip([chars])\n\nReturn a copy of the string with leading whitespace removed.\n\nFailureMeasureEnum.rfind(sub[, start[, end]], /)\n\nReturn the highest index in S where substring sub is found, such that sub is contained within S[start:end].\n\nFailureMeasureEnum.rindex(sub[, start[, end]], /)\n\nReturn the highest index in S where substring sub is found, such that sub is contained within S[start:end].\n\nFailureMeasureEnum.rjust(width[, fillchar])\n\nReturn a right-justified string of length width.\n\nFailureMeasureEnum.rstrip([chars])\n\nReturn a copy of the string with trailing whitespace removed.\n\nFailureMeasureEnum.rpartition(sep, /)\n\nPartition the string into three parts using the given separator.\n\nFailureMeasureEnum.splitlines(/[, keepends])\n\nReturn a list of the lines in the string, breaking at line boundaries.\n\nFailureMeasureEnum.strip([chars])\n\nReturn a copy of the string with leading and trailing whitespace removed.\n\nFailureMeasureEnum.swapcase(/)\n\nConvert uppercase characters to lowercase and lowercase characters to uppercase.\n\nFailureMeasureEnum.translate(table, /)\n\nReplace each character in the string using the given translation table.\n\nFailureMeasureEnum.upper(/)\n\nReturn a copy of the string converted to uppercase.\n\nFailureMeasureEnum.startswith(prefix[, ...)\n\nReturn True if the string starts with the specified prefix, False otherwise.\n\nFailureMeasureEnum.endswith(suffix[, start[, ...)\n\nReturn True if the string ends with the specified suffix, False otherwise.\n\nFailureMeasureEnum.removeprefix(prefix, /)\n\nReturn a str with the given prefix string removed if present.\n\nFailureMeasureEnum.removesuffix(suffix, /)\n\nReturn a str with the given suffix string removed if present.\n\nFailureMeasureEnum.isascii(/)\n\nReturn True if all characters in the string are ASCII, False otherwise.\n\nFailureMeasureEnum.islower(/)\n\nReturn True if the string is a lowercase string, False otherwise.\n\nFailureMeasureEnum.isupper(/)\n\nReturn True if the string is an uppercase string, False otherwise.\n\nFailureMeasureEnum.istitle(/)\n\nReturn True if the string is a title-cased string, False otherwise.\n\nFailureMeasureEnum.isspace(/)\n\nReturn True if the string is a whitespace string, False otherwise.\n\nFailureMeasureEnum.isdecimal(/)\n\nReturn True if the string is a decimal string, False otherwise.\n\nFailureMeasureEnum.isdigit(/)\n\nReturn True if the string is a digit string, False otherwise.\n\nFailureMeasureEnum.isnumeric(/)\n\nReturn True if the string is a numeric string, False otherwise.\n\nFailureMeasureEnum.isalpha(/)\n\nReturn True if the string is an alphabetic string, False otherwise.\n\nFailureMeasureEnum.isalnum(/)\n\nReturn True if the string is an alpha-numeric string, False otherwise.\n\nFailureMeasureEnum.isidentifier(/)\n\nReturn True if the string is a valid Python identifier, False otherwise.\n\nFailureMeasureEnum.isprintable(/)\n\nReturn True if the string is printable, False otherwise.\n\nFailureMeasureEnum.zfill(width, /)\n\nPad a numeric string with zeros on the left, to fill a field of the given width.\n\nFailureMeasureEnum.format(*args, **kwargs)\n\nReturn a formatted version of the string, using substitutions from args and kwargs.\n\nFailureMeasureEnum.format_map(mapping, /)\n\nReturn a formatted version of the string, using substitutions from mapping.\n\nFailureMeasureEnum.maketrans(x[, y, z])\n\nReturn a translation table usable for str.translate().\n\n\n\nAttributes\n\n\n\n\n\n\n\nFailureMeasureEnum.INVERSE_RESERVE_FACTOR\n\n\n\nFailureMeasureEnum.MARGIN_OF_SAFETY\n\n\n\nFailureMeasureEnum.RESERVE_FACTOR\n\n\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e2", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e2.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e2", - "title": "e2 > e2 > e2", - "section": "e2 > e2", - "text": "property MaxStrainCriterion.e2: bool\n\nActivates the failure evaluation regarding the strain in the material 2 direction.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.wf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.wf.html#wf", + "title": "wf", + "section": "wf", + "text": "Weighting factor of this failure criterion.\nfloat\nwf\nfloat" }, { - "objectID": "examples/gallery_examples/002_sampling_point_example", - "href": "examples/gallery_examples/002_sampling_point_example.html#sampling-point", - "title": "Sampling point", - "section": "Sampling point", - "text": "This example extracts ply-wise laminate properties and results.\nThe Sampling Point class is used to extract\nthrough-the-thickness data of the laminate, such as ply-wise properties,\nstrains and stresses. It then implements basic visualization to plot\nthe laminate.\nThis example uses the Composite Model to scope a\nSampling Point to a certain element and to visualize the laminate.\nWhen using a Workbench project,\nuse the get_composite_files_from_workbench_result_folder()\nmethod to obtain the input files.\nSampling point\nSampling Point\nComposite Model\nget_composite_files_from_workbench_result_folder()" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.wf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.wf.html#ansys.dpf.composites.failure_criteria.HoffmanCriterion.wf", + "title": "wf > wf > wf", + "section": "wf > wf", + "text": "property HoffmanCriterion.wf: float\n\nWeighting factor of this failure criterion.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/002_sampling_point_example", - "href": "examples/gallery_examples/002_sampling_point_example.html#set-up-analysis", - "title": "Sampling point > Set up analysis", - "section": "Set up analysis", - "text": "Setting up the analysis consists of loading Ansys libraries, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries.\nStart a DPF server and copy the example files into the current working directory.\nConfigure the combined failure criterion\nSet up analysis" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmC", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmC.html#cmc", + "title": "cmC", + "section": "cmC", + "text": "cmC" }, { - "objectID": "examples/gallery_examples/002_sampling_point_example", - "href": "examples/gallery_examples/002_sampling_point_example.html#set-up-model-and-create-sampling-point", - "title": "Sampling point > Set up model and create sampling point", - "section": "Set up model and create sampling point", - "text": "Set up the composite model.\nCreate a sampling point\nSet up model and create sampling point" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmC", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmC.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.cmC", + "title": "cmC > cmC > cmC", + "section": "cmC > cmC", + "text": "FailureModeEnum.cmC = 1005\n\n" }, { - "objectID": "examples/gallery_examples/002_sampling_point_example", - "href": "examples/gallery_examples/002_sampling_point_example.html#plot-results", - "title": "Sampling point > Plot results", - "section": "Plot results", - "text": "Plot results uing preconfigured plots. For more information, see the\nSamplingPoint.get_result_plots() method.\nPlot polar properties.\nGenerate custom plots. You can customize existing plots or build\nthem from scratch using a package like Matplot or Plotly. This code\nuses Matplotlib to generate a custom plot of results s13 and s23.\nThis code uses Matplotlib to generate a custom plot of results e12 and e2.\nThis code plots the lay-up only.\nPlot results\nSamplingPoint.get_result_plots()\ns13\ns23\ne12\ne2" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.vMs", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.vMs.html#vms", + "title": "vMs", + "section": "vMs", + "text": "vMs" }, { - "objectID": "examples/gallery_examples/002_sampling_point_example", - "href": "examples/gallery_examples/002_sampling_point_example.html#sample-another-element", - "title": "Sampling point > Sample another element", - "section": "Sample another element", - "text": "You can change the element ID of the sampling point to generate another plot.\nTotal running time of the script: (0 minutes 4.837 seconds)\nDownload Jupyter notebook: 002_sampling_point_example.ipynb\nDownload Python source code: 002_sampling_point_example.py\nDownload zipped: 002_sampling_point_example.zip\nGallery generated by Sphinx-Gallery\nSample another element\nDownload Jupyter notebook: 002_sampling_point_example.ipynb\nDownload Python source code: 002_sampling_point_example.py\nDownload zipped: 002_sampling_point_example.zip" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.vMs", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.vMs.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.vMs", + "title": "vMs > vMs > vMs", + "section": "vMs > vMs", + "text": "FailureModeEnum.vMs = 1102\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s23", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s23.html#wf_s23", - "title": "wf_s23", - "section": "wf_s23", - "text": "Weighting factor of the failure mode s23.\nfloat\nwf_s23\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_layers", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_layers.html#n_layers", + "title": "n_layers", + "section": "n_layers", + "text": "n_layers" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s23", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s23.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s23", - "title": "wf_s23 > wf_s23 > wf_s23", - "section": "wf_s23 > wf_s23", - "text": "property MaxStressCriterion.wf_s23: float\n\nWeighting factor of the failure mode s23.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_layers", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_layers.html#ansys.dpf.composites.layup_info.ElementInfo.n_layers", + "title": "n_layers > n_layers > n_layers", + "section": "n_layers > n_layers", + "text": "ElementInfo.n_layers: int\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.dim", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.dim.html#dim", - "title": "dim", - "section": "dim", - "text": "Specifies which formulation of the failure criterion is used.\nint\ndim\nint" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_sampling_point", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_sampling_point.html#get_sampling_point", + "title": "get_sampling_point", + "section": "get_sampling_point", + "text": "Get a sampling point for an element ID and failure criteria.\ncombined_criterion (CombinedFailureCriterion) – Combined failure criterion to evaluate.\nelement_id (int) – Element ID or label of the sampling point.\ntime (Optional[float], default: None) – Time or frequency at which to evaluate the sampling point. If None,\nthe last time or frequency in the result file is used.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nSamplingPoint\nget_sampling_point\nCombinedFailureCriterion\nint\nOptional\nfloat\nNone\nNone\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nSamplingPoint" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.dim", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.dim.html#ansys.dpf.composites.failure_criteria.HoffmanCriterion.dim", - "title": "dim > dim > dim", - "section": "dim > dim", - "text": "property HoffmanCriterion.dim: int\n\nSpecifies which formulation of the failure criterion is used.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_sampling_point", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_sampling_point.html#ansys.dpf.composites.composite_model.CompositeModel.get_sampling_point", + "title": "get_sampling_point > get_sampling_point > get_sampling_point", + "section": "get_sampling_point > get_sampling_point", + "text": "CompositeModel.get_sampling_point(combined_criterion, element_id, time=None, composite_definition_label=None)\n\nGet a sampling point for an element ID and failure criteria.\n\nParameters\n\ncombined_criterion (CombinedFailureCriterion) – Combined failure criterion to evaluate.\n\nelement_id (int) – Element ID or label of the sampling point.\n\ntime (Optional[float], default: None) – Time or frequency at which to evaluate the sampling point. If None,\nthe last time or frequency in the result file is used.\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\n\nReturn type\n\nSamplingPoint\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K2", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K2.html#thermal_conductivity_k2", - "title": "Thermal_Conductivity_K2", - "section": "Thermal_Conductivity_K2", - "text": "Thermal_Conductivity_K2" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.named_selections", + "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.named_selections.html#named_selections", + "title": "named_selections", + "section": "named_selections", + "text": "named_selections" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K2", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K2.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K2", - "title": "Thermal_Conductivity_K2 > Thermal_Conductivity_K2 > Thermal_Conductivity_K2", - "section": "Thermal_Conductivity_K2 > Thermal_Conductivity_K2", - "text": "MaterialProperty.Thermal_Conductivity_K2: str = 'thermal_conductivity_y_direction'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.named_selections", + "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.named_selections.html#ansys.dpf.composites.composite_scope.CompositeScope.named_selections", + "title": "named_selections > named_selections > named_selections", + "section": "named_selections > named_selections", + "text": "CompositeScope.named_selections: Sequence[str] | None = None\n\n" }, { - "objectID": "examples/gallery_examples/008_assembly_example", - "href": "examples/gallery_examples/008_assembly_example.html#postprocess-an-assembly", - "title": "Postprocess an assembly", - "section": "Postprocess an assembly", - "text": "This example shows how to postprocess an assembly with multiple composite parts.\nThe assembly consists of a shell and solid composite model. The\nComposite Model class is used to access\nthe data of the different parts.\nWhen using a Workbench project,\nuse the composite_files_from_workbench_harmonic_analysis()\nmethod to obtain the input files.\nPostprocess an assembly\nComposite Model\ncomposite_files_from_workbench_harmonic_analysis()" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.format", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.format.html#format", + "title": "format", + "section": "format", + "text": "Return a formatted version of the string, using substitutions from args and kwargs.\nThe substitutions are identified by braces (‘{’ and ‘}’).\nformat" }, { - "objectID": "examples/gallery_examples/008_assembly_example", - "href": "examples/gallery_examples/008_assembly_example.html#set-up-analysis", - "title": "Postprocess an assembly > Set up analysis", - "section": "Set up analysis", - "text": "Setting up the analysis consists of loading Ansys libraries, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries.\nStart a DPF server and copy the example files into the current working directory.\nSet up analysis" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.format", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.format.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.format", + "title": "format > format > format", + "section": "format > format", + "text": "FailureMeasureEnum.format(*args, **kwargs)\n\nReturn a formatted version of the string, using substitutions from args and kwargs.\nThe substitutions are identified by braces (‘{’ and ‘}’).\n\n!! processed by numpydoc !!" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1t", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1t.html#s1t", + "title": "s1t", + "section": "s1t", + "text": "s1t" }, { - "objectID": "examples/gallery_examples/008_assembly_example", - "href": "examples/gallery_examples/008_assembly_example.html#configure-combined-failure-criterion", - "title": "Postprocess an assembly > Configure combined failure criterion", - "section": "Configure combined failure criterion", - "text": "Configure the combined failure crition.\nConfigure combined failure criterion" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1t", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1t.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s1t", + "title": "s1t > s1t > s1t", + "section": "s1t > s1t", + "text": "FailureModeEnum.s1t = 211\n\n" }, { - "objectID": "examples/gallery_examples/008_assembly_example", - "href": "examples/gallery_examples/008_assembly_example.html#set-up-model", - "title": "Postprocess an assembly > Set up model", - "section": "Set up model", - "text": "Set up the composite model.\nSet up model" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc4", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc4.html#lfc4", + "title": "lfc4", + "section": "lfc4", + "text": "lfc4" }, { - "objectID": "examples/gallery_examples/008_assembly_example", - "href": "examples/gallery_examples/008_assembly_example.html#plot-irf", - "title": "Postprocess an assembly > Plot IRF", - "section": "Plot IRF", - "text": "Plot the maximum IRF per (solid) element.\nPlot IRF" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc4", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc4.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc4", + "title": "lfc4 > lfc4 > lfc4", + "section": "lfc4 > lfc4", + "text": "FailureModeEnum.lfc4 = 902\n\n" }, { - "objectID": "examples/gallery_examples/008_assembly_example", - "href": "examples/gallery_examples/008_assembly_example.html#plot-irf-on-the-reference-surface", - "title": "Postprocess an assembly > Plot IRF on the reference surface", - "section": "Plot IRF on the reference surface", - "text": "Plot the maximum IRF on the reference surface\nPlot IRF on the reference surface" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_pos", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_pos.html#puck_constants_p_22_pos", + "title": "Puck_Constants_p_22_pos", + "section": "Puck_Constants_p_22_pos", + "text": "Puck_Constants_p_22_pos" }, { - "objectID": "examples/gallery_examples/008_assembly_example", - "href": "examples/gallery_examples/008_assembly_example.html#get-element-information", - "title": "Postprocess an assembly > Get element information", - "section": "Get element information", - "text": "In the assembly, two composite definitions exist: one with a “shell” label\nand one with a “solid” label. For DPF Server versions earlier than 7.0,\nthe lay-up properties must be queried with the correct composite definition label. The code\nfollowing gets element information for all layered elements.\nFor DPF Server versions 7.0 and later, element information can be retrieved directly.\nTotal running time of the script: (0 minutes 4.157 seconds)\nDownload Jupyter notebook: 008_assembly_example.ipynb\nDownload Python source code: 008_assembly_example.py\nDownload zipped: 008_assembly_example.zip\nGallery generated by Sphinx-Gallery\nGet element information\nDownload Jupyter notebook: 008_assembly_example.ipynb\nDownload Python source code: 008_assembly_example.py\nDownload zipped: 008_assembly_example.zip" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_pos", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_pos.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_pos", + "title": "Puck_Constants_p_22_pos > Puck_Constants_p_22_pos > Puck_Constants_p_22_pos", + "section": "Puck_Constants_p_22_pos > Puck_Constants_p_22_pos", + "text": "MaterialProperty.Puck_Constants_p_22_pos: str = 'tensile_inclination_yz_puck_constants'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.plies", - "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.plies.html#plies", - "title": "plies", - "section": "plies", - "text": "plies" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSyz", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSyz.html#strain_limits_esyz", + "title": "Strain_Limits_eSyz", + "section": "Strain_Limits_eSyz", + "text": "Strain_Limits_eSyz" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.plies", - "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.plies.html#ansys.dpf.composites.composite_scope.CompositeScope.plies", - "title": "plies > plies > plies", - "section": "plies > plies", - "text": "CompositeScope.plies: Sequence[str] | None = None\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSyz", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSyz.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSyz", + "title": "Strain_Limits_eSyz > Strain_Limits_eSyz > Strain_Limits_eSyz", + "section": "Strain_Limits_eSyz > Strain_Limits_eSyz", + "text": "MaterialProperty.Strain_Limits_eSyz: str = 'strain_shear_yz'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.name.html#name", + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.name.html#name", "title": "name", "section": "name", "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.name.html#ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.name", + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.name.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.name", "title": "name > name > name", "section": "name > name", - "text": "property FaceSheetWrinklingCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "text": "property MaxStressCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.active.html#active", - "title": "active", - "section": "active", - "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" + "objectID": "examples/gallery_examples/011_rst_workflow", + "href": "examples/gallery_examples/011_rst_workflow.html#failure-analysis-of-an-mapdl-rst-model", + "title": "Failure analysis of an MAPDL (RST) model", + "section": "Failure analysis of an MAPDL (RST) model", + "text": "This example shows the postprocessing of an MAPDL (RST) model with layered elements that was not\npreprocessed by ACP. The difference between the RST-only and ACP-based workflow is that\nthe section data are loaded from the RST file instead of the ACP layup file.\nThis happens automatically if the parameter composite of the\nContinuousFiberCompositesFiles class is not set.\nThe engineering data file (XML or ENGD) with the material properties is needed anyway.\nOtherwise, the material properties cannot be mapped.\nAt the end of this example, two workflows are shown on how to create\nthe engineering data file based on a MAPDL model and how to set the\nmaterial UUIDs in MAPDL.\nThe material UUIDs in the engineering data file must be identical\nto the UUIDs in Mechanical APDL (RST file).\nThe postprocessing of MAPDL models is supported in 2024 R2 (DPF Server version 8.0)\nand later. A few advanced features are not supported with the RST only workflow.\nFor more information, see limitations.\nWhen using a Workbench project,\nuse the composite_files_from_workbench_harmonic_analysis()\nmethod to obtain the input files.\nFailure analysis of an MAPDL (RST) model\nContinuousFiberCompositesFiles\ncomposite_files_from_workbench_harmonic_analysis()" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.active.html#ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.active", - "title": "active > active > active", - "section": "active > active", - "text": "property ShearCrimpingCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/011_rst_workflow", + "href": "examples/gallery_examples/011_rst_workflow.html#set-up-analysis", + "title": "Failure analysis of an MAPDL (RST) model > Set up analysis", + "section": "Set up analysis", + "text": "Setting up the analysis consists of loading Ansys libraries, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries.\nStart a DPF server and copy the example files into the current working directory.\nGet input files (RST and material.engd but skip the ACP layup file).\nSet up analysis" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e2", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e2.html#e2", - "title": "e2", - "section": "e2", - "text": "Strains in the material 2 direction of each ply.\nndarray[Any, dtype[float64]]\ne2\nndarray\nAny\ndtype\nfloat64" + "objectID": "examples/gallery_examples/011_rst_workflow", + "href": "examples/gallery_examples/011_rst_workflow.html#configure-combined-failure-criterion", + "title": "Failure analysis of an MAPDL (RST) model > Configure combined failure criterion", + "section": "Configure combined failure criterion", + "text": "Configure the combined failure criterion.\nConfigure combined failure criterion" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e2", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e2.html#ansys.dpf.composites.sampling_point.SamplingPoint.e2", - "title": "e2 > e2 > e2", - "section": "e2 > e2", - "text": "property SamplingPoint.e2: ndarray[Any, dtype[float64]]\n\nStrains in the material 2 direction of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/011_rst_workflow", + "href": "examples/gallery_examples/011_rst_workflow.html#set-up-model-and-evaluate-failures", + "title": "Failure analysis of an MAPDL (RST) model > Set up model and evaluate failures", + "section": "Set up model and evaluate failures", + "text": "Set up the composite model.\nEvaluate failures for the entire model\nSet up model and evaluate failures" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYt", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYt.html#strain_limits_eyt", - "title": "Strain_Limits_eYt", - "section": "Strain_Limits_eYt", - "text": "Strain_Limits_eYt" + "objectID": "examples/gallery_examples/011_rst_workflow", + "href": "examples/gallery_examples/011_rst_workflow.html#create-and-plot-a-sampling-point", + "title": "Failure analysis of an MAPDL (RST) model > Create and plot a sampling point", + "section": "Create and plot a sampling point", + "text": "Create and plot a sampling point" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYt", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYt.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYt", - "title": "Strain_Limits_eYt > Strain_Limits_eYt > Strain_Limits_eYt", - "section": "Strain_Limits_eYt > Strain_Limits_eYt", - "text": "MaterialProperty.Strain_Limits_eYt: str = 'strain_tensile_y_direction'\n\n" + "objectID": "examples/gallery_examples/011_rst_workflow", + "href": "examples/gallery_examples/011_rst_workflow.html#create-engineering-data-file-and-set-material-uuids-in-mapdl", + "title": "Failure analysis of an MAPDL (RST) model > Create Engineering Data file and set material UUIDs in MAPDL", + "section": "Create Engineering Data file and set material UUIDs in MAPDL", + "text": "Here are two workflows for setting up the engineering data file\nand the material UUIDs in MAPDL. The material UUIDs must be set\nin MAPDL before the model is solved.\nCreate an External Model system in WB and load the solver input file\nLink the External Model with an Engineering Data system and update it\nSave the project and copy the generated engineering data file (EngineeringData.xml)\nFor each material, look for the DataTransferID, go to MAPDL and set the material\nUUIDs with the MP,UVID,, command\nStart ACP, go to File - Import Model and load the solver input file (CDB)\nGo to the Materials folder and export the engineering data file (Ansys Workbench XML)\nFor each material, look for the DataTransferID, go to MAPDL and set the material\nUUID with the MP,UVID,, command.\nTotal running time of the script: (0 minutes 5.043 seconds)\nDownload Jupyter notebook: 011_rst_workflow.ipynb\nDownload Python source code: 011_rst_workflow.py\nDownload zipped: 011_rst_workflow.zip\nGallery generated by Sphinx-Gallery\nCreate Engineering Data file and set material UUIDs in MAPDL\nDataTransferID\nMP,UVID,,\nDataTransferID\nMP,UVID,,\nDownload Jupyter notebook: 011_rst_workflow.ipynb\nDownload Python source code: 011_rst_workflow.py\nDownload zipped: 011_rst_workflow.zip" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmC", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmC.html#cmc", - "title": "cmC", - "section": "cmC", - "text": "cmC" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pf.html#pf", + "title": "pf", + "section": "pf", + "text": "pf" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmC", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmC.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.cmC", - "title": "cmC > cmC > cmC", - "section": "cmC > cmC", - "text": "FailureModeEnum.cmC = 1005\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pf.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.pf", + "title": "pf > pf > pf", + "section": "pf > pf", + "text": "FailureModeEnum.pf = 801\n\n" }, { "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e13", @@ -1106,1999 +868,2111 @@ "text": "property MaxStrainCriterion.e13: bool\n\nWhether to activate the failure evaluation regarding the interlaminar shear strain e13.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYc.html#eyc", - "title": "eYc", - "section": "eYc", - "text": "Global compressive strain limit in material direction 1.\nfloat\neYc\nfloat" + "objectID": "sg_execution_times", + "href": "sg_execution_times.html#computation-times", + "title": "Computation times", + "section": "Computation times", + "text": "01:22.317 total execution time for 15 files from all galleries:\nExample\nTime\nMem (MB)\nsphx_glr_examples_gallery_examples_001_failure_operator_example.py (../../examples/001_failure_operator_example.py)\n00:12.061\n0.0\nsphx_glr_examples_gallery_examples_010_harmonic_example.py (../../examples/010_harmonic_example.py)\n00:09.928\n0.0\nsphx_glr_examples_gallery_examples_014_cyclic_symmetry_example.py (../../examples/014_cyclic_symmetry_example.py)\n00:07.394\n0.0\nsphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py (../../examples/007_interlaminar_normal_stress_example.py)\n00:07.360\n0.0\nsphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py (../../examples/009_short_fiber_orientation_tensor.py)\n00:05.827\n0.0\nsphx_glr_examples_gallery_examples_011_rst_workflow.py (../../examples/011_rst_workflow.py)\n00:05.043\n0.0\nsphx_glr_examples_gallery_examples_002_sampling_point_example.py (../../examples/002_sampling_point_example.py)\n00:04.888\n0.0\nsphx_glr_examples_gallery_examples_099_dpf_composite_failure_workflow.py (../../examples/099_dpf_composite_failure_workflow.py)\n00:04.671\n0.0\nsphx_glr_examples_gallery_examples_006_filter_composite_data_example.py (../../examples/006_filter_composite_data_example.py)\n00:04.636\n0.0\nsphx_glr_examples_gallery_examples_013_thermal_example.py (../../examples/013_thermal_example.py)\n00:04.181\n0.0\nsphx_glr_examples_gallery_examples_008_assembly_example.py (../../examples/008_assembly_example.py)\n00:04.148\n0.0\nsphx_glr_examples_gallery_examples_012_fatigue_example.py (../../examples/012_fatigue_example.py)\n00:03.799\n0.0\nsphx_glr_examples_gallery_examples_004_get_material_properties_example.py (../../examples/004_get_material_properties_example.py)\n00:03.610\n0.0\nsphx_glr_examples_gallery_examples_003_short_fiber_example.py (../../examples/003_short_fiber_example.py)\n00:03.287\n0.0\nsphx_glr_examples_gallery_examples_005_get_layup_properties_example.py (../../examples/005_get_layup_properties_example.py)\n00:01.484\n0.0\nComputation times\n../../examples/001_failure_operator_example.py\n../../examples/010_harmonic_example.py\n../../examples/014_cyclic_symmetry_example.py\n../../examples/007_interlaminar_normal_stress_example.py\n../../examples/009_short_fiber_orientation_tensor.py\n../../examples/011_rst_workflow.py\n../../examples/002_sampling_point_example.py\n../../examples/099_dpf_composite_failure_workflow.py\n../../examples/006_filter_composite_data_example.py\n../../examples/013_thermal_example.py\n../../examples/008_assembly_example.py\n../../examples/012_fatigue_example.py\n../../examples/004_get_material_properties_example.py\n../../examples/003_short_fiber_example.py\n../../examples/005_get_layup_properties_example.py" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYc.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYc", - "title": "eYc > eYc > eYc", - "section": "eYc > eYc", - "text": "property MaxStrainCriterion.eYc: float\n\nGlobal compressive strain limit in material direction 1.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.tw", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.tw.html#tw", + "title": "tw", + "section": "tw", + "text": "tw" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.time", - "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.time.html#time", - "title": "time", - "section": "time", - "text": "time" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.tw", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.tw.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.tw", + "title": "tw > tw > tw", + "section": "tw > tw", + "text": "FailureModeEnum.tw = 400\n\n" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aX", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aX.html#thermal_expansion_coefficients_ax", + "title": "Thermal_Expansion_Coefficients_aX", + "section": "Thermal_Expansion_Coefficients_aX", + "text": "Thermal_Expansion_Coefficients_aX" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aX", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aX.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aX", + "title": "Thermal_Expansion_Coefficients_aX > Thermal_Expansion_Coefficients_aX > Thermal_Expansion_Coefficients_aX", + "section": "Thermal_Expansion_Coefficients_aX > Thermal_Expansion_Coefficients_aX", + "text": "MaterialProperty.Thermal_Expansion_Coefficients_aX: str = 'coefficient_thermal_expansion_x'\n\n" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.strip", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.strip.html#strip", + "title": "strip", + "section": "strip", + "text": "Return a copy of the string with leading and trailing whitespace removed.\nIf chars is given and not None, remove characters in chars instead.\nstrip" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.strip", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.strip.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.strip", + "title": "strip > strip > strip", + "section": "strip > strip", + "text": "FailureMeasureEnum.strip(chars=None, /)\n\nReturn a copy of the string with leading and trailing whitespace removed.\n\nIf chars is given and not None, remove characters in chars instead.\n\n!! processed by numpydoc !!" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT", + "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT.html#max_local_layer_in_element", + "title": "MAX_LOCAL_LAYER_IN_ELEMENT", + "section": "MAX_LOCAL_LAYER_IN_ELEMENT", + "text": "MAX_LOCAL_LAYER_IN_ELEMENT" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT", + "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT.html#ansys.dpf.composites.constants.FailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT", + "title": "MAX_LOCAL_LAYER_IN_ELEMENT > MAX_LOCAL_LAYER_IN_ELEMENT > MAX_LOCAL_LAYER_IN_ELEMENT", + "section": "MAX_LOCAL_LAYER_IN_ELEMENT > MAX_LOCAL_LAYER_IN_ELEMENT", + "text": "FailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT = 6\n\n" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR32", + "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR32.html#tensor32", + "title": "TENSOR32", + "section": "TENSOR32", + "text": "TENSOR32" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR32", + "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR32.html#ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR32", + "title": "TENSOR32 > TENSOR32 > TENSOR32", + "section": "TENSOR32 > TENSOR32", + "text": "Sym3x3TensorComponent.TENSOR32 = 4\n\n" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3t", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3t.html#e3t", + "title": "e3t", + "section": "e3t", + "text": "e3t" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3t", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3t.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e3t", + "title": "e3t > e3t > e3t", + "section": "e3t > e3t", + "text": "FailureModeEnum.e3t = 131\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.time", - "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.time.html#ansys.dpf.composites.composite_scope.CompositeScope.time", - "title": "time > time > time", - "section": "time > time", - "text": "CompositeScope.time: float | None = None\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.html#puckcriterion", + "title": "PuckCriterion", + "section": "PuckCriterion", + "text": "Defines the Puck failure criterion for UD reinforced materials.\npf (bool, default: True) – Whether to activate the failure evaluation regarding fiber failure.\npma (bool, default: True) – Whether to activate the failure evaluation regarding matrix failure due to tension.\npmb (bool, default: True) – Whether to activate the failure evaluation regarding matrix failure due to compression.\npmc (bool, default: True) – Whether to activate the failure evaluation regarding matrix failure due to shear failure.\npd (bool, default: False) – Whether to activate the failure evaluation regarding delamination if dim is equal to 3.\ndim (int, default: 2) – Whether the 2D or 3D formulation of the criterion is used. The latter one also supports the failure mode delamination. Use 1 for a simplified Puck criterion.\nwf_pf (float, default: 1.0) – Weighting factor of the fiber failure (pf) mode.\nwf_pma (float, default: 1.0) – Weighting factor of the matrix failure (pma) mode.\nwf_pmb (float, default: 1.0) – Weighting factor of the matrix failure (pmb) mode.\nwf_pmc (float, default: 1.0) – Weighting factor of the matrix failure (pmc) mode.\nwf_pd (float, default: 1.0) – Weighting factor of the delamination failure (pd) mode.\ncfps (bool, default: True) – Whether to consider inter-fiber strength reduction due to fiber parallel stresses.\ns (float, default: 0.5) – Specifies the effect of fiber parallel stresses regarding inter-fiber failure. s = [0, 1) and the default is 0.5.\nm – Specifies the effect of fiber parallel stresses regarding inter-fiber failure. M = [0, 1). The default is 0.5.\ninterface_weakening_factor (float, default: 0.8) – Multiplicator for the interlaminar strength if failure mode pd is active. The default is 0.8.\nforce_global_constants (bool, default: False) – Whether to use global constants instead of the material-wise properties.\np21_neg (float, default: 0.275) – Global inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for compression.\np21_pos (float, default: 0.325) – Global inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for tension.,\np22_neg (float, default: 0.225) – Global inclination factor of the fracture plane \\perp \\perp for compression.\np22_pos (float, default: 0.225) – Global inclination factor of the fracture plane \\perp \\perp for tension.\nPuckCriterion.to_dict()\n\nPuckCriterion.to_json()\n\nPuckCriterion.M\nSpecifies the effect of fiber parallel stresses regarding inter-fiber failure.\nPuckCriterion.active\nThe failure criterion is suppressed if active is False.\nPuckCriterion.cfps\nWhether to consider inter-fiber strength reduction due to fiber parallel stresses.\nPuckCriterion.dim\nWhether the 2D or 3D formulation of the criterion is used.\nPuckCriterion.force_global_constants\nWhether to use global constants instead of the material-wise properties.\nPuckCriterion.interface_weakening_factor\nMultiplicator for the interlaminar strength if failure mode pd is active.\nPuckCriterion.name\nName of the failure criterion.\nPuckCriterion.p21_neg\nGlobal inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for compression.\nPuckCriterion.p21_pos\nGlobal inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for tension.\nPuckCriterion.p22_neg\nGlobal inclination factor of the fracture plane \\perp \\perp for compression.\nPuckCriterion.p22_pos\nGlobal inclination factor of the fracture plane \\perp \\perp for tension.\nPuckCriterion.pd\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\nPuckCriterion.pf\nWhether to activate the failure evaluation regarding fiber failure.\nPuckCriterion.pma\nWhether to activate the failure evaluation regarding matrix failure due to tension.\nPuckCriterion.pmb\nWhether to activate the failure evaluation regarding matrix failure due to compression.\nPuckCriterion.pmc\nWhether to activate the failure evaluation regarding matrix failure due to shear failure.\nPuckCriterion.s\nSpecifies the effect of fiber parallel stresses regarding inter-fiber failure.\nPuckCriterion.wf_pd\nWeighting factor of the delamination failure (pd) mode.\nPuckCriterion.wf_pf\nWeighting factor of the fiber failure (pf) mode.\nPuckCriterion.wf_pma\nWeighting factor of the matrix failure (pma) mode.\nPuckCriterion.wf_pmb\nWeighting factor of the matrix failure (pmb) mode.\nPuckCriterion.wf_pmc\nWeighting factor of the matrix failure (pmc) mode.\nPuckCriterion\nbool\nTrue\nbool\nTrue\nbool\nTrue\nbool\nTrue\nbool\nFalse\nint\n2\n1\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nbool\nTrue\nfloat\n0.5\n0.5\n0.5\nfloat\n0.8\npd\n0.8\nbool\nFalse\nfloat\n0.275\nfloat\n0.325\nfloat\n0.225\nfloat\n0.225\nPuckCriterion.to_dict\nPuckCriterion.to_json\nPuckCriterion.M\nPuckCriterion.active\nPuckCriterion.cfps\nPuckCriterion.dim\nPuckCriterion.force_global_constants\nPuckCriterion.interface_weakening_factor\npd\nPuckCriterion.name\nPuckCriterion.p21_neg\nPuckCriterion.p21_pos\nPuckCriterion.p22_neg\nPuckCriterion.p22_pos\nPuckCriterion.pd\nPuckCriterion.pf\nPuckCriterion.pma\nPuckCriterion.pmb\nPuckCriterion.pmc\nPuckCriterion.s\nPuckCriterion.wf_pd\nPuckCriterion.wf_pf\nPuckCriterion.wf_pma\nPuckCriterion.wf_pmb\nPuckCriterion.wf_pmc" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.b21", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.b21.html#b21", - "title": "b21", - "section": "b21", - "text": "In-plane shear friction coefficient. The default is 0.2.\nfloat\nb21\n0.2\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.html#ansys.dpf.composites.failure_criteria.PuckCriterion", + "title": "PuckCriterion > PuckCriterion > PuckCriterion", + "section": "PuckCriterion > PuckCriterion", + "text": "class ansys.dpf.composites.failure_criteria.PuckCriterion(*, pf=True, pma=True, pmb=True, pmc=True, pd=False, dim=2, wf_pf=1.0, wf_pma=1.0, wf_pmb=1.0, wf_pmc=1.0, wf_pd=1.0, cfps=True, s=0.5, M=0.5, interface_weakening_factor=0.8, force_global_constants=False, p21_neg=0.275, p21_pos=0.325, p22_neg=0.225, p22_pos=0.225)\n\nDefines the Puck failure criterion for UD reinforced materials.\n\nParameters\n\npf (bool, default: True) – Whether to activate the failure evaluation regarding fiber failure.\n\npma (bool, default: True) – Whether to activate the failure evaluation regarding matrix failure due to tension.\n\npmb (bool, default: True) – Whether to activate the failure evaluation regarding matrix failure due to compression.\n\npmc (bool, default: True) – Whether to activate the failure evaluation regarding matrix failure due to shear failure.\n\npd (bool, default: False) – Whether to activate the failure evaluation regarding delamination if dim is equal to 3.\n\ndim (int, default: 2) – Whether the 2D or 3D formulation of the criterion is used. The latter one also supports the failure mode delamination. Use 1 for a simplified Puck criterion.\n\nwf_pf (float, default: 1.0) – Weighting factor of the fiber failure (pf) mode.\n\nwf_pma (float, default: 1.0) – Weighting factor of the matrix failure (pma) mode.\n\nwf_pmb (float, default: 1.0) – Weighting factor of the matrix failure (pmb) mode.\n\nwf_pmc (float, default: 1.0) – Weighting factor of the matrix failure (pmc) mode.\n\nwf_pd (float, default: 1.0) – Weighting factor of the delamination failure (pd) mode.\n\ncfps (bool, default: True) – Whether to consider inter-fiber strength reduction due to fiber parallel stresses.\n\ns (float, default: 0.5) – Specifies the effect of fiber parallel stresses regarding inter-fiber failure. s = [0, 1) and the default is 0.5.\n\nm – Specifies the effect of fiber parallel stresses regarding inter-fiber failure. M = [0, 1). The default is 0.5.\n\ninterface_weakening_factor (float, default: 0.8) – Multiplicator for the interlaminar strength if failure mode pd is active. The default is 0.8.\n\nforce_global_constants (bool, default: False) – Whether to use global constants instead of the material-wise properties.\n\np21_neg (float, default: 0.275) – Global inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for compression.\n\np21_pos (float, default: 0.325) – Global inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for tension.,\n\np22_neg (float, default: 0.225) – Global inclination factor of the fracture plane \\perp \\perp for compression.\n\np22_pos (float, default: 0.225) – Global inclination factor of the fracture plane \\perp \\perp for tension.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nPuckCriterion.to_dict()\n\n\n\nPuckCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nPuckCriterion.M\n\nSpecifies the effect of fiber parallel stresses regarding inter-fiber failure.\n\nPuckCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nPuckCriterion.cfps\n\nWhether to consider inter-fiber strength reduction due to fiber parallel stresses.\n\nPuckCriterion.dim\n\nWhether the 2D or 3D formulation of the criterion is used.\n\nPuckCriterion.force_global_constants\n\nWhether to use global constants instead of the material-wise properties.\n\nPuckCriterion.interface_weakening_factor\n\nMultiplicator for the interlaminar strength if failure mode pd is active.\n\nPuckCriterion.name\n\nName of the failure criterion.\n\nPuckCriterion.p21_neg\n\nGlobal inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for compression.\n\nPuckCriterion.p21_pos\n\nGlobal inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for tension.\n\nPuckCriterion.p22_neg\n\nGlobal inclination factor of the fracture plane \\perp \\perp for compression.\n\nPuckCriterion.p22_pos\n\nGlobal inclination factor of the fracture plane \\perp \\perp for tension.\n\nPuckCriterion.pd\n\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\n\nPuckCriterion.pf\n\nWhether to activate the failure evaluation regarding fiber failure.\n\nPuckCriterion.pma\n\nWhether to activate the failure evaluation regarding matrix failure due to tension.\n\nPuckCriterion.pmb\n\nWhether to activate the failure evaluation regarding matrix failure due to compression.\n\nPuckCriterion.pmc\n\nWhether to activate the failure evaluation regarding matrix failure due to shear failure.\n\nPuckCriterion.s\n\nSpecifies the effect of fiber parallel stresses regarding inter-fiber failure.\n\nPuckCriterion.wf_pd\n\nWeighting factor of the delamination failure (pd) mode.\n\nPuckCriterion.wf_pf\n\nWeighting factor of the fiber failure (pf) mode.\n\nPuckCriterion.wf_pma\n\nWeighting factor of the matrix failure (pma) mode.\n\nPuckCriterion.wf_pmb\n\nWeighting factor of the matrix failure (pmb) mode.\n\nPuckCriterion.wf_pmc\n\nWeighting factor of the matrix failure (pmc) mode.\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.b21", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.b21.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.b21", - "title": "b21 > b21 > b21", - "section": "b21 > b21", - "text": "property CuntzeCriterion.b21: float\n\nIn-plane shear friction coefficient. The default is 0.2.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_provider", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_provider.html#material_provider", + "title": "material_provider", + "section": "material_provider", + "text": "Get material_provider.\nOperator\nmaterial_provider\nOperator" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.removesuffix", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.removesuffix.html#removesuffix", - "title": "removesuffix", - "section": "removesuffix", - "text": "Return a str with the given suffix string removed if present.\nIf the string ends with the suffix string and that suffix is not empty,\nreturn string[:-len(suffix)]. Otherwise, return a copy of the original\nstring.\nremovesuffix" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_provider", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_provider.html#ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_provider", + "title": "material_provider > material_provider > material_provider", + "section": "material_provider > material_provider", + "text": "property MaterialOperators.material_provider: Operator\n\nGet material_provider.\n\nReturn type\n\nOperator\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.removesuffix", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.removesuffix.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.removesuffix", - "title": "removesuffix > removesuffix > removesuffix", - "section": "removesuffix > removesuffix", - "text": "FailureMeasureEnum.removesuffix(suffix, /)\n\nReturn a str with the given suffix string removed if present.\n\nIf the string ends with the suffix string and that suffix is not empty,\nreturn string[:-len(suffix)]. Otherwise, return a copy of the original\nstring.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aY", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aY.html#thermal_expansion_coefficients_ay", + "title": "Thermal_Expansion_Coefficients_aY", + "section": "Thermal_Expansion_Coefficients_aY", + "text": "Thermal_Expansion_Coefficients_aY" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.is_uptodate", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.is_uptodate.html#is_uptodate", - "title": "is_uptodate", - "section": "is_uptodate", - "text": "True if the Sampling Point is up-to-date.\nbool\nis_uptodate\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aY", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aY.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aY", + "title": "Thermal_Expansion_Coefficients_aY > Thermal_Expansion_Coefficients_aY > Thermal_Expansion_Coefficients_aY", + "section": "Thermal_Expansion_Coefficients_aY > Thermal_Expansion_Coefficients_aY", + "text": "MaterialProperty.Thermal_Expansion_Coefficients_aY: str = 'coefficient_thermal_expansion_y'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.is_uptodate", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.is_uptodate.html#ansys.dpf.composites.sampling_point.SamplingPoint.is_uptodate", - "title": "is_uptodate > is_uptodate > is_uptodate", - "section": "is_uptodate > is_uptodate", - "text": "property SamplingPoint.is_uptodate: bool\n\nTrue if the Sampling Point is up-to-date.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR33", + "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR33.html#tensor33", + "title": "TENSOR33", + "section": "TENSOR33", + "text": "TENSOR33" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e3", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e3.html#wf_e3", - "title": "wf_e3", - "section": "wf_e3", - "text": "Weighting factor of the failure mode e3.\nfloat\nwf_e3\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR33", + "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR33.html#ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR33", + "title": "TENSOR33 > TENSOR33 > TENSOR33", + "section": "TENSOR33 > TENSOR33", + "text": "Sym3x3TensorComponent.TENSOR33 = 2\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e3", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e3.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e3", - "title": "wf_e3 > wf_e3 > wf_e3", - "section": "wf_e3 > wf_e3", - "text": "property MaxStrainCriterion.wf_e3: float\n\nWeighting factor of the failure mode e3.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/099_dpf_composite_failure_workflow", + "href": "examples/gallery_examples/099_dpf_composite_failure_workflow.html#dpf-composite-failure-workflow", + "title": "DPF composite failure workflow", + "section": "DPF composite failure workflow", + "text": "This example shows how to use the native DPF Python interface to configure\nand run the composite failure evaluator. It connects the different DPF\noperators that are needed to evaluate composite failure criteria.\nFor simple use cases, using the composite failure operator or\ncomposite sampling point operator is preferable. For examples,\nsee sphx_glr_examples_gallery_examples_001_failure_operator_example.py\nand sphx_glr_examples_gallery_examples_002_sampling_point_example.py.\nAdditionally, sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py\nshows how helper functions can be used to obtain composite result data.\nDPF composite failure workflow" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xt", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xt.html#stress_limits_xt", - "title": "Stress_Limits_Xt", - "section": "Stress_Limits_Xt", - "text": "Stress_Limits_Xt" + "objectID": "examples/gallery_examples/099_dpf_composite_failure_workflow", + "href": "examples/gallery_examples/099_dpf_composite_failure_workflow.html#set-up-analysis", + "title": "DPF composite failure workflow > Set up analysis", + "section": "Set up analysis", + "text": "Setting up the analysis consists of loading Ansys libraries, configuring\nthe combined failure criterion, connecting to the DPF server, and\npreparing files.\nLoad Ansys libraries.\nConfigure the combined failure criterion.\nStart a DPF server and prepare files\nSet up analysis" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xt", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xt.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xt", - "title": "Stress_Limits_Xt > Stress_Limits_Xt > Stress_Limits_Xt", - "section": "Stress_Limits_Xt > Stress_Limits_Xt", - "text": "MaterialProperty.Stress_Limits_Xt: str = 'stress_tensile_x_direction'\n\n" + "objectID": "examples/gallery_examples/099_dpf_composite_failure_workflow", + "href": "examples/gallery_examples/099_dpf_composite_failure_workflow.html#initialize-dpf-model-and-data-sources", + "title": "DPF composite failure workflow > Initialize DPF model and data sources", + "section": "Initialize DPF model and data sources", + "text": "Initialize the DPF model and the data sources.\nInitialize DPF model and data sources" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_shear_angles", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_shear_angles.html#get_layer_shear_angles", - "title": "get_layer_shear_angles", - "section": "get_layer_shear_angles", - "text": "Get shear angle for all layers. Returns None if element is not layered.\nelement_id (int) – Element Id/Label\nOptional[ndarray[Any, dtype[float64]]]\nget_layer_shear_angles\nint\nOptional\nndarray\nAny\ndtype\nfloat64" + "objectID": "examples/gallery_examples/099_dpf_composite_failure_workflow", + "href": "examples/gallery_examples/099_dpf_composite_failure_workflow.html#set-up-providers", + "title": "DPF composite failure workflow > Set up providers", + "section": "Set up providers", + "text": "Set up the mesh provider.\nSet up the material support provider.\nThe material support provider takes care of mapping the materials in the RST file to\nthe materials in the composite definitions.\nThe material support contains all materials from the RST file.\nSet up the result information provider, which gets\nthe unit system from the RST file.\nSet up the material provider\nThe material provider combines the material support in the engineering data\nXML file and the unit system. Its output can be used to evaluate material\nproperties.\nSet up the lay-up provider, which reads the composite definition file\nand enriches the mesh with the composite lay-up information.\nSet up providers" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_shear_angles", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_shear_angles.html#ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_shear_angles", - "title": "get_layer_shear_angles > get_layer_shear_angles > get_layer_shear_angles", - "section": "get_layer_shear_angles > get_layer_shear_angles", - "text": "LayupPropertiesProvider.get_layer_shear_angles(element_id)\n\nGet shear angle for all layers. Returns None if element is not layered.\n\nParameters\n\nelement_id (int) – Element Id/Label\n\nReturn type\n\nOptional[ndarray[Any, dtype[float64]]]\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/099_dpf_composite_failure_workflow", + "href": "examples/gallery_examples/099_dpf_composite_failure_workflow.html#set-up-result-operators", + "title": "DPF composite failure workflow > Set up result operators", + "section": "Set up result operators", + "text": "Set up result operators for strains and stresses.\nrotate_to_global is False because the postprocessing engine expects the\nresults to be in the element coordinate system (material coordinate system).\nSet up result operators\nrotate_to_global\nFalse" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_effective_strain", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_effective_strain.html#strain_limits_effective_strain", - "title": "Strain_Limits_effective_strain", - "section": "Strain_Limits_effective_strain", - "text": "Strain_Limits_effective_strain" + "objectID": "examples/gallery_examples/099_dpf_composite_failure_workflow", + "href": "examples/gallery_examples/099_dpf_composite_failure_workflow.html#set-up-failure-evaluator", + "title": "DPF composite failure workflow > Set up failure evaluator", + "section": "Set up failure evaluator", + "text": "Set up the failure evaluator, which combines the results and\nevaluates all failure criteria. The output contains the\nmaximum failure criteria for each integration point.\nSet up failure evaluator" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_effective_strain", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_effective_strain.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_effective_strain", - "title": "Strain_Limits_effective_strain > Strain_Limits_effective_strain > Strain_Limits_effective_strain", - "section": "Strain_Limits_effective_strain > Strain_Limits_effective_strain", - "text": "MaterialProperty.Strain_Limits_effective_strain: str = 'von_mises'\n\n" + "objectID": "examples/gallery_examples/099_dpf_composite_failure_workflow", + "href": "examples/gallery_examples/099_dpf_composite_failure_workflow.html#compute-and-plot-failure-criteria", + "title": "DPF composite failure workflow > Compute and plot failure criteria", + "section": "Compute and plot failure criteria", + "text": "Use the output of the multiple failure criteria operator to\ncompute the minimum and maximum failure criteria for each element.\nPlot the maximum and minimum values.\nTotal running time of the script: (0 minutes 4.671 seconds)\nDownload Jupyter notebook: 099_dpf_composite_failure_workflow.ipynb\nDownload Python source code: 099_dpf_composite_failure_workflow.py\nDownload zipped: 099_dpf_composite_failure_workflow.zip\nGallery generated by Sphinx-Gallery\nCompute and plot failure criteria\nDownload Jupyter notebook: 099_dpf_composite_failure_workflow.ipynb\nDownload Python source code: 099_dpf_composite_failure_workflow.py\nDownload zipped: 099_dpf_composite_failure_workflow.zip" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.to_json.html#to_json", - "title": "to_json", - "section": "to_json", - "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmb", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmb.html#cmb", + "title": "cmb", + "section": "cmb", + "text": "Activates the failure evaluation of the matrix due to compression.\nbool\ncmb\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.to_json.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.to_json", - "title": "to_json > to_json > to_json", - "section": "to_json > to_json", - "text": "LaRCCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmb", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmb.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmb", + "title": "cmb > cmb > cmb", + "section": "cmb > cmb", + "text": "property CuntzeCriterion.cmb: bool\n\nActivates the failure evaluation of the matrix due to compression.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.center", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.center.html#center", - "title": "center", - "section": "center", - "text": "Return a centered string of length width.\nPadding is done using the specified fill character (default is a space).\ncenter" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p21_neg", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p21_neg.html#p21_neg", + "title": "p21_neg", + "section": "p21_neg", + "text": "Global inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for compression.\nfloat\np21_neg\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.center", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.center.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.center", - "title": "center > center > center", - "section": "center > center", - "text": "FailureMeasureEnum.center(width, fillchar=' ', /)\n\nReturn a centered string of length width.\n\nPadding is done using the specified fill character (default is a space).\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p21_neg", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p21_neg.html#ansys.dpf.composites.failure_criteria.PuckCriterion.p21_neg", + "title": "p21_neg > p21_neg > p21_neg", + "section": "p21_neg > p21_neg", + "text": "property PuckCriterion.p21_neg: float\n\nGlobal inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for compression.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmt", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmt.html#wf_lmt", - "title": "wf_lmt", - "section": "wf_lmt", - "text": "Weighting factor of matrix failure due to tension (lmt).\nfloat\nwf_lmt\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xz", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xz.html#tsai_wu_constant_xz", + "title": "Tsai_Wu_Constant_xz", + "section": "Tsai_Wu_Constant_xz", + "text": "Tsai_Wu_Constant_xz" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmt", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmt.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmt", - "title": "wf_lmt > wf_lmt > wf_lmt", - "section": "wf_lmt > wf_lmt", - "text": "property LaRCCriterion.wf_lmt: float\n\nWeighting factor of matrix failure due to tension (lmt).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xz", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xz.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xz", + "title": "Tsai_Wu_Constant_xz > Tsai_Wu_Constant_xz > Tsai_Wu_Constant_xz", + "section": "Tsai_Wu_Constant_xz > Tsai_Wu_Constant_xz", + "text": "MaterialProperty.Tsai_Wu_Constant_xz: str = 'coupling_coef_xz_tsai_wu'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.to_dict.html#to_dict", - "title": "to_dict", - "section": "to_dict", - "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pd", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pd.html#pd", + "title": "pd", + "section": "pd", + "text": "pd" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.PuckCriterion.to_dict", - "title": "to_dict > to_dict > to_dict", - "section": "to_dict > to_dict", - "text": "PuckCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pd", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pd.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.pd", + "title": "pd > pd > pd", + "section": "pd > pd", + "text": "FailureModeEnum.pd = 805\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s23", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s23.html#s23", - "title": "s23", - "section": "s23", - "text": "Whether to activate the failure evaluation regarding the interlaminar shear stress s23.\nbool\ns23\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxy", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxy.html#esxy", + "title": "eSxy", + "section": "eSxy", + "text": "Global strain limit in material direction 12.\nfloat\neSxy\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s23", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s23.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.s23", - "title": "s23 > s23 > s23", - "section": "s23 > s23", - "text": "property MaxStressCriterion.s23: bool\n\nWhether to activate the failure evaluation regarding the interlaminar shear stress s23.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxy", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxy.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxy", + "title": "eSxy > eSxy > eSxy", + "section": "eSxy > eSxy", + "text": "property MaxStrainCriterion.eSxy: float\n\nGlobal strain limit in material direction 12.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3.html#s3", - "title": "s3", - "section": "s3", - "text": "s3" + { + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXt", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXt.html#strain_limits_ext", + "title": "Strain_Limits_eXt", + "section": "Strain_Limits_eXt", + "text": "Strain_Limits_eXt" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s3", - "title": "s3 > s3 > s3", - "section": "s3 > s3", - "text": "FailureModeEnum.s3 = 230\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXt", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXt.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXt", + "title": "Strain_Limits_eXt > Strain_Limits_eXt > Strain_Limits_eXt", + "section": "Strain_Limits_eXt > Strain_Limits_eXt", + "text": "MaterialProperty.Strain_Limits_eXt: str = 'strain_tensile_x_direction'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.material_name", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.material_name.html#material_name", - "title": "material_name", - "section": "material_name", - "text": "material_name" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yt", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yt.html#stress_limits_yt", + "title": "Stress_Limits_Yt", + "section": "Stress_Limits_Yt", + "text": "Stress_Limits_Yt" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.material_name", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.material_name.html#ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.material_name", - "title": "material_name > material_name > material_name", - "section": "material_name > material_name", - "text": "MaterialMetadata.material_name: str = ''\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yt", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yt.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yt", + "title": "Stress_Limits_Yt > Stress_Limits_Yt > Stress_Limits_Yt", + "section": "Stress_Limits_Yt > Stress_Limits_Yt", + "text": "MaterialProperty.Stress_Limits_Yt: str = 'stress_tensile_y_direction'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.mapping", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.mapping.html#mapping", - "title": "mapping", - "section": "mapping", - "text": "mapping" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.old_composite_sources", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.old_composite_sources.html#old_composite_sources", + "title": "old_composite_sources", + "section": "old_composite_sources", + "text": "old_composite_sources" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.mapping", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.mapping.html#ansys.dpf.composites.data_sources.CompositeDefinitionFiles.mapping", - "title": "mapping > mapping > mapping", - "section": "mapping > mapping", - "text": "CompositeDefinitionFiles.mapping: str | PathLike[str] | None = None\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.old_composite_sources", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.old_composite_sources.html#ansys.dpf.composites.data_sources.CompositeDataSources.old_composite_sources", + "title": "old_composite_sources > old_composite_sources > old_composite_sources", + "section": "old_composite_sources > old_composite_sources", + "text": "CompositeDataSources.old_composite_sources: dict[str, DataSources]\n\n" }, { - "objectID": "api/composite_scope", - "href": "api/composite_scope.html#composite-scope", - "title": "Composite scope", - "section": "Composite scope", - "text": "CompositeScope([elements, plies, time, ...])\nProvides the composite scope.\nComposite scope\nCompositeScope" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.INVERSE_RESERVE_FACTOR", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.INVERSE_RESERVE_FACTOR.html#inverse_reserve_factor", + "title": "INVERSE_RESERVE_FACTOR", + "section": "INVERSE_RESERVE_FACTOR", + "text": "INVERSE_RESERVE_FACTOR" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_analysis_plies", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_analysis_plies.html#get_analysis_plies", - "title": "get_analysis_plies", - "section": "get_analysis_plies", - "text": "Get analysis ply names. Returns None if element is not layered.\nelement_id (int) – Element Id/Label\nOptional[Sequence[str]]\nget_analysis_plies\nint\nOptional\nSequence\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.INVERSE_RESERVE_FACTOR", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.INVERSE_RESERVE_FACTOR.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.INVERSE_RESERVE_FACTOR", + "title": "INVERSE_RESERVE_FACTOR > INVERSE_RESERVE_FACTOR > INVERSE_RESERVE_FACTOR", + "section": "INVERSE_RESERVE_FACTOR > INVERSE_RESERVE_FACTOR", + "text": "FailureMeasureEnum.INVERSE_RESERVE_FACTOR: str = 'inverse_reserve_factor'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_analysis_plies", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_analysis_plies.html#ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_analysis_plies", - "title": "get_analysis_plies > get_analysis_plies > get_analysis_plies", - "section": "get_analysis_plies > get_analysis_plies", - "text": "LayupPropertiesProvider.get_analysis_plies(element_id)\n\nGet analysis ply names. Returns None if element is not layered.\n\nParameters\n\nelement_id (int) – Element Id/Label\n\nReturn type\n\nOptional[Sequence[str]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc6", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc6.html#lfc6", + "title": "lfc6", + "section": "lfc6", + "text": "lfc6" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e12", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e12.html#e12", - "title": "e12", - "section": "e12", - "text": "e12" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc6", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc6.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc6", + "title": "lfc6 > lfc6 > lfc6", + "section": "lfc6 > lfc6", + "text": "FailureModeEnum.lfc6 = 903\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e12", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e12.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e12", - "title": "e12 > e12 > e12", - "section": "e12 > e12", - "text": "FailureModeEnum.e12 = 140\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K2", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K2.html#thermal_conductivity_k2", + "title": "Thermal_Conductivity_K2", + "section": "Thermal_Conductivity_K2", + "text": "Thermal_Conductivity_K2" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hf.html#hf", - "title": "hf", - "section": "hf", - "text": "Whether to activate the failure evaluation regarding fiber failure.\nbool\nhf\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K2", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K2.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K2", + "title": "Thermal_Conductivity_K2 > Thermal_Conductivity_K2 > Thermal_Conductivity_K2", + "section": "Thermal_Conductivity_K2 > Thermal_Conductivity_K2", + "text": "MaterialProperty.Thermal_Conductivity_K2: str = 'thermal_conductivity_y_direction'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hf.html#ansys.dpf.composites.failure_criteria.HashinCriterion.hf", - "title": "hf > hf > hf", - "section": "hf > hf", - "text": "property HashinCriterion.hf: bool\n\nWhether to activate the failure evaluation regarding fiber failure.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_definition_labels", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_definition_labels.html#composite_definition_labels", + "title": "composite_definition_labels", + "section": "composite_definition_labels", + "text": "All composite definition labels in the model.\nThis property is only relevant for assemblies.\nSequence[str]\ncomposite_definition_labels\nSequence\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZt", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZt.html#ezt", - "title": "eZt", - "section": "eZt", - "text": "Global strain limit in material direction 3.\nfloat\neZt\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_definition_labels", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_definition_labels.html#ansys.dpf.composites.composite_model.CompositeModel.composite_definition_labels", + "title": "composite_definition_labels > composite_definition_labels > composite_definition_labels", + "section": "composite_definition_labels > composite_definition_labels", + "text": "property CompositeModel.composite_definition_labels: Sequence[str]\n\nAll composite definition labels in the model.\n\nThis property is only relevant for assemblies.\n\nReturn type\n\nSequence[str]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZt", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZt.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZt", - "title": "eZt > eZt > eZt", - "section": "eZt > eZt", - "text": "property MaxStrainCriterion.eZt: float\n\nGlobal strain limit in material direction 3.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.html#layupproperty", + "title": "LayupProperty", + "section": "LayupProperty", + "text": "Enum for lay-up properties.\nValues correspond to labels in the output container of the lay-up provider.\nLayupProperty.ANGLE\n\nLayupProperty.SHEAR_ANGLE\n\nLayupProperty.THICKNESS\n\nLayupProperty.LAMINATE_OFFSET\n\nLayupProperty\nLayupProperty.ANGLE\nLayupProperty.SHEAR_ANGLE\nLayupProperty.THICKNESS\nLayupProperty.LAMINATE_OFFSET" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.result_info_provider", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.result_info_provider.html#result_info_provider", - "title": "result_info_provider", - "section": "result_info_provider", - "text": "Get result_info_provider.\nOperator\nresult_info_provider\nOperator" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.html#ansys.dpf.composites.layup_info.LayupProperty", + "title": "LayupProperty > LayupProperty > LayupProperty", + "section": "LayupProperty > LayupProperty", + "text": "class ansys.dpf.composites.layup_info.LayupProperty(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nEnum for lay-up properties.\n\nValues correspond to labels in the output container of the lay-up provider.\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nLayupProperty.ANGLE\n\n\n\nLayupProperty.SHEAR_ANGLE\n\n\n\nLayupProperty.THICKNESS\n\n\n\nLayupProperty.LAMINATE_OFFSET\n\n\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.result_info_provider", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.result_info_provider.html#ansys.dpf.composites.layup_info.material_operators.MaterialOperators.result_info_provider", - "title": "result_info_provider > result_info_provider > result_info_provider", - "section": "result_info_provider > result_info_provider", - "text": "property MaterialOperators.result_info_provider: Operator\n\nGet result_info_provider.\n\nReturn type\n\nOperator\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.html#shearcrimpingcriterion", + "title": "ShearCrimpingCriterion", + "section": "ShearCrimpingCriterion", + "text": "Defines the shear crimping failure criterion for sandwich structures.\nkc (float, default: 1.0) – Weighting factor of the core material for evaluation of the maximum allowable load. The default is 1.\nkf (float, default: 0.0) – Weighting factor of the face sheets for evaluation of the maximum allowable load. The default is 0 so the face sheet does not contribute to the allowable load. This property is valid for thin face sheets.\nwf (float, default: 1.0) – Weighting factor of the failure mode (wb or wt).\nShearCrimpingCriterion.to_dict()\n\nShearCrimpingCriterion.to_json()\n\nShearCrimpingCriterion.active\nThe failure criterion is suppressed if active is False.\nShearCrimpingCriterion.kc\nWeighting factor of the core material for evaluation of the maximum allowable load.\nShearCrimpingCriterion.kf\nWeighting factor of the face sheets for evaluation of the maximum allowable load.\nShearCrimpingCriterion.name\nName of the failure criterion.\nShearCrimpingCriterion.wf\nWeighting factor of the failure mode (wb or wt).\nShearCrimpingCriterion\nfloat\n1.0\n1\nfloat\n0.0\n0\nfloat\n1.0\nShearCrimpingCriterion.to_dict\nShearCrimpingCriterion.to_json\nShearCrimpingCriterion.active\nShearCrimpingCriterion.kc\nShearCrimpingCriterion.kf\nShearCrimpingCriterion.name\nShearCrimpingCriterion.wf" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.get_material_operators", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.get_material_operators.html#get_material_operators", - "title": "get_material_operators", - "section": "get_material_operators", - "text": "Get material properties related to operators.\nrst_data_source (DataSources) – Data source that contains a RST file. Note that multiple (distributed)\nRST files are not supported.\nengineering_data_source (DataSources) – Data source that contains the Engineering Data file.\nunit_system (Optional[Union[UnitSystem, Operator]], default: None) – Unit System\n----------\nMaterialOperators\nget_material_operators\nDataSources\nDataSources\nOptional\nUnion\nUnitSystem\nOperator\nNone\nMaterialOperators" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.html#ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion", + "title": "ShearCrimpingCriterion > ShearCrimpingCriterion > ShearCrimpingCriterion", + "section": "ShearCrimpingCriterion > ShearCrimpingCriterion", + "text": "class ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion(*, kc=1.0, kf=0.0, wf=1.0)\n\nDefines the shear crimping failure criterion for sandwich structures.\n\nParameters\n\nkc (float, default: 1.0) – Weighting factor of the core material for evaluation of the maximum allowable load. The default is 1.\n\nkf (float, default: 0.0) – Weighting factor of the face sheets for evaluation of the maximum allowable load. The default is 0 so the face sheet does not contribute to the allowable load. This property is valid for thin face sheets.\n\nwf (float, default: 1.0) – Weighting factor of the failure mode (wb or wt).\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nShearCrimpingCriterion.to_dict()\n\n\n\nShearCrimpingCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nShearCrimpingCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nShearCrimpingCriterion.kc\n\nWeighting factor of the core material for evaluation of the maximum allowable load.\n\nShearCrimpingCriterion.kf\n\nWeighting factor of the face sheets for evaluation of the maximum allowable load.\n\nShearCrimpingCriterion.name\n\nName of the failure criterion.\n\nShearCrimpingCriterion.wf\n\nWeighting factor of the failure mode (wb or wt).\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.get_material_operators", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.get_material_operators.html#ansys.dpf.composites.layup_info.material_operators.get_material_operators", - "title": "get_material_operators > get_material_operators > get_material_operators", - "section": "get_material_operators > get_material_operators", - "text": "ansys.dpf.composites.layup_info.material_operators.get_material_operators(rst_data_source, engineering_data_source, unit_system=None)\n\nGet material properties related to operators.\n\nParameters\n\nrst_data_source (DataSources) – Data source that contains a RST file. Note that multiple (distributed)\nRST files are not supported.\n\nengineering_data_source (DataSources) – Data source that contains the Engineering Data file.\n\nunit_system (Optional[Union[UnitSystem, Operator]], default: None) – Unit System\n\n----------\n\nReturn type\n\nMaterialOperators\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYc", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYc.html#strain_limits_eyc", + "title": "Strain_Limits_eYc", + "section": "Strain_Limits_eYc", + "text": "Strain_Limits_eYc" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isprintable", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isprintable.html#isprintable", - "title": "isprintable", - "section": "isprintable", - "text": "Return True if the string is printable, False otherwise.\nA string is printable if all of its characters are considered printable in\nrepr() or if it is empty.\nisprintable" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYc", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYc.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYc", + "title": "Strain_Limits_eYc > Strain_Limits_eYc > Strain_Limits_eYc", + "section": "Strain_Limits_eYc > Strain_Limits_eYc", + "text": "MaterialProperty.Strain_Limits_eYc: str = 'strain_compressive_y_direction'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isprintable", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isprintable.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isprintable", - "title": "isprintable > isprintable > isprintable", - "section": "isprintable > isprintable", - "text": "FailureMeasureEnum.isprintable(/)\n\nReturn True if the string is printable, False otherwise.\n\nA string is printable if all of its characters are considered printable in\nrepr() or if it is empty.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.active.html#active", + "title": "active", + "section": "active", + "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.ply_element_ids", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.ply_element_ids.html#ply_element_ids", - "title": "ply_element_ids", - "section": "ply_element_ids", - "text": "Return list of element labels of the analysis ply.\nSequence[int64]\nply_element_ids\nSequence\nint64" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.active.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.active", + "title": "active > active > active", + "section": "active > active", + "text": "property MaxStrainCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.ply_element_ids", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.ply_element_ids.html#ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.ply_element_ids", - "title": "ply_element_ids > ply_element_ids > ply_element_ids", - "section": "ply_element_ids > ply_element_ids", - "text": "AnalysisPlyInfoProvider.ply_element_ids()\n\nReturn list of element labels of the analysis ply.\n\nReturn type\n\nSequence[int64]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MAX", + "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MAX.html#max", + "title": "MAX", + "section": "MAX", + "text": "MAX" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_result_times_or_frequencies", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_result_times_or_frequencies.html#get_result_times_or_frequencies", - "title": "get_result_times_or_frequencies", - "section": "get_result_times_or_frequencies", - "text": "Get the times or frequencies in the result file.\nndarray[Any, dtype[float64]]\nget_result_times_or_frequencies\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MAX", + "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MAX.html#ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MAX", + "title": "MAX > MAX > MAX", + "section": "MAX > MAX", + "text": "SpotReductionStrategy.MAX = 'MAX'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_result_times_or_frequencies", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_result_times_or_frequencies.html#ansys.dpf.composites.composite_model.CompositeModel.get_result_times_or_frequencies", - "title": "get_result_times_or_frequencies > get_result_times_or_frequencies > get_result_times_or_frequencies", - "section": "get_result_times_or_frequencies > get_result_times_or_frequencies", - "text": "CompositeModel.get_result_times_or_frequencies()\n\nGet the times or frequencies in the result file.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.name.html#name", + "title": "name", + "section": "name", + "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices_by_analysis_ply", - "href": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices_by_analysis_ply.html#get_selected_indices_by_analysis_ply", - "title": "get_selected_indices_by_analysis_ply", - "section": "get_selected_indices_by_analysis_ply", - "text": "Get selected indices by analysis ply.\nSelects all indices that are in a layer with the given analysis ply\nanalysis_ply_info_provider (AnalysisPlyInfoProvider) – Provider for the analysis ply information.\nelement_info (ElementInfo) – Lay-up information for the element.\nSelected elementary indices.\nNDArray[int64]\nget_selected_indices_by_analysis_ply" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.name.html#ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.name", + "title": "name > name > name", + "section": "name > name", + "text": "property ShearCrimpingCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices_by_analysis_ply", - "href": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices_by_analysis_ply.html#ansys.dpf.composites.select_indices.get_selected_indices_by_analysis_ply", - "title": "get_selected_indices_by_analysis_ply > get_selected_indices_by_analysis_ply > get_selected_indices_by_analysis_ply", - "section": "get_selected_indices_by_analysis_ply > get_selected_indices_by_analysis_ply", - "text": "ansys.dpf.composites.select_indices.get_selected_indices_by_analysis_ply(analysis_ply_info_provider, element_info)\n\nGet selected indices by analysis ply.\n\nSelects all indices that are in a layer with the given analysis ply\n\nParameters\n\nanalysis_ply_info_provider (AnalysisPlyInfoProvider) – Provider for the analysis ply information.\n\nelement_info (ElementInfo) – Lay-up information for the element.\n\nReturns\n\nSelected elementary indices.\n\nReturn type\n\nNDArray[int64]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.active.html#active", + "title": "active", + "section": "active", + "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.BOT", - "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.BOT.html#bot", - "title": "BOT", - "section": "BOT", - "text": "BOT" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.active.html#ansys.dpf.composites.failure_criteria.HoffmanCriterion.active", + "title": "active > active > active", + "section": "active > active", + "text": "property HoffmanCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.BOT", - "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.BOT.html#ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.BOT", - "title": "BOT > BOT > BOT", - "section": "BOT > BOT", - "text": "SpotReductionStrategy.BOT = 'BOT'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s3", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s3.html#s3", + "title": "s3", + "section": "s3", + "text": "Whether to activate the failure evaluation regarding the stress in the material 3 direction (out-of-plane).\nbool\ns3\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_SOLID_ELEMENT_ID", - "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_SOLID_ELEMENT_ID.html#max_solid_element_id", - "title": "MAX_SOLID_ELEMENT_ID", - "section": "MAX_SOLID_ELEMENT_ID", - "text": "MAX_SOLID_ELEMENT_ID" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s3", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s3.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.s3", + "title": "s3 > s3 > s3", + "section": "s3 > s3", + "text": "property MaxStressCriterion.s3: bool\n\nWhether to activate the failure evaluation regarding the stress in the material 3 direction (out-of-plane).\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_SOLID_ELEMENT_ID", - "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_SOLID_ELEMENT_ID.html#ansys.dpf.composites.constants.FailureOutput.MAX_SOLID_ELEMENT_ID", - "title": "MAX_SOLID_ELEMENT_ID > MAX_SOLID_ELEMENT_ID > MAX_SOLID_ELEMENT_ID", - "section": "MAX_SOLID_ELEMENT_ID > MAX_SOLID_ELEMENT_ID", - "text": "FailureOutput.MAX_SOLID_ELEMENT_ID = 7\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R13", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R13.html#hill_yield_criterion_r13", + "title": "Hill_Yield_Criterion_R13", + "section": "Hill_Yield_Criterion_R13", + "text": "Hill_Yield_Criterion_R13" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hd", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hd.html#wf_hd", - "title": "wf_hd", - "section": "wf_hd", - "text": "Whether to activate the failure evaluation regarding delamination if dim is equal to 3.\nfloat\nwf_hd\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R13", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R13.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R13", + "title": "Hill_Yield_Criterion_R13 > Hill_Yield_Criterion_R13 > Hill_Yield_Criterion_R13", + "section": "Hill_Yield_Criterion_R13 > Hill_Yield_Criterion_R13", + "text": "MaterialProperty.Hill_Yield_Criterion_R13: str = 'yield_stress_ratio_xz_hill_criterion'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hd", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hd.html#ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hd", - "title": "wf_hd > wf_hd > wf_hd", - "section": "wf_hd > wf_hd", - "text": "property HashinCriterion.wf_hd: float\n\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.axes", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.axes.html#axes", + "title": "axes", + "section": "axes", + "text": "axes" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSyz", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSyz.html#strain_limits_esyz", - "title": "Strain_Limits_eSyz", - "section": "Strain_Limits_eSyz", - "text": "Strain_Limits_eSyz" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.axes", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.axes.html#ansys.dpf.composites.sampling_point.SamplingPointFigure.axes", + "title": "axes > axes > axes", + "section": "axes > axes", + "text": "SamplingPointFigure.axes: Any\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSyz", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSyz.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSyz", - "title": "Strain_Limits_eSyz > Strain_Limits_eSyz > Strain_Limits_eSyz", - "section": "Strain_Limits_eSyz > Strain_Limits_eSyz", - "text": "MaterialProperty.Strain_Limits_eSyz: str = 'strain_shear_yz'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.add_results_to_plot", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.add_results_to_plot.html#add_results_to_plot", + "title": "add_results_to_plot", + "section": "add_results_to_plot", + "text": "Add results (strain, stress, or failure values) to an Axes object.\naxes (Any) – Matplotlib Axes object.\ncomponents (Sequence[str]) – List of result components. Valid components for\nstrain are \"e1\", \"e2\", \"e3\", \"e12\", \"e13\",\nand \"e23\" Valid components for stress are \"s1\", \"s2\",\n\"s3\", \"s12\", \"s13\", and \"s23\". Valid components\nfor failure are \"inverse_reserve_factor\", \"reserve_factor\",\nand \"margin_of_safety\".\nspots (Collection[Spot], default: (, )) – Collection of spots (interfaces).\ncore_scale_factor (float, default: 1.0) – Factor for scaling the thickness of core plies.\ntitle (str, default: '') – Title of the plot. This parameter is ignored if empty.\nxlabel (str, default: '') – Becomes the label of the x-axis. This parameter is ignored if empty.\nNone\nadd_results_to_plot\nAxes\nAny\nAxes\nSequence\nstr\n\"e1\"\n\"e2\"\n\"e3\"\n\"e12\"\n\"e13\"\n\"e23\"\n\"s1\",\n\"s2\"\n\"s3\"\n\"s12\"\n\"s13\"\n\"s23\"\n\"inverse_reserve_factor\"\n\"reserve_factor\"\n\"margin_of_safety\"\nCollection\nSpot\n(, )\nfloat\n1.0\nstr\n''\nstr\n''\nNone" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.html#tsaihillcriterion", - "title": "TsaiHillCriterion", - "section": "TsaiHillCriterion", - "text": "Defines the Tsai-Hill failure criterion for orthotropic reinforced materials.\nwf (float, default: 1.0) – Weighting factor of this failure criterion.\ndim (int, default: 2) – Specifies which formulation of the failure criterion is used.\nTsaiHillCriterion.to_dict()\n\nTsaiHillCriterion.to_json()\n\nTsaiHillCriterion.active\nThe failure criterion is suppressed if active is False.\nTsaiHillCriterion.dim\nSpecifies which formulation of the failure criterion is used.\nTsaiHillCriterion.name\nName of the failure criterion.\nTsaiHillCriterion.wf\nWeighting factor of this failure criterion.\nTsaiHillCriterion\nfloat\n1.0\nint\n2\nTsaiHillCriterion.to_dict\nTsaiHillCriterion.to_json\nTsaiHillCriterion.active\nTsaiHillCriterion.dim\nTsaiHillCriterion.name\nTsaiHillCriterion.wf" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.add_results_to_plot", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.add_results_to_plot.html#ansys.dpf.composites.sampling_point.SamplingPoint.add_results_to_plot", + "title": "add_results_to_plot > add_results_to_plot > add_results_to_plot", + "section": "add_results_to_plot > add_results_to_plot", + "text": "SamplingPoint.add_results_to_plot(axes, components, spots=(Spot.BOTTOM, Spot.TOP), core_scale_factor=1.0, title='', xlabel='')\n\nAdd results (strain, stress, or failure values) to an Axes object.\n\nParameters\n\naxes (Any) – Matplotlib Axes object.\n\ncomponents (Sequence[str]) – List of result components. Valid components for\nstrain are \"e1\", \"e2\", \"e3\", \"e12\", \"e13\",\nand \"e23\" Valid components for stress are \"s1\", \"s2\",\n\"s3\", \"s12\", \"s13\", and \"s23\". Valid components\nfor failure are \"inverse_reserve_factor\", \"reserve_factor\",\nand \"margin_of_safety\".\n\nspots (Collection[Spot], default: (, )) – Collection of spots (interfaces).\n\ncore_scale_factor (float, default: 1.0) – Factor for scaling the thickness of core plies.\n\ntitle (str, default: '') – Title of the plot. This parameter is ignored if empty.\n\nxlabel (str, default: '') – Becomes the label of the x-axis. This parameter is ignored if empty.\n\nExamples\n\n>>> import matplotlib.pyplot as plt\n>>> fig, ax1 = plt.subplots()\n>>> sampling_point.add_results_to_plot(ax1,\n [\"s13\", \"s23\", \"s3\"],\n [Spot.BOTTOM, Spot.TOP],\n 0.1, \"Interlaminar Stresses\", \"[MPa]\")\n\nReturn type\n\nNone\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.html#ansys.dpf.composites.failure_criteria.TsaiHillCriterion", - "title": "TsaiHillCriterion > TsaiHillCriterion > TsaiHillCriterion", - "section": "TsaiHillCriterion > TsaiHillCriterion", - "text": "class ansys.dpf.composites.failure_criteria.TsaiHillCriterion(*, active=True, wf=1.0, dim=2)\n\nDefines the Tsai-Hill failure criterion for orthotropic reinforced materials.\n\nParameters\n\nwf (float, default: 1.0) – Weighting factor of this failure criterion.\n\ndim (int, default: 2) – Specifies which formulation of the failure criterion is used.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nTsaiHillCriterion.to_dict()\n\n\n\nTsaiHillCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nTsaiHillCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nTsaiHillCriterion.dim\n\nSpecifies which formulation of the failure criterion is used.\n\nTsaiHillCriterion.name\n\nName of the failure criterion.\n\nTsaiHillCriterion.wf\n\nWeighting factor of this failure criterion.\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.casefold", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.casefold.html#casefold", + "title": "casefold", + "section": "casefold", + "text": "Return a version of the string suitable for caseless comparisons.\ncasefold" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isascii", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isascii.html#isascii", - "title": "isascii", - "section": "isascii", - "text": "Return True if all characters in the string are ASCII, False otherwise.\nASCII characters have code points in the range U+0000-U+007F.\nEmpty string is ASCII too.\nisascii" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.casefold", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.casefold.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.casefold", + "title": "casefold > casefold > casefold", + "section": "casefold > casefold", + "text": "FailureMeasureEnum.casefold(/)\n\nReturn a version of the string suitable for caseless comparisons.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isascii", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isascii.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isascii", - "title": "isascii > isascii > isascii", - "section": "isascii > isascii", - "text": "FailureMeasureEnum.isascii(/)\n\nReturn True if all characters in the string are ASCII, False otherwise.\n\nASCII characters have code points in the range U+0000-U+007F.\nEmpty string is ASCII too.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.composite_files_from_workbench_harmonic_analysis", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.composite_files_from_workbench_harmonic_analysis.html#composite_files_from_workbench_harmonic_analysis", + "title": "composite_files_from_workbench_harmonic_analysis", + "section": "composite_files_from_workbench_harmonic_analysis", + "text": "Get a ContinuousFiberCompositesFiles object for a harmonic analysis.\nresult_folder_modal (str) – Result folder of the Modal solution.\nIn the Modal system, right-click the solution item in the Ansys Mechanical tree\nand select Open Solver Files Directory to obtain the result folder.\nresult_folder_harmonic (str) – Result folder of the Harmonic Response solution.\nIn the Harmonic Response system,\nright-click the solution item in the Ansys Mechanical tree\nand select Open Solver Files Directory to obtain the result folder.\nContinuousFiberCompositesFiles\ncomposite_files_from_workbench_harmonic_analysis\nContinuousFiberCompositesFiles\nContinuousFiberCompositesFiles" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR32", - "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR32.html#tensor32", - "title": "TENSOR32", - "section": "TENSOR32", - "text": "TENSOR32" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.composite_files_from_workbench_harmonic_analysis", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.composite_files_from_workbench_harmonic_analysis.html#ansys.dpf.composites.data_sources.composite_files_from_workbench_harmonic_analysis", + "title": "composite_files_from_workbench_harmonic_analysis > composite_files_from_workbench_harmonic_analysis > composite_files_from_workbench_harmonic_analysis", + "section": "composite_files_from_workbench_harmonic_analysis > composite_files_from_workbench_harmonic_analysis", + "text": "ansys.dpf.composites.data_sources.composite_files_from_workbench_harmonic_analysis(result_folder_modal, result_folder_harmonic)\n\nGet a ContinuousFiberCompositesFiles object for a harmonic analysis.\n\nParameters\n\nresult_folder_modal (str) – Result folder of the Modal solution.\nIn the Modal system, right-click the solution item in the Ansys Mechanical tree\nand select Open Solver Files Directory to obtain the result folder.\n\nresult_folder_harmonic (str) – Result folder of the Harmonic Response solution.\nIn the Harmonic Response system,\nright-click the solution item in the Ansys Mechanical tree\nand select Open Solver Files Directory to obtain the result folder.\n\nReturn type\n\nContinuousFiberCompositesFiles\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR32", - "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR32.html#ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR32", - "title": "TENSOR32 > TENSOR32 > TENSOR32", - "section": "TENSOR32 > TENSOR32", - "text": "Sym3x3TensorComponent.TENSOR32 = 4\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.html#hoffmancriterion", + "title": "HoffmanCriterion", + "section": "HoffmanCriterion", + "text": "Defines the Hoffman failure criterion for orthotropic reinforced materials.\nwf (float, default: 1.0) – Weighting factor of this failure criterion.\ndim (int, default: 2) – Specifies which formulation of the failure criterion is used.\nHoffmanCriterion.to_dict()\n\nHoffmanCriterion.to_json()\n\nHoffmanCriterion.active\nThe failure criterion is suppressed if active is False.\nHoffmanCriterion.dim\nSpecifies which formulation of the failure criterion is used.\nHoffmanCriterion.name\nName of the failure criterion.\nHoffmanCriterion.wf\nWeighting factor of this failure criterion.\nHoffmanCriterion\nfloat\n1.0\nint\n2\nHoffmanCriterion.to_dict\nHoffmanCriterion.to_json\nHoffmanCriterion.active\nHoffmanCriterion.dim\nHoffmanCriterion.name\nHoffmanCriterion.wf" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.eval_ins", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.eval_ins.html#eval_ins", - "title": "eval_ins", - "section": "eval_ins", - "text": "Whether to consider interlaminar normal stresses (s3) and compute them for layered shells.\nbool\neval_ins\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.html#ansys.dpf.composites.failure_criteria.HoffmanCriterion", + "title": "HoffmanCriterion > HoffmanCriterion > HoffmanCriterion", + "section": "HoffmanCriterion > HoffmanCriterion", + "text": "class ansys.dpf.composites.failure_criteria.HoffmanCriterion(*, active=True, wf=1.0, dim=2)\n\nDefines the Hoffman failure criterion for orthotropic reinforced materials.\n\nParameters\n\nwf (float, default: 1.0) – Weighting factor of this failure criterion.\n\ndim (int, default: 2) – Specifies which formulation of the failure criterion is used.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nHoffmanCriterion.to_dict()\n\n\n\nHoffmanCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nHoffmanCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nHoffmanCriterion.dim\n\nSpecifies which formulation of the failure criterion is used.\n\nHoffmanCriterion.name\n\nName of the failure criterion.\n\nHoffmanCriterion.wf\n\nWeighting factor of this failure criterion.\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.eval_ins", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.eval_ins.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.eval_ins", - "title": "eval_ins > eval_ins > eval_ins", - "section": "eval_ins > eval_ins", - "text": "property VonMisesCriterion.eval_ins: bool\n\nWhether to consider interlaminar normal stresses (s3) and compute them for layered shells.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/007_interlaminar_normal_stress_example", + "href": "examples/gallery_examples/007_interlaminar_normal_stress_example.html#interlaminar-normal-stresses", + "title": "Interlaminar normal stresses", + "section": "Interlaminar normal stresses", + "text": "This example shows how to enrich the stresses of layered shells by\ncomputing interlaminar normal stresses. Interlaminar normal\nstresses can be important in thick and curved laminates.\nBecause interlaminar normal stresses are typically not available\nfor layered shell elements, the INS operator is used to recompute\nthe s3 result based on the laminate strains, the geometrical\ncurvature, and the lay-up.\nFor simple use cases, using the composite failure operator or\ncomposite sampling point operator is preferable. For examples,\nsee sphx_glr_examples_gallery_examples_001_failure_operator_example.py\nand sphx_glr_examples_gallery_examples_002_sampling_point_example.py.\nIn these workflows, interlaminar normal stresses are computed automatically\nif required, such as if a 3D failure criterion is activated. Additionally,\nsphx_glr_examples_gallery_examples_006_filter_composite_data_example.py\nshows how helper functions can be used to obtain composite result data.\nWhen using a Workbench project,\nuse the composite_files_from_workbench_harmonic_analysis()\nmethod to obtain the input files.\nInterlaminar normal stresses\nINS\ns3\ncomposite_files_from_workbench_harmonic_analysis()" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.name.html#name", - "title": "name", - "section": "name", - "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" + "objectID": "examples/gallery_examples/007_interlaminar_normal_stress_example", + "href": "examples/gallery_examples/007_interlaminar_normal_stress_example.html#set-up-analysis", + "title": "Interlaminar normal stresses > Set up analysis", + "section": "Set up analysis", + "text": "Setting up the analysis consists of loading Ansys libraries, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries.\nStart a DPF server and copy the example files into the current working directory.\nSet up analysis" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.name.html#ansys.dpf.composites.failure_criteria.HashinCriterion.name", - "title": "name > name > name", - "section": "name > name", - "text": "property HashinCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/007_interlaminar_normal_stress_example", + "href": "examples/gallery_examples/007_interlaminar_normal_stress_example.html#set-up-model-and-prepare-inputs", + "title": "Interlaminar normal stresses > Set up model and prepare inputs", + "section": "Set up model and prepare inputs", + "text": "Set up the composite model.\nPrepare the inputs for the INS operator.\nrotate_to_global is False because the postprocessing engine expects\nthe results to be in the element coordinate system (material coordinate system).\nSet up model and prepare inputs\nrotate_to_global\nFalse" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s1", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s1.html#wf_s1", - "title": "wf_s1", - "section": "wf_s1", - "text": "Weighting factor of the failure mode s1.\nfloat\nwf_s1\nfloat" + "objectID": "examples/gallery_examples/007_interlaminar_normal_stress_example", + "href": "examples/gallery_examples/007_interlaminar_normal_stress_example.html#compute-interlaminar-normal-stresses", + "title": "Interlaminar normal stresses > Compute interlaminar normal stresses", + "section": "Compute interlaminar normal stresses", + "text": "Compute the interlaminar normal stresses.\nThe INS operator stores the stresses in the provided stress field.\nCompute interlaminar normal stresses\nINS" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s1", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s1.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s1", - "title": "wf_s1 > wf_s1 > wf_s1", - "section": "wf_s1 > wf_s1", - "text": "property MaxStressCriterion.wf_s1: float\n\nWeighting factor of the failure mode s1.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/007_interlaminar_normal_stress_example", + "href": "examples/gallery_examples/007_interlaminar_normal_stress_example.html#plot-s3-stresses", + "title": "Interlaminar normal stresses > Plot s3 stresses", + "section": "Plot s3 stresses", + "text": "Get the first stress field.\nPlot the maximum s3 of each element.\nPlot s3 at the mid-plane of a certain ply.\nTotal running time of the script: (0 minutes 7.360 seconds)\nDownload Jupyter notebook: 007_interlaminar_normal_stress_example.ipynb\nDownload Python source code: 007_interlaminar_normal_stress_example.py\nDownload zipped: 007_interlaminar_normal_stress_example.zip\nGallery generated by Sphinx-Gallery\nPlot s3 stresses\nDownload Jupyter notebook: 007_interlaminar_normal_stress_example.ipynb\nDownload Python source code: 007_interlaminar_normal_stress_example.py\nDownload zipped: 007_interlaminar_normal_stress_example.zip" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ho", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ho.html#ho", - "title": "ho", - "section": "ho", - "text": "ho" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_json.html#to_json", + "title": "to_json", + "section": "to_json", + "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ho", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ho.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.ho", - "title": "ho > ho > ho", - "section": "ho > ho", - "text": "FailureModeEnum.ho = 700\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_json.html#ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_json", + "title": "to_json > to_json > to_json", + "section": "to_json > to_json", + "text": "HoffmanCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.html#cuntzecriterion", - "title": "CuntzeCriterion", - "section": "CuntzeCriterion", - "text": "Defines the Cuntze criterion for uni-directional orthotropic reinforced materials.\ncfc (bool, default: True) – Activates the failure evaluation regarding compression in fiber direction.\ncft (bool, default: True) – Activates the failure evaluation regarding tension in fiber direction.\ncma (bool, default: True) – Activates the failure evaluation of the matrix due to tension.\ncmb (bool, default: True) – Activates the failure evaluation of the matrix due to compression.\ncmc (bool, default: True) – Activates the failure evaluation of the matrix due to compression or shear.\ndim (int, default: 2) – Whether the 2D or 3D formulation of the criterion is used.\nwf_cfc (float, default: 1.0) – Weighting factor of fiber failure due to compression (cfc).\nwf_cft (float, default: 1.0) – Weighting factor of fiber failure due to tension (cft).\nwf_cma (float, default: 1.0) – Weighting factor of matrix failure due to tension (cma).\nwf_cmb (float, default: 1.0) – Weighting factor of matrix failure due to compression (cmb).\nwf_cmc (float, default: 1.0) – Weighting factor of matrix failure due to compression or shear (cmc).\nb21 (float, default: 0.2) – In-plane shear friction coefficient. The default is 0.2.\nb32 (float, default: 1.3805) – Out-of-plane shear friction coefficient. The default is 1.3805. The value depends on the fracture plane angle.\nfracture_plane_angle (float, default: 53.0) – Fracture plane angle in degrees. The default is 53. The value must be greater than 45. The value depends on the out-of-plane shear friction coefficient.\nmode_interaction_coeff (float, default: 2.6) – Mode interaction coefficient. The default is 2.6.\nCuntzeCriterion.to_dict()\n\nCuntzeCriterion.to_json()\n\nCuntzeCriterion.active\nThe failure criterion is suppressed if active is False.\nCuntzeCriterion.b21\nIn-plane shear friction coefficient.\nCuntzeCriterion.b32\nOut-of-plane shear friction coefficient.\nCuntzeCriterion.cfc\nActivates the failure evaluation regarding compression in fiber direction.\nCuntzeCriterion.cft\nActivates the failure evaluation regarding tension in fiber direction.\nCuntzeCriterion.cma\nActivates the failure evaluation of the matrix due to tension.\nCuntzeCriterion.cmb\nActivates the failure evaluation of the matrix due to compression.\nCuntzeCriterion.cmc\nActivates the failure evaluation of the matrix due to compression or shear.\nCuntzeCriterion.dim\nWhether the 2D or 3D formulation of the criterion is used.\nCuntzeCriterion.fracture_plane_angle\nFracture plane angle in degrees.\nCuntzeCriterion.mode_interaction_coeff\nMode interaction coefficient.\nCuntzeCriterion.name\nName of the failure criterion.\nCuntzeCriterion.wf_cfc\nWeighting factor of fiber failure due to compression (cfc).\nCuntzeCriterion.wf_cft\nWeighting factor of fiber failure due to tension (cft).\nCuntzeCriterion.wf_cma\nWeighting factor of matrix failure due to tension (cma).\nCuntzeCriterion.wf_cmb\nWeighting factor of matrix failure due to compression (cmb).\nCuntzeCriterion.wf_cmc\nWeighting factor of matrix failure due to compression or shear (cmc).\nCuntzeCriterion\nbool\nTrue\nbool\nTrue\nbool\nTrue\nbool\nTrue\nbool\nTrue\nint\n2\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n0.2\n0.2\nfloat\n1.3805\n1.3805\nfloat\n53.0\n53\nfloat\n2.6\n2.6\nCuntzeCriterion.to_dict\nCuntzeCriterion.to_json\nCuntzeCriterion.active\nCuntzeCriterion.b21\nCuntzeCriterion.b32\nCuntzeCriterion.cfc\nCuntzeCriterion.cft\nCuntzeCriterion.cma\nCuntzeCriterion.cmb\nCuntzeCriterion.cmc\nCuntzeCriterion.dim\nCuntzeCriterion.fracture_plane_angle\nCuntzeCriterion.mode_interaction_coeff\nCuntzeCriterion.name\nCuntzeCriterion.wf_cfc\nCuntzeCriterion.wf_cft\nCuntzeCriterion.wf_cma\nCuntzeCriterion.wf_cmb\nCuntzeCriterion.wf_cmc" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lft3", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lft3.html#lft3", + "title": "lft3", + "section": "lft3", + "text": "lft3" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion", - "title": "CuntzeCriterion > CuntzeCriterion > CuntzeCriterion", - "section": "CuntzeCriterion > CuntzeCriterion", - "text": "class ansys.dpf.composites.failure_criteria.CuntzeCriterion(*, cfc=True, cft=True, cma=True, cmb=True, cmc=True, dim=2, wf_cfc=1.0, wf_cft=1.0, wf_cma=1.0, wf_cmb=1.0, wf_cmc=1.0, b21=0.2, b32=1.3805, fracture_plane_angle=53.0, mode_interaction_coeff=2.6)\n\nDefines the Cuntze criterion for uni-directional orthotropic reinforced materials.\n\nParameters\n\ncfc (bool, default: True) – Activates the failure evaluation regarding compression in fiber direction.\n\ncft (bool, default: True) – Activates the failure evaluation regarding tension in fiber direction.\n\ncma (bool, default: True) – Activates the failure evaluation of the matrix due to tension.\n\ncmb (bool, default: True) – Activates the failure evaluation of the matrix due to compression.\n\ncmc (bool, default: True) – Activates the failure evaluation of the matrix due to compression or shear.\n\ndim (int, default: 2) – Whether the 2D or 3D formulation of the criterion is used.\n\nwf_cfc (float, default: 1.0) – Weighting factor of fiber failure due to compression (cfc).\n\nwf_cft (float, default: 1.0) – Weighting factor of fiber failure due to tension (cft).\n\nwf_cma (float, default: 1.0) – Weighting factor of matrix failure due to tension (cma).\n\nwf_cmb (float, default: 1.0) – Weighting factor of matrix failure due to compression (cmb).\n\nwf_cmc (float, default: 1.0) – Weighting factor of matrix failure due to compression or shear (cmc).\n\nb21 (float, default: 0.2) – In-plane shear friction coefficient. The default is 0.2.\n\nb32 (float, default: 1.3805) – Out-of-plane shear friction coefficient. The default is 1.3805. The value depends on the fracture plane angle.\n\nfracture_plane_angle (float, default: 53.0) – Fracture plane angle in degrees. The default is 53. The value must be greater than 45. The value depends on the out-of-plane shear friction coefficient.\n\nmode_interaction_coeff (float, default: 2.6) – Mode interaction coefficient. The default is 2.6.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nCuntzeCriterion.to_dict()\n\n\n\nCuntzeCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nCuntzeCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nCuntzeCriterion.b21\n\nIn-plane shear friction coefficient.\n\nCuntzeCriterion.b32\n\nOut-of-plane shear friction coefficient.\n\nCuntzeCriterion.cfc\n\nActivates the failure evaluation regarding compression in fiber direction.\n\nCuntzeCriterion.cft\n\nActivates the failure evaluation regarding tension in fiber direction.\n\nCuntzeCriterion.cma\n\nActivates the failure evaluation of the matrix due to tension.\n\nCuntzeCriterion.cmb\n\nActivates the failure evaluation of the matrix due to compression.\n\nCuntzeCriterion.cmc\n\nActivates the failure evaluation of the matrix due to compression or shear.\n\nCuntzeCriterion.dim\n\nWhether the 2D or 3D formulation of the criterion is used.\n\nCuntzeCriterion.fracture_plane_angle\n\nFracture plane angle in degrees.\n\nCuntzeCriterion.mode_interaction_coeff\n\nMode interaction coefficient.\n\nCuntzeCriterion.name\n\nName of the failure criterion.\n\nCuntzeCriterion.wf_cfc\n\nWeighting factor of fiber failure due to compression (cfc).\n\nCuntzeCriterion.wf_cft\n\nWeighting factor of fiber failure due to tension (cft).\n\nCuntzeCriterion.wf_cma\n\nWeighting factor of matrix failure due to tension (cma).\n\nCuntzeCriterion.wf_cmb\n\nWeighting factor of matrix failure due to compression (cmb).\n\nCuntzeCriterion.wf_cmc\n\nWeighting factor of matrix failure due to compression or shear (cmc).\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lft3", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lft3.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.lft3", + "title": "lft3 > lft3 > lft3", + "section": "lft3 > lft3", + "text": "FailureModeEnum.lft3 = 901\n\n" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.html#tsaiwucriterion", + "title": "TsaiWuCriterion", + "section": "TsaiWuCriterion", + "text": "Defines the Tsai-Wu failure criterion for orthotropic reinforced materials.\nwf (float, default: 1.0) – Weighting factor of this failure criterion.\ndim (int, default: 2) – Specifies which formulation of the failure criterion is used.\nTsaiWuCriterion.to_dict()\n\nTsaiWuCriterion.to_json()\n\nTsaiWuCriterion.active\nThe failure criterion is suppressed if active is False.\nTsaiWuCriterion.dim\nSpecifies which formulation of the failure criterion is used.\nTsaiWuCriterion.name\nName of the failure criterion.\nTsaiWuCriterion.wf\nWeighting factor of this failure criterion.\nTsaiWuCriterion\nfloat\n1.0\nint\n2\nTsaiWuCriterion.to_dict\nTsaiWuCriterion.to_json\nTsaiWuCriterion.active\nTsaiWuCriterion.dim\nTsaiWuCriterion.name\nTsaiWuCriterion.wf" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e2", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e2.html#wf_e2", - "title": "wf_e2", - "section": "wf_e2", - "text": "Weighting factor of the failure mode e2.\nfloat\nwf_e2\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.html#ansys.dpf.composites.failure_criteria.TsaiWuCriterion", + "title": "TsaiWuCriterion > TsaiWuCriterion > TsaiWuCriterion", + "section": "TsaiWuCriterion > TsaiWuCriterion", + "text": "class ansys.dpf.composites.failure_criteria.TsaiWuCriterion(*, active=True, wf=1.0, dim=2)\n\nDefines the Tsai-Wu failure criterion for orthotropic reinforced materials.\n\nParameters\n\nwf (float, default: 1.0) – Weighting factor of this failure criterion.\n\ndim (int, default: 2) – Specifies which formulation of the failure criterion is used.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nTsaiWuCriterion.to_dict()\n\n\n\nTsaiWuCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nTsaiWuCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nTsaiWuCriterion.dim\n\nSpecifies which formulation of the failure criterion is used.\n\nTsaiWuCriterion.name\n\nName of the failure criterion.\n\nTsaiWuCriterion.wf\n\nWeighting factor of this failure criterion.\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e2", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e2.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e2", - "title": "wf_e2 > wf_e2 > wf_e2", - "section": "wf_e2 > wf_e2", - "text": "property MaxStrainCriterion.wf_e2: float\n\nWeighting factor of the failure mode e2.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isspace", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isspace.html#isspace", + "title": "isspace", + "section": "isspace", + "text": "Return True if the string is a whitespace string, False otherwise.\nA string is whitespace if all characters in the string are whitespace and there\nis at least one character in the string.\nisspace" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids.html#get_all_layered_element_ids", - "title": "get_all_layered_element_ids", - "section": "get_all_layered_element_ids", - "text": "Get all element IDs with lay-up data.\nSequence[int]\nget_all_layered_element_ids\nSequence\nint" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isspace", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isspace.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isspace", + "title": "isspace > isspace > isspace", + "section": "isspace > isspace", + "text": "FailureMeasureEnum.isspace(/)\n\nReturn True if the string is a whitespace string, False otherwise.\n\nA string is whitespace if all characters in the string are whitespace and there\nis at least one character in the string.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids.html#ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids", - "title": "get_all_layered_element_ids > get_all_layered_element_ids > get_all_layered_element_ids", - "section": "get_all_layered_element_ids > get_all_layered_element_ids", - "text": "CompositeModel.get_all_layered_element_ids()\n\nGet all element IDs with lay-up data.\n\nReturn type\n\nSequence[int]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.as", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.as.html#as", + "title": "as", + "section": "as", + "text": "as" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.THICKNESS", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.THICKNESS.html#thickness", - "title": "THICKNESS", - "section": "THICKNESS", - "text": "THICKNESS" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.as", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.as.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.as", + "title": "as > as > as", + "section": "as > as", + "text": "FailureModeEnum.as = 1201\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.THICKNESS", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.THICKNESS.html#ansys.dpf.composites.layup_info.LayupProperty.THICKNESS", - "title": "THICKNESS > THICKNESS > THICKNESS", - "section": "THICKNESS > THICKNESS", - "text": "LayupProperty.THICKNESS = 2\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmb", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmb.html#wf_cmb", + "title": "wf_cmb", + "section": "wf_cmb", + "text": "Weighting factor of matrix failure due to compression (cmb).\nfloat\nwf_cmb\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.MARGIN_OF_SAFETY", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.MARGIN_OF_SAFETY.html#margin_of_safety", - "title": "MARGIN_OF_SAFETY", - "section": "MARGIN_OF_SAFETY", - "text": "MARGIN_OF_SAFETY" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmb", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmb.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmb", + "title": "wf_cmb > wf_cmb > wf_cmb", + "section": "wf_cmb > wf_cmb", + "text": "property CuntzeCriterion.wf_cmb: float\n\nWeighting factor of matrix failure due to compression (cmb).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.MARGIN_OF_SAFETY", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.MARGIN_OF_SAFETY.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.MARGIN_OF_SAFETY", - "title": "MARGIN_OF_SAFETY > MARGIN_OF_SAFETY > MARGIN_OF_SAFETY", - "section": "MARGIN_OF_SAFETY > MARGIN_OF_SAFETY", - "text": "FailureMeasureEnum.MARGIN_OF_SAFETY: str = 'safety_margin'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.mapping_file", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.mapping_file.html#mapping_file", + "title": "mapping_file", + "section": "mapping_file", + "text": "Path to the mapping file for all element labels in the element scope.\nmapping_file" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.is_shell", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.is_shell.html#is_shell", - "title": "is_shell", - "section": "is_shell", - "text": "is_shell" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.mapping_file", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.mapping_file.html#ansys.dpf.composites.result_definition.ResultDefinitionScope.mapping_file", + "title": "mapping_file > mapping_file > mapping_file", + "section": "mapping_file > mapping_file", + "text": "ResultDefinitionScope.mapping_file: str | PathLike[str] | None = None\n\nPath to the mapping file for all element labels in the element scope.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.is_shell", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.is_shell.html#ansys.dpf.composites.layup_info.ElementInfo.is_shell", - "title": "is_shell > is_shell > is_shell", - "section": "is_shell > is_shell", - "text": "ElementInfo.is_shell: bool\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.wt", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.wt.html#wt", + "title": "wt", + "section": "wt", + "text": "wt" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.SHEAR_ANGLES", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.SHEAR_ANGLES.html#shear_angles", - "title": "SHEAR_ANGLES", - "section": "SHEAR_ANGLES", - "text": "SHEAR_ANGLES" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.wt", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.wt.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.wt", + "title": "wt > wt > wt", + "section": "wt > wt", + "text": "FailureModeEnum.wt = 322\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.SHEAR_ANGLES", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.SHEAR_ANGLES.html#ansys.dpf.composites.layup_info.LayerProperty.SHEAR_ANGLES", - "title": "SHEAR_ANGLES > SHEAR_ANGLES > SHEAR_ANGLES", - "section": "SHEAR_ANGLES > SHEAR_ANGLES", - "text": "LayerProperty.SHEAR_ANGLES = 2\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2.html#e2", + "title": "e2", + "section": "e2", + "text": "e2" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy", - "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.html#spotreductionstrategy", - "title": "SpotReductionStrategy", - "section": "SpotReductionStrategy", - "text": "Provides the strategy for getting from spot values (BOT, MID, TOP) to a single value.\nSpotReductionStrategy.MIN\n\nSpotReductionStrategy.MAX\n\nSpotReductionStrategy.AVG\n\nSpotReductionStrategy.BOT\n\nSpotReductionStrategy.MID\n\nSpotReductionStrategy.TOP\n\nSpotReductionStrategy\nSpotReductionStrategy.MIN\nSpotReductionStrategy.MAX\nSpotReductionStrategy.AVG\nSpotReductionStrategy.BOT\nSpotReductionStrategy.MID\nSpotReductionStrategy.TOP" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e2", + "title": "e2 > e2 > e2", + "section": "e2 > e2", + "text": "FailureModeEnum.e2 = 120\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy", - "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.html#ansys.dpf.composites.ply_wise_data.SpotReductionStrategy", - "title": "SpotReductionStrategy > SpotReductionStrategy > SpotReductionStrategy", - "section": "SpotReductionStrategy > SpotReductionStrategy", - "text": "class ansys.dpf.composites.ply_wise_data.SpotReductionStrategy(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nProvides the strategy for getting from spot values (BOT, MID, TOP) to a single value.\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nSpotReductionStrategy.MIN\n\n\n\nSpotReductionStrategy.MAX\n\n\n\nSpotReductionStrategy.AVG\n\n\n\nSpotReductionStrategy.BOT\n\n\n\nSpotReductionStrategy.MID\n\n\n\nSpotReductionStrategy.TOP\n\n\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.analysis_plies", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.analysis_plies.html#analysis_plies", + "title": "analysis_plies", + "section": "analysis_plies", + "text": "List of analysis plies from the bottom to the top.\nThis attribute returns a list of ply data, such as angle, thickness and material name,\nas a dictionary.\nSequence[Any]\nanalysis_plies\nSequence\nAny" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.html#layupproperty", - "title": "LayupProperty", - "section": "LayupProperty", - "text": "Enum for lay-up properties.\nValues correspond to labels in the output container of the lay-up provider.\nLayupProperty.ANGLE\n\nLayupProperty.SHEAR_ANGLE\n\nLayupProperty.THICKNESS\n\nLayupProperty.LAMINATE_OFFSET\n\nLayupProperty\nLayupProperty.ANGLE\nLayupProperty.SHEAR_ANGLE\nLayupProperty.THICKNESS\nLayupProperty.LAMINATE_OFFSET" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.analysis_plies", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.analysis_plies.html#ansys.dpf.composites.sampling_point.SamplingPoint.analysis_plies", + "title": "analysis_plies > analysis_plies > analysis_plies", + "section": "analysis_plies > analysis_plies", + "text": "property SamplingPoint.analysis_plies: Sequence[Any]\n\nList of analysis plies from the bottom to the top.\n\nThis attribute returns a list of ply data, such as angle, thickness and material name,\nas a dictionary.\n\nReturn type\n\nSequence[Any]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.html#ansys.dpf.composites.layup_info.LayupProperty", - "title": "LayupProperty > LayupProperty > LayupProperty", - "section": "LayupProperty > LayupProperty", - "text": "class ansys.dpf.composites.layup_info.LayupProperty(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nEnum for lay-up properties.\n\nValues correspond to labels in the output container of the lay-up provider.\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nLayupProperty.ANGLE\n\n\n\nLayupProperty.SHEAR_ANGLE\n\n\n\nLayupProperty.THICKNESS\n\n\n\nLayupProperty.LAMINATE_OFFSET\n\n\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hd", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hd.html#hd", + "title": "hd", + "section": "hd", + "text": "Whether to activate the failure evaluation regarding delamination if dim is equal to 3.\nbool\nhd\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.margin_of_safety", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.margin_of_safety.html#margin_of_safety", - "title": "margin_of_safety", - "section": "margin_of_safety", - "text": "Lowest margin of safety of each ply.\nThis attribute is equivalent to the safety margin.\nndarray[Any, dtype[float64]]\nmargin_of_safety\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hd", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hd.html#ansys.dpf.composites.failure_criteria.HashinCriterion.hd", + "title": "hd > hd > hd", + "section": "hd > hd", + "text": "property HashinCriterion.hd: bool\n\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.margin_of_safety", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.margin_of_safety.html#ansys.dpf.composites.sampling_point.SamplingPoint.margin_of_safety", - "title": "margin_of_safety > margin_of_safety > margin_of_safety", - "section": "margin_of_safety > margin_of_safety", - "text": "property SamplingPoint.margin_of_safety: ndarray[Any, dtype[float64]]\n\nLowest margin of safety of each ply.\n\nThis attribute is equivalent to the safety margin.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hf.html#hf", + "title": "hf", + "section": "hf", + "text": "hf" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.name.html#name", - "title": "name", - "section": "name", - "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hf.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.hf", + "title": "hf > hf > hf", + "section": "hf > hf", + "text": "FailureModeEnum.hf = 601\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.name.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.name", - "title": "name > name > name", - "section": "name > name", - "text": "property MaxStressCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_2", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_2.html#larc_constants_fracture_toughness_mode_2", + "title": "Larc_Constants_fracture_toughness_mode_2", + "section": "Larc_Constants_fracture_toughness_mode_2", + "text": "Larc_Constants_fracture_toughness_mode_2" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.html#shortfibercompositesfiles", - "title": "ShortFiberCompositesFiles", - "section": "ShortFiberCompositesFiles", - "text": "Provides the container for short fiber composite file paths.\nShortFiberCompositesFiles.files_are_local\n\nShortFiberCompositesFiles.rst\n\nShortFiberCompositesFiles.dsdat\n\nShortFiberCompositesFiles.engineering_data\n\nShortFiberCompositesFiles\nShortFiberCompositesFiles.files_are_local\nShortFiberCompositesFiles.rst\nShortFiberCompositesFiles.dsdat\nShortFiberCompositesFiles.engineering_data" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_2", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_2.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_2", + "title": "Larc_Constants_fracture_toughness_mode_2 > Larc_Constants_fracture_toughness_mode_2 > Larc_Constants_fracture_toughness_mode_2", + "section": "Larc_Constants_fracture_toughness_mode_2 > Larc_Constants_fracture_toughness_mode_2", + "text": "MaterialProperty.Larc_Constants_fracture_toughness_mode_2: str = 'transverse_friction_coefficient_larc_constants'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.html#ansys.dpf.composites.data_sources.ShortFiberCompositesFiles", - "title": "ShortFiberCompositesFiles > ShortFiberCompositesFiles > ShortFiberCompositesFiles", - "section": "ShortFiberCompositesFiles > ShortFiberCompositesFiles", - "text": "class ansys.dpf.composites.data_sources.ShortFiberCompositesFiles(rst, dsdat, engineering_data, files_are_local=True)\n\nProvides the container for short fiber composite file paths.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nShortFiberCompositesFiles.files_are_local\n\n\n\nShortFiberCompositesFiles.rst\n\n\n\nShortFiberCompositesFiles.dsdat\n\n\n\nShortFiberCompositesFiles.engineering_data\n\n\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_all_dpf_material_ids", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_all_dpf_material_ids.html#get_all_dpf_material_ids", + "title": "get_all_dpf_material_ids", + "section": "get_all_dpf_material_ids", + "text": "Get all DPF material IDs.\nmesh (MeshedRegion) – DPF meshed region enriched with lay-up information.\ndata_source_or_streams_provider (DataSources | Operator) – DPF data source or stream provider that contains the RST file.\nCollection[int64]\nget_all_dpf_material_ids\nMeshedRegion\nDataSources\nOperator\nCollection\nint64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.dim", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.dim.html#dim", - "title": "dim", - "section": "dim", - "text": "Whether the 2D or 3D formulation of the criterion is used. The latter one also supports the failure mode delamination. Use 1 for a simplified Puck criterion.\nint\ndim\n1\nint" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_all_dpf_material_ids", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_all_dpf_material_ids.html#ansys.dpf.composites.layup_info.material_properties.get_all_dpf_material_ids", + "title": "get_all_dpf_material_ids > get_all_dpf_material_ids > get_all_dpf_material_ids", + "section": "get_all_dpf_material_ids > get_all_dpf_material_ids", + "text": "ansys.dpf.composites.layup_info.material_properties.get_all_dpf_material_ids(mesh, data_source_or_streams_provider)\n\nGet all DPF material IDs.\n\nParameters\n\nmesh (MeshedRegion) – DPF meshed region enriched with lay-up information.\n\ndata_source_or_streams_provider (DataSources | Operator) – DPF data source or stream provider that contains the RST file.\n\nReturn type\n\nCollection[int64]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.dim", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.dim.html#ansys.dpf.composites.failure_criteria.PuckCriterion.dim", - "title": "dim > dim > dim", - "section": "dim > dim", - "text": "property PuckCriterion.dim: int\n\nWhether the 2D or 3D formulation of the criterion is used. The latter one also supports the failure mode delamination. Use 1 for a simplified Puck criterion.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s13", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s13.html#s13", + "title": "s13", + "section": "s13", + "text": "Out-of-plane shear stresses s13 of each ply.\nndarray[Any, dtype[float64]]\ns13\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/index", - "href": "api/index.html#api-reference", - "title": "API reference", - "section": "API reference", - "text": "This section describes the public classes, methods, and attributes of the PyDPF - Composites API.\nFor in-depth documentation on the different failure criteria, refer to the ACP help.\nAPI reference" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s13", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s13.html#ansys.dpf.composites.sampling_point.SamplingPoint.s13", + "title": "s13 > s13 > s13", + "section": "s13 > s13", + "text": "property SamplingPoint.s13: ndarray[Any, dtype[float64]]\n\nOut-of-plane shear stresses s13 of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s23", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s23.html#s23", + "title": "s23", + "section": "s23", + "text": "s23" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.rst", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.rst.html#rst", - "title": "rst", - "section": "rst", - "text": "rst" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s23", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s23.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s23", + "title": "s23 > s23 > s23", + "section": "s23 > s23", + "text": "FailureModeEnum.s23 = 260\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.rst", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.rst.html#ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.rst", - "title": "rst > rst > rst", - "section": "rst > rst", - "text": "ShortFiberCompositesFiles.rst: list[str | PathLike[str]]\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmb", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmb.html#wf_pmb", + "title": "wf_pmb", + "section": "wf_pmb", + "text": "Weighting factor of the matrix failure (pmb) mode.\nfloat\nwf_pmb\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.emax", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.emax.html#emax", - "title": "emax", - "section": "emax", - "text": "emax" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmb", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmb.html#ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmb", + "title": "wf_pmb > wf_pmb > wf_pmb", + "section": "wf_pmb > wf_pmb", + "text": "property PuckCriterion.wf_pmb: float\n\nWeighting factor of the matrix failure (pmb) mode.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.emax", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.emax.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.emax", - "title": "emax > emax > emax", - "section": "emax > emax", - "text": "FailureModeEnum.emax = 101\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.html#maxstraincriterion", + "title": "MaxStrainCriterion", + "section": "MaxStrainCriterion", + "text": "Defines the maximum strain failure criterion for orthotropic reinforced materials.\ne1 (bool, default: True) – Activates the failure evaluation regarding the strain in the material 1 direction.\ne2 (bool, default: True) – Activates the failure evaluation regarding the strain in the material 2 direction.\ne3 (bool, default: False) – Activates the failure evaluation regarding the strain in the material 3 direction (out-of-plane).\ne12 (bool, default: True) – Whether to activate the failure evaluation regarding the in-plane shear strain e12.\ne13 (bool, default: False) – Whether to activate the failure evaluation regarding the interlaminar shear strain e13.\ne23 (bool, default: False) – Whether to activate the failure evaluation regarding the interlaminar shear strain e23.\nwf_e1 (float, default: 1.0) – Weighting factor of the failure mode e1.\nwf_e2 (float, default: 1.0) – Weighting factor of the failure mode e2.\nwf_e3 (float, default: 1.0) – Weighting factor of the failure mode e3.\nwf_e12 (float, default: 1.0) – Weighting factor of the failure mode e12.\nwf_e13 (float, default: 1.0) – Weighting factor of the failure mode e13.\nwf_e23 (float, default: 1.0) – Weighting factor of the failure mode e23.\neXt (float, default: 0.0) – Global tensile strain limit in material direction 1.\neXc (float, default: 0.0) – Global compressive strain limit in material direction 1.\neYt (float, default: 0.0) – Global tensile strain limit in material direction 2.\neYc (float, default: 0.0) – Global compressive strain limit in material direction 2.\neZt (float, default: 0.0) – Global strain limit in material direction 3.\neZc (float, default: 0.0) – Global compressive strain limit in material direction 3.\neSxy (float, default: 0.0) – Global strain limit in material direction 12.\neSxz (float, default: 0.0) – Global strain limit in material direction 13.\neSyz (float, default: 0.0) – Global strain limit in material direction 23.\nMaxStrainCriterion.to_dict()\n\nMaxStrainCriterion.to_json()\n\nMaxStrainCriterion.active\nThe failure criterion is suppressed if active is False.\nMaxStrainCriterion.e1\nActivates the failure evaluation regarding the strain in the material 1 direction.\nMaxStrainCriterion.e12\nWhether to activate the failure evaluation regarding the in-plane shear strain e12.\nMaxStrainCriterion.e13\nWhether to activate the failure evaluation regarding the interlaminar shear strain e13.\nMaxStrainCriterion.e2\nActivates the failure evaluation regarding the strain in the material 2 direction.\nMaxStrainCriterion.e23\nWhether to activate the failure evaluation regarding the interlaminar shear strain e23.\nMaxStrainCriterion.e3\nActivates the failure evaluation regarding the strain in the material 3 direction (out-of-plane).\nMaxStrainCriterion.eSxy\nGlobal strain limit in material direction 12.\nMaxStrainCriterion.eSxz\nGlobal strain limit in material direction 13.\nMaxStrainCriterion.eSyz\nGlobal strain limit in material direction 23.\nMaxStrainCriterion.eXc\nGlobal compressive strain limit in material direction 1.\nMaxStrainCriterion.eXt\nGlobal tensile strain limit in material direction 1.\nMaxStrainCriterion.eYc\nGlobal compressive strain limit in material direction 1.\nMaxStrainCriterion.eYt\nGlobal tensile strain limit in material direction 2.\nMaxStrainCriterion.eZc\nGlobal compressive strain limit in material direction 3.\nMaxStrainCriterion.eZt\nGlobal strain limit in material direction 3.\nMaxStrainCriterion.force_global_strain_limits\nWhether to use one set of global strain limits instead of the strain limits of the materials.\nMaxStrainCriterion.name\nName of the failure criterion.\nMaxStrainCriterion.wf_e1\nWeighting factor of the failure mode e1.\nMaxStrainCriterion.wf_e12\nWeighting factor of the failure mode e12.\nMaxStrainCriterion.wf_e13\nWeighting factor of the failure mode e13.\nMaxStrainCriterion.wf_e2\nWeighting factor of the failure mode e2.\nMaxStrainCriterion.wf_e23\nWeighting factor of the failure mode e23.\nMaxStrainCriterion.wf_e3\nWeighting factor of the failure mode e3.\nMaxStrainCriterion\nbool\nTrue\nbool\nTrue\nbool\nFalse\nbool\nTrue\nbool\nFalse\nbool\nFalse\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n0.0\nfloat\n0.0\nfloat\n0.0\nfloat\n0.0\nfloat\n0.0\nfloat\n0.0\nfloat\n0.0\nfloat\n0.0\nfloat\n0.0\nMaxStrainCriterion.to_dict\nMaxStrainCriterion.to_json\nMaxStrainCriterion.active\nMaxStrainCriterion.e1\nMaxStrainCriterion.e12\nMaxStrainCriterion.e13\nMaxStrainCriterion.e2\nMaxStrainCriterion.e23\nMaxStrainCriterion.e3\nMaxStrainCriterion.eSxy\nMaxStrainCriterion.eSxz\nMaxStrainCriterion.eSyz\nMaxStrainCriterion.eXc\nMaxStrainCriterion.eXt\nMaxStrainCriterion.eYc\nMaxStrainCriterion.eYt\nMaxStrainCriterion.eZc\nMaxStrainCriterion.eZt\nMaxStrainCriterion.force_global_strain_limits\nMaxStrainCriterion.name\nMaxStrainCriterion.wf_e1\nMaxStrainCriterion.wf_e12\nMaxStrainCriterion.wf_e13\nMaxStrainCriterion.wf_e2\nMaxStrainCriterion.wf_e23\nMaxStrainCriterion.wf_e3" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e13", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e13.html#e13", - "title": "e13", - "section": "e13", - "text": "e13" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion", + "title": "MaxStrainCriterion > MaxStrainCriterion > MaxStrainCriterion", + "section": "MaxStrainCriterion > MaxStrainCriterion", + "text": "class ansys.dpf.composites.failure_criteria.MaxStrainCriterion(*, e1=True, e2=True, e3=False, e12=True, e13=False, e23=False, wf_e1=1.0, wf_e2=1.0, wf_e3=1.0, wf_e12=1.0, wf_e13=1.0, wf_e23=1.0, force_global_strain_limits=False, eXt=0.0, eXc=0.0, eYt=0.0, eYc=0.0, eZt=0.0, eZc=0.0, eSxy=0.0, eSxz=0.0, eSyz=0.0)\n\nDefines the maximum strain failure criterion for orthotropic reinforced materials.\n\nParameters\n\ne1 (bool, default: True) – Activates the failure evaluation regarding the strain in the material 1 direction.\n\ne2 (bool, default: True) – Activates the failure evaluation regarding the strain in the material 2 direction.\n\ne3 (bool, default: False) – Activates the failure evaluation regarding the strain in the material 3 direction (out-of-plane).\n\ne12 (bool, default: True) – Whether to activate the failure evaluation regarding the in-plane shear strain e12.\n\ne13 (bool, default: False) – Whether to activate the failure evaluation regarding the interlaminar shear strain e13.\n\ne23 (bool, default: False) – Whether to activate the failure evaluation regarding the interlaminar shear strain e23.\n\nwf_e1 (float, default: 1.0) – Weighting factor of the failure mode e1.\n\nwf_e2 (float, default: 1.0) – Weighting factor of the failure mode e2.\n\nwf_e3 (float, default: 1.0) – Weighting factor of the failure mode e3.\n\nwf_e12 (float, default: 1.0) – Weighting factor of the failure mode e12.\n\nwf_e13 (float, default: 1.0) – Weighting factor of the failure mode e13.\n\nwf_e23 (float, default: 1.0) – Weighting factor of the failure mode e23.\n\neXt (float, default: 0.0) – Global tensile strain limit in material direction 1.\n\neXc (float, default: 0.0) – Global compressive strain limit in material direction 1.\n\neYt (float, default: 0.0) – Global tensile strain limit in material direction 2.\n\neYc (float, default: 0.0) – Global compressive strain limit in material direction 2.\n\neZt (float, default: 0.0) – Global strain limit in material direction 3.\n\neZc (float, default: 0.0) – Global compressive strain limit in material direction 3.\n\neSxy (float, default: 0.0) – Global strain limit in material direction 12.\n\neSxz (float, default: 0.0) – Global strain limit in material direction 13.\n\neSyz (float, default: 0.0) – Global strain limit in material direction 23.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nMaxStrainCriterion.to_dict()\n\n\n\nMaxStrainCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nMaxStrainCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nMaxStrainCriterion.e1\n\nActivates the failure evaluation regarding the strain in the material 1 direction.\n\nMaxStrainCriterion.e12\n\nWhether to activate the failure evaluation regarding the in-plane shear strain e12.\n\nMaxStrainCriterion.e13\n\nWhether to activate the failure evaluation regarding the interlaminar shear strain e13.\n\nMaxStrainCriterion.e2\n\nActivates the failure evaluation regarding the strain in the material 2 direction.\n\nMaxStrainCriterion.e23\n\nWhether to activate the failure evaluation regarding the interlaminar shear strain e23.\n\nMaxStrainCriterion.e3\n\nActivates the failure evaluation regarding the strain in the material 3 direction (out-of-plane).\n\nMaxStrainCriterion.eSxy\n\nGlobal strain limit in material direction 12.\n\nMaxStrainCriterion.eSxz\n\nGlobal strain limit in material direction 13.\n\nMaxStrainCriterion.eSyz\n\nGlobal strain limit in material direction 23.\n\nMaxStrainCriterion.eXc\n\nGlobal compressive strain limit in material direction 1.\n\nMaxStrainCriterion.eXt\n\nGlobal tensile strain limit in material direction 1.\n\nMaxStrainCriterion.eYc\n\nGlobal compressive strain limit in material direction 1.\n\nMaxStrainCriterion.eYt\n\nGlobal tensile strain limit in material direction 2.\n\nMaxStrainCriterion.eZc\n\nGlobal compressive strain limit in material direction 3.\n\nMaxStrainCriterion.eZt\n\nGlobal strain limit in material direction 3.\n\nMaxStrainCriterion.force_global_strain_limits\n\nWhether to use one set of global strain limits instead of the strain limits of the materials.\n\nMaxStrainCriterion.name\n\nName of the failure criterion.\n\nMaxStrainCriterion.wf_e1\n\nWeighting factor of the failure mode e1.\n\nMaxStrainCriterion.wf_e12\n\nWeighting factor of the failure mode e12.\n\nMaxStrainCriterion.wf_e13\n\nWeighting factor of the failure mode e13.\n\nMaxStrainCriterion.wf_e2\n\nWeighting factor of the failure mode e2.\n\nMaxStrainCriterion.wf_e23\n\nWeighting factor of the failure mode e23.\n\nMaxStrainCriterion.wf_e3\n\nWeighting factor of the failure mode e3.\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e13", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e13.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e13", - "title": "e13 > e13 > e13", - "section": "e13 > e13", - "text": "FailureModeEnum.e13 = 150\n\n" + "objectID": "examples/gallery_examples/002_sampling_point_example", + "href": "examples/gallery_examples/002_sampling_point_example.html#sampling-point", + "title": "Sampling point", + "section": "Sampling point", + "text": "This example extracts ply-wise laminate properties and results.\nThe Sampling Point class is used to extract\nthrough-the-thickness data of the laminate, such as ply-wise properties,\nstrains and stresses. It then implements basic visualization to plot\nthe laminate.\nThis example uses the Composite Model to scope a\nSampling Point to a certain element and to visualize the laminate.\nWhen using a Workbench project,\nuse the get_composite_files_from_workbench_result_folder()\nmethod to obtain the input files.\nSampling point\nSampling Point\nComposite Model\nget_composite_files_from_workbench_result_folder()" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.active.html#active", - "title": "active", - "section": "active", - "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" + "objectID": "examples/gallery_examples/002_sampling_point_example", + "href": "examples/gallery_examples/002_sampling_point_example.html#set-up-analysis", + "title": "Sampling point > Set up analysis", + "section": "Set up analysis", + "text": "Setting up the analysis consists of loading Ansys libraries, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries.\nStart a DPF server and copy the example files into the current working directory.\nConfigure the combined failure criterion\nSet up analysis" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.active.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.active", - "title": "active > active > active", - "section": "active > active", - "text": "property LaRCCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/002_sampling_point_example", + "href": "examples/gallery_examples/002_sampling_point_example.html#set-up-model-and-create-sampling-point", + "title": "Sampling point > Set up model and create sampling point", + "section": "Set up model and create sampling point", + "text": "Set up the composite model.\nCreate a sampling point\nSet up model and create sampling point" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.html#shearcrimpingcriterion", - "title": "ShearCrimpingCriterion", - "section": "ShearCrimpingCriterion", - "text": "Defines the shear crimping failure criterion for sandwich structures.\nkc (float, default: 1.0) – Weighting factor of the core material for evaluation of the maximum allowable load. The default is 1.\nkf (float, default: 0.0) – Weighting factor of the face sheets for evaluation of the maximum allowable load. The default is 0 so the face sheet does not contribute to the allowable load. This property is valid for thin face sheets.\nwf (float, default: 1.0) – Weighting factor of the failure mode (wb or wt).\nShearCrimpingCriterion.to_dict()\n\nShearCrimpingCriterion.to_json()\n\nShearCrimpingCriterion.active\nThe failure criterion is suppressed if active is False.\nShearCrimpingCriterion.kc\nWeighting factor of the core material for evaluation of the maximum allowable load.\nShearCrimpingCriterion.kf\nWeighting factor of the face sheets for evaluation of the maximum allowable load.\nShearCrimpingCriterion.name\nName of the failure criterion.\nShearCrimpingCriterion.wf\nWeighting factor of the failure mode (wb or wt).\nShearCrimpingCriterion\nfloat\n1.0\n1\nfloat\n0.0\n0\nfloat\n1.0\nShearCrimpingCriterion.to_dict\nShearCrimpingCriterion.to_json\nShearCrimpingCriterion.active\nShearCrimpingCriterion.kc\nShearCrimpingCriterion.kf\nShearCrimpingCriterion.name\nShearCrimpingCriterion.wf" + "objectID": "examples/gallery_examples/002_sampling_point_example", + "href": "examples/gallery_examples/002_sampling_point_example.html#plot-results", + "title": "Sampling point > Plot results", + "section": "Plot results", + "text": "Plot results uing preconfigured plots. For more information, see the\nSamplingPoint.get_result_plots() method.\nPlot polar properties.\nGenerate custom plots. You can customize existing plots or build\nthem from scratch using a package like Matplot or Plotly. This code\nuses Matplotlib to generate a custom plot of results s13 and s23.\nThis code uses Matplotlib to generate a custom plot of results e12 and e2.\nThis code plots the lay-up only.\nPlot results\nSamplingPoint.get_result_plots()\ns13\ns23\ne12\ne2" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.html#ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion", - "title": "ShearCrimpingCriterion > ShearCrimpingCriterion > ShearCrimpingCriterion", - "section": "ShearCrimpingCriterion > ShearCrimpingCriterion", - "text": "class ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion(*, kc=1.0, kf=0.0, wf=1.0)\n\nDefines the shear crimping failure criterion for sandwich structures.\n\nParameters\n\nkc (float, default: 1.0) – Weighting factor of the core material for evaluation of the maximum allowable load. The default is 1.\n\nkf (float, default: 0.0) – Weighting factor of the face sheets for evaluation of the maximum allowable load. The default is 0 so the face sheet does not contribute to the allowable load. This property is valid for thin face sheets.\n\nwf (float, default: 1.0) – Weighting factor of the failure mode (wb or wt).\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nShearCrimpingCriterion.to_dict()\n\n\n\nShearCrimpingCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nShearCrimpingCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nShearCrimpingCriterion.kc\n\nWeighting factor of the core material for evaluation of the maximum allowable load.\n\nShearCrimpingCriterion.kf\n\nWeighting factor of the face sheets for evaluation of the maximum allowable load.\n\nShearCrimpingCriterion.name\n\nName of the failure criterion.\n\nShearCrimpingCriterion.wf\n\nWeighting factor of the failure mode (wb or wt).\n\n" + "objectID": "examples/gallery_examples/002_sampling_point_example", + "href": "examples/gallery_examples/002_sampling_point_example.html#sample-another-element", + "title": "Sampling point > Sample another element", + "section": "Sample another element", + "text": "You can change the element ID of the sampling point to generate another plot.\nTotal running time of the script: (0 minutes 4.888 seconds)\nDownload Jupyter notebook: 002_sampling_point_example.ipynb\nDownload Python source code: 002_sampling_point_example.py\nDownload zipped: 002_sampling_point_example.zip\nGallery generated by Sphinx-Gallery\nSample another element\nDownload Jupyter notebook: 002_sampling_point_example.ipynb\nDownload Python source code: 002_sampling_point_example.py\nDownload zipped: 002_sampling_point_example.zip" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Spot.MIDDLE", - "href": "api/_autosummary/ansys.dpf.composites.constants.Spot.MIDDLE.html#middle", - "title": "MIDDLE", - "section": "MIDDLE", - "text": "MIDDLE" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.get_layer_index_by_element_id", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.get_layer_index_by_element_id.html#get_layer_index_by_element_id", + "title": "get_layer_index_by_element_id", + "section": "get_layer_index_by_element_id", + "text": "Get the layer index for the analysis ply in a given element.\nelement_id (int) – Element Id/Label\nOptional[int64]\nget_layer_index_by_element_id\nint\nOptional\nint64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Spot.MIDDLE", - "href": "api/_autosummary/ansys.dpf.composites.constants.Spot.MIDDLE.html#ansys.dpf.composites.constants.Spot.MIDDLE", - "title": "MIDDLE > MIDDLE > MIDDLE", - "section": "MIDDLE > MIDDLE", - "text": "Spot.MIDDLE = 2\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.get_layer_index_by_element_id", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.get_layer_index_by_element_id.html#ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.get_layer_index_by_element_id", + "title": "get_layer_index_by_element_id > get_layer_index_by_element_id > get_layer_index_by_element_id", + "section": "get_layer_index_by_element_id > get_layer_index_by_element_id", + "text": "AnalysisPlyInfoProvider.get_layer_index_by_element_id(element_id)\n\nGet the layer index for the analysis ply in a given element.\n\nParameters\n\nelement_id (int) – Element Id/Label\n\nReturn type\n\nOptional[int64]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_definition_labels", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_definition_labels.html#composite_definition_labels", - "title": "composite_definition_labels", - "section": "composite_definition_labels", - "text": "All composite definition labels in the model.\nThis property is only relevant for assemblies.\nSequence[str]\ncomposite_definition_labels\nSequence\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.name", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.name.html#name", + "title": "name", + "section": "name", + "text": "Name of the object.\nstr\nname\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_definition_labels", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_definition_labels.html#ansys.dpf.composites.composite_model.CompositeModel.composite_definition_labels", - "title": "composite_definition_labels > composite_definition_labels > composite_definition_labels", - "section": "composite_definition_labels > composite_definition_labels", - "text": "property CompositeModel.composite_definition_labels: Sequence[str]\n\nAll composite definition labels in the model.\n\nThis property is only relevant for assemblies.\n\nReturn type\n\nSequence[str]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.name", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.name.html#ansys.dpf.composites.sampling_point.SamplingPoint.name", + "title": "name > name > name", + "section": "name > name", + "text": "property SamplingPoint.name: str\n\nName of the object.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.force_global_constants", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.force_global_constants.html#force_global_constants", - "title": "force_global_constants", - "section": "force_global_constants", - "text": "Whether to use global constants instead of the material-wise properties.\nbool\nforce_global_constants\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.dim", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.dim.html#dim", + "title": "dim", + "section": "dim", + "text": "Whether the 2D or 3D formulation of the criterion is used. 2D is equivalent to LaRC03, and 3D is equivalent to LaRC04.\nint\ndim\nint" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.force_global_constants", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.force_global_constants.html#ansys.dpf.composites.failure_criteria.PuckCriterion.force_global_constants", - "title": "force_global_constants > force_global_constants > force_global_constants", - "section": "force_global_constants > force_global_constants", - "text": "property PuckCriterion.force_global_constants: bool\n\nWhether to use global constants instead of the material-wise properties.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.dim", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.dim.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.dim", + "title": "dim > dim > dim", + "section": "dim > dim", + "text": "property LaRCCriterion.dim: int\n\nWhether the 2D or 3D formulation of the criterion is used. 2D is equivalent to LaRC03, and 3D is equivalent to LaRC04.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT", - "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT.html#max_local_layer_in_element", - "title": "MAX_LOCAL_LAYER_IN_ELEMENT", - "section": "MAX_LOCAL_LAYER_IN_ELEMENT", - "text": "MAX_LOCAL_LAYER_IN_ELEMENT" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_corner_nodes", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_corner_nodes.html#n_corner_nodes", + "title": "n_corner_nodes", + "section": "n_corner_nodes", + "text": "n_corner_nodes" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT", - "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT.html#ansys.dpf.composites.constants.FailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT", - "title": "MAX_LOCAL_LAYER_IN_ELEMENT > MAX_LOCAL_LAYER_IN_ELEMENT > MAX_LOCAL_LAYER_IN_ELEMENT", - "section": "MAX_LOCAL_LAYER_IN_ELEMENT > MAX_LOCAL_LAYER_IN_ELEMENT", - "text": "FailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT = 6\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_corner_nodes", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_corner_nodes.html#ansys.dpf.composites.layup_info.ElementInfo.n_corner_nodes", + "title": "n_corner_nodes > n_corner_nodes > n_corner_nodes", + "section": "n_corner_nodes > n_corner_nodes", + "text": "ElementInfo.n_corner_nodes: int\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.name.html#name", - "title": "name", - "section": "name", - "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.include_ins", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.include_ins.html#include_ins", + "title": "include_ins", + "section": "include_ins", + "text": "Whether to activate the formulation that considers interlaminar normal stresses.\nbool\ninclude_ins\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.name.html#ansys.dpf.composites.failure_criteria.PuckCriterion.name", - "title": "name > name > name", - "section": "name > name", - "text": "property PuckCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.include_ins", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.include_ins.html#ansys.dpf.composites.failure_criteria.CoreFailureCriterion.include_ins", + "title": "include_ins > include_ins > include_ins", + "section": "include_ins > include_ins", + "text": "property CoreFailureCriterion.include_ins: bool\n\nWhether to activate the formulation that considers interlaminar normal stresses.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/layup_info", - "href": "api/layup_info.html#lay-up-information", - "title": "Lay-up information", - "section": "Lay-up information", - "text": "General features to access information on the composite lay-up.\nadd_layup_info_to_mesh(data_sources, ...[, ...])\nAdd lay-up information to the mesh.\nget_element_info_provider(mesh, ...[, ...])\nGet ElementInfoProvider Object.\nget_dpf_material_id_by_analyis_ply_map(mesh, ...)\nGet Dict that maps analysis ply names to dpf_material_ids.\nAnalysisPlyInfoProvider(mesh, name)\nAnalysisPlyInfoProvider.\nElementInfoProvider(mesh, layer_indices, ...)\nProvider for ElementInfo.\nElementInfo(id, n_layers, n_corner_nodes, ...)\nProvides lay-up information for an element.\nLayupPropertiesProvider(layup_provider, mesh)\nProvider for lay-up properties.\nLayerProperty(value[, names, module, ...])\nProvides the layer properties available.\nLayupProperty(value[, names, module, ...])\nEnum for lay-up properties.\nLayupModelContextType(value[, names, ...])\nType of the lay-up information.\nLay-up information\nadd_layup_info_to_mesh\nget_element_info_provider\nElementInfoProvider\nget_dpf_material_id_by_analyis_ply_map\nAnalysisPlyInfoProvider\nElementInfoProvider\nElementInfo\nElementInfo\nLayupPropertiesProvider\nLayerProperty\nLayupProperty\nLayupModelContextType" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R12", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R12.html#hill_yield_criterion_r12", + "title": "Hill_Yield_Criterion_R12", + "section": "Hill_Yield_Criterion_R12", + "text": "Hill_Yield_Criterion_R12" }, { - "objectID": "api/layup_info", - "href": "api/layup_info.html#material-properties", - "title": "Lay-up information > Material properties", - "section": "Material properties", - "text": "A note on material ids: in the PyDPF - Composites module,\nmaterials are reference by their dpf_material_id. The dpf_material_id\nis generated based on the materials present in the result file.\nThe dpf_material_id can be different from the material id used in the solver.\nElementInfo contains the dpf_material_id for the materials\nof a given element. The dpf_material_id for a given analysis ply can be obtained\nby calling get_dpf_material_id_by_analyis_ply_map(). A lookup by\nmaterial name is currently not available.\nThe sphx_glr_examples_gallery_examples_004_get_material_properties_example.py\nexample shows how to evaluate material properties.\nget_constant_property(material_property, ...)\nGet a constant material property.\nget_all_dpf_material_ids(mesh, ...)\nGet all DPF material IDs.\nget_constant_property_dict(...)\nGet a dictionary with constant properties.\nMaterialProperty(value[, names, module, ...])\nProvides the material properties that are available.\nMaterialMetadata([dpf_material_id, ...])\nMaterial metadata such as name and ply type.\nMaterial properties\ndpf_material_id\ndpf_material_id\ndpf_material_id\nElementInfo\ndpf_material_id\ndpf_material_id\nget_dpf_material_id_by_analyis_ply_map()\nget_constant_property\nget_all_dpf_material_ids\nget_constant_property_dict\nMaterialProperty\nMaterialMetadata" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R12", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R12.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R12", + "title": "Hill_Yield_Criterion_R12 > Hill_Yield_Criterion_R12 > Hill_Yield_Criterion_R12", + "section": "Hill_Yield_Criterion_R12 > Hill_Yield_Criterion_R12", + "text": "MaterialProperty.Hill_Yield_Criterion_R12: str = 'yield_stress_ratio_xy_hill_criterion'\n\n" }, { - "objectID": "api/layup_info", - "href": "api/layup_info.html#material-operators", - "title": "Lay-up information > Material operators", - "section": "Material operators", - "text": "MaterialOperators(material_provider, ...)\nProvides the container for material-related operators.\nget_material_operators(rst_data_source, ...)\nGet material properties related to operators.\nMaterial operators\nMaterialOperators\nget_material_operators" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e12", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e12.html#e12", + "title": "e12", + "section": "e12", + "text": "In-plane shear strains e12 of each ply.\nndarray[Any, dtype[float64]]\ne12\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_s", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_s.html#puck_constants_s", - "title": "Puck_Constants_s", - "section": "Puck_Constants_s", - "text": "Puck_Constants_s" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e12", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e12.html#ansys.dpf.composites.sampling_point.SamplingPoint.e12", + "title": "e12 > e12 > e12", + "section": "e12 > e12", + "text": "property SamplingPoint.e12: ndarray[Any, dtype[float64]]\n\nIn-plane shear strains e12 of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_s", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_s.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_s", - "title": "Puck_Constants_s > Puck_Constants_s > Puck_Constants_s", - "section": "Puck_Constants_s > Puck_Constants_s", - "text": "MaterialProperty.Puck_Constants_s: str = 'degradation_parameter_s_puck_constants'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_result_times_or_frequencies", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_result_times_or_frequencies.html#get_result_times_or_frequencies", + "title": "get_result_times_or_frequencies", + "section": "get_result_times_or_frequencies", + "text": "Get the times or frequencies in the result file.\nndarray[Any, dtype[float64]]\nget_result_times_or_frequencies\nndarray\nAny\ndtype\nfloat64" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_result_times_or_frequencies", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_result_times_or_frequencies.html#ansys.dpf.composites.composite_model.CompositeModel.get_result_times_or_frequencies", + "title": "get_result_times_or_frequencies > get_result_times_or_frequencies > get_result_times_or_frequencies", + "section": "get_result_times_or_frequencies > get_result_times_or_frequencies", + "text": "CompositeModel.get_result_times_or_frequencies()\n\nGet the times or frequencies in the result file.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.measure", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.measure.html#measure", - "title": "measure", - "section": "measure", - "text": "Return type of the failure values.\nSupported types are \"inverse_reserve_factor\", \"safety_factor\",\nand \"safety_margin\".\nstr\nmeasure\n\"inverse_reserve_factor\"\n\"safety_factor\"\n\"safety_margin\"\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.html#resultdefinitionscope", + "title": "ResultDefinitionScope", + "section": "ResultDefinitionScope", + "text": "Provides the result definition scope.\nResultDefinitionScope.mapping_file\nPath to the mapping file for all element labels in the element scope.\nResultDefinitionScope.write_data_for_full_element_scope\nWhether to write the data for all element labels in the element scope.\nResultDefinitionScope.composite_definition\n\nResultDefinitionScope.element_scope\n\nResultDefinitionScope.ply_scope\n\nResultDefinitionScope.named_selection_scope\nAssembly files that define the mapping of the labels.\nResultDefinitionScope\nResultDefinitionScope.mapping_file\nResultDefinitionScope.write_data_for_full_element_scope\nResultDefinitionScope.composite_definition\nResultDefinitionScope.element_scope\nResultDefinitionScope.ply_scope\nResultDefinitionScope.named_selection_scope" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.measure", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.measure.html#ansys.dpf.composites.result_definition.ResultDefinition.measure", - "title": "measure > measure > measure", - "section": "measure > measure", - "text": "property ResultDefinition.measure: str\n\nReturn type of the failure values.\n\nSupported types are \"inverse_reserve_factor\", \"safety_factor\",\nand \"safety_margin\".\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.html#ansys.dpf.composites.result_definition.ResultDefinitionScope", + "title": "ResultDefinitionScope > ResultDefinitionScope > ResultDefinitionScope", + "section": "ResultDefinitionScope > ResultDefinitionScope", + "text": "class ansys.dpf.composites.result_definition.ResultDefinitionScope(composite_definition, element_scope=, ply_scope=, named_selection_scope=, mapping_file=None, write_data_for_full_element_scope=True)\n\nProvides the result definition scope.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nResultDefinitionScope.mapping_file\n\nPath to the mapping file for all element labels in the element scope.\n\nResultDefinitionScope.write_data_for_full_element_scope\n\nWhether to write the data for all element labels in the element scope.\n\nResultDefinitionScope.composite_definition\n\n\n\nResultDefinitionScope.element_scope\n\n\n\nResultDefinitionScope.ply_scope\n\n\n\nResultDefinitionScope.named_selection_scope\n\nAssembly files that define the mapping of the labels.\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYc", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYc.html#strain_limits_eyc", - "title": "Strain_Limits_eYc", - "section": "Strain_Limits_eYc", - "text": "Strain_Limits_eYc" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.MARGIN_OF_SAFETY", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.MARGIN_OF_SAFETY.html#margin_of_safety", + "title": "MARGIN_OF_SAFETY", + "section": "MARGIN_OF_SAFETY", + "text": "MARGIN_OF_SAFETY" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYc", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYc.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYc", - "title": "Strain_Limits_eYc > Strain_Limits_eYc > Strain_Limits_eYc", - "section": "Strain_Limits_eYc > Strain_Limits_eYc", - "text": "MaterialProperty.Strain_Limits_eYc: str = 'strain_compressive_y_direction'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.MARGIN_OF_SAFETY", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.MARGIN_OF_SAFETY.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.MARGIN_OF_SAFETY", + "title": "MARGIN_OF_SAFETY > MARGIN_OF_SAFETY > MARGIN_OF_SAFETY", + "section": "MARGIN_OF_SAFETY > MARGIN_OF_SAFETY", + "text": "FailureMeasureEnum.MARGIN_OF_SAFETY: str = 'safety_margin'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.name.html#name", - "title": "name", - "section": "name", - "text": "Name of the combined failure criterion.\nstr\nname\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e12", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e12.html#e12", + "title": "e12", + "section": "e12", + "text": "Whether to activate the failure evaluation regarding the in-plane shear strain e12.\nbool\ne12\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.name.html#ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.name", - "title": "name > name > name", - "section": "name > name", - "text": "property CombinedFailureCriterion.name: str\n\nName of the combined failure criterion.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e12", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e12.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e12", + "title": "e12 > e12 > e12", + "section": "e12 > e12", + "text": "property MaxStrainCriterion.e12: bool\n\nWhether to activate the failure evaluation regarding the in-plane shear strain e12.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxz", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxz.html#strain_limits_esxz", - "title": "Strain_Limits_eSxz", - "section": "Strain_Limits_eSxz", - "text": "Strain_Limits_eSxz" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isalnum", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isalnum.html#isalnum", + "title": "isalnum", + "section": "isalnum", + "text": "Return True if the string is an alpha-numeric string, False otherwise.\nA string is alpha-numeric if all characters in the string are alpha-numeric and\nthere is at least one character in the string.\nisalnum" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxz", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxz.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxz", - "title": "Strain_Limits_eSxz > Strain_Limits_eSxz > Strain_Limits_eSxz", - "section": "Strain_Limits_eSxz > Strain_Limits_eSxz", - "text": "MaterialProperty.Strain_Limits_eSxz: str = 'strain_shear_xz'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isalnum", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isalnum.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isalnum", + "title": "isalnum > isalnum > isalnum", + "section": "isalnum > isalnum", + "text": "FailureMeasureEnum.isalnum(/)\n\nReturn True if the string is an alpha-numeric string, False otherwise.\n\nA string is alpha-numeric if all characters in the string are alpha-numeric and\nthere is at least one character in the string.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_dict.html#to_dict", + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_dict.html#to_dict", "title": "to_dict", "section": "to_dict", "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_dict", + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_dict", "title": "to_dict > to_dict > to_dict", "section": "to_dict > to_dict", - "text": "TsaiHillCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.html#failuremodeenum", - "title": "FailureModeEnum", - "section": "FailureModeEnum", - "text": "FailureModeEnum.emax\n\nFailureModeEnum.evm\n\nFailureModeEnum.e1\n\nFailureModeEnum.e1t\n\nFailureModeEnum.e1c\n\nFailureModeEnum.e2\n\nFailureModeEnum.e2t\n\nFailureModeEnum.e2c\n\nFailureModeEnum.e3\n\nFailureModeEnum.e3t\n\nFailureModeEnum.e3c\n\nFailureModeEnum.e12\n\nFailureModeEnum.e13\n\nFailureModeEnum.e23\n\nFailureModeEnum.smax\n\nFailureModeEnum.svm\n\nFailureModeEnum.s1\n\nFailureModeEnum.s1t\n\nFailureModeEnum.s1c\n\nFailureModeEnum.s2\n\nFailureModeEnum.s2t\n\nFailureModeEnum.s2c\n\nFailureModeEnum.s3\n\nFailureModeEnum.s3t\n\nFailureModeEnum.s3c\n\nFailureModeEnum.s12\n\nFailureModeEnum.s13\n\nFailureModeEnum.s23\n\nFailureModeEnum.cf\n\nFailureModeEnum.w\n\nFailureModeEnum.wb\n\nFailureModeEnum.wt\n\nFailureModeEnum.sc\n\nFailureModeEnum.tw\n\nFailureModeEnum.th\n\nFailureModeEnum.h\n\nFailureModeEnum.hf\n\nFailureModeEnum.hm\n\nFailureModeEnum.hd\n\nFailureModeEnum.ho\n\nFailureModeEnum.p\n\nFailureModeEnum.pf\n\nFailureModeEnum.pmA\n\nFailureModeEnum.pmB\n\nFailureModeEnum.pmC\n\nFailureModeEnum.pd\n\nFailureModeEnum.l\n\nFailureModeEnum.lft3\n\nFailureModeEnum.lfc4\n\nFailureModeEnum.lfc6\n\nFailureModeEnum.lmt1\n\nFailureModeEnum.lmc2\n\nFailureModeEnum.lmc5\n\nFailureModeEnum.c\n\nFailureModeEnum.cft\n\nFailureModeEnum.cfc\n\nFailureModeEnum.cmA\n\nFailureModeEnum.cmB\n\nFailureModeEnum.cmC\n\nFailureModeEnum.vMe\n\nFailureModeEnum.vMs\n\nFailureModeEnum.as\n\nFailureModeEnum.ap\n\nFailureModeEnum.af\n\nFailureModeEnum.ns\n\nFailureModeEnum.na\n\nFailureModeEnum\nFailureModeEnum.emax\nFailureModeEnum.evm\nFailureModeEnum.e1\nFailureModeEnum.e1t\nFailureModeEnum.e1c\nFailureModeEnum.e2\nFailureModeEnum.e2t\nFailureModeEnum.e2c\nFailureModeEnum.e3\nFailureModeEnum.e3t\nFailureModeEnum.e3c\nFailureModeEnum.e12\nFailureModeEnum.e13\nFailureModeEnum.e23\nFailureModeEnum.smax\nFailureModeEnum.svm\nFailureModeEnum.s1\nFailureModeEnum.s1t\nFailureModeEnum.s1c\nFailureModeEnum.s2\nFailureModeEnum.s2t\nFailureModeEnum.s2c\nFailureModeEnum.s3\nFailureModeEnum.s3t\nFailureModeEnum.s3c\nFailureModeEnum.s12\nFailureModeEnum.s13\nFailureModeEnum.s23\nFailureModeEnum.cf\nFailureModeEnum.w\nFailureModeEnum.wb\nFailureModeEnum.wt\nFailureModeEnum.sc\nFailureModeEnum.tw\nFailureModeEnum.th\nFailureModeEnum.h\nFailureModeEnum.hf\nFailureModeEnum.hm\nFailureModeEnum.hd\nFailureModeEnum.ho\nFailureModeEnum.p\nFailureModeEnum.pf\nFailureModeEnum.pmA\nFailureModeEnum.pmB\nFailureModeEnum.pmC\nFailureModeEnum.pd\nFailureModeEnum.l\nFailureModeEnum.lft3\nFailureModeEnum.lfc4\nFailureModeEnum.lfc6\nFailureModeEnum.lmt1\nFailureModeEnum.lmc2\nFailureModeEnum.lmc5\nFailureModeEnum.c\nFailureModeEnum.cft\nFailureModeEnum.cfc\nFailureModeEnum.cmA\nFailureModeEnum.cmB\nFailureModeEnum.cmC\nFailureModeEnum.vMe\nFailureModeEnum.vMs\nFailureModeEnum.as\nFailureModeEnum.ap\nFailureModeEnum.af\nFailureModeEnum.ns\nFailureModeEnum.na" + "text": "TsaiWuCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.html#ansys.dpf.composites.failure_criteria.FailureModeEnum", - "title": "FailureModeEnum > FailureModeEnum > FailureModeEnum", - "section": "FailureModeEnum > FailureModeEnum", - "text": "class ansys.dpf.composites.failure_criteria.FailureModeEnum(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nFailureModeEnum.emax\n\n\n\nFailureModeEnum.evm\n\n\n\nFailureModeEnum.e1\n\n\n\nFailureModeEnum.e1t\n\n\n\nFailureModeEnum.e1c\n\n\n\nFailureModeEnum.e2\n\n\n\nFailureModeEnum.e2t\n\n\n\nFailureModeEnum.e2c\n\n\n\nFailureModeEnum.e3\n\n\n\nFailureModeEnum.e3t\n\n\n\nFailureModeEnum.e3c\n\n\n\nFailureModeEnum.e12\n\n\n\nFailureModeEnum.e13\n\n\n\nFailureModeEnum.e23\n\n\n\nFailureModeEnum.smax\n\n\n\nFailureModeEnum.svm\n\n\n\nFailureModeEnum.s1\n\n\n\nFailureModeEnum.s1t\n\n\n\nFailureModeEnum.s1c\n\n\n\nFailureModeEnum.s2\n\n\n\nFailureModeEnum.s2t\n\n\n\nFailureModeEnum.s2c\n\n\n\nFailureModeEnum.s3\n\n\n\nFailureModeEnum.s3t\n\n\n\nFailureModeEnum.s3c\n\n\n\nFailureModeEnum.s12\n\n\n\nFailureModeEnum.s13\n\n\n\nFailureModeEnum.s23\n\n\n\nFailureModeEnum.cf\n\n\n\nFailureModeEnum.w\n\n\n\nFailureModeEnum.wb\n\n\n\nFailureModeEnum.wt\n\n\n\nFailureModeEnum.sc\n\n\n\nFailureModeEnum.tw\n\n\n\nFailureModeEnum.th\n\n\n\nFailureModeEnum.h\n\n\n\nFailureModeEnum.hf\n\n\n\nFailureModeEnum.hm\n\n\n\nFailureModeEnum.hd\n\n\n\nFailureModeEnum.ho\n\n\n\nFailureModeEnum.p\n\n\n\nFailureModeEnum.pf\n\n\n\nFailureModeEnum.pmA\n\n\n\nFailureModeEnum.pmB\n\n\n\nFailureModeEnum.pmC\n\n\n\nFailureModeEnum.pd\n\n\n\nFailureModeEnum.l\n\n\n\nFailureModeEnum.lft3\n\n\n\nFailureModeEnum.lfc4\n\n\n\nFailureModeEnum.lfc6\n\n\n\nFailureModeEnum.lmt1\n\n\n\nFailureModeEnum.lmc2\n\n\n\nFailureModeEnum.lmc5\n\n\n\nFailureModeEnum.c\n\n\n\nFailureModeEnum.cft\n\n\n\nFailureModeEnum.cfc\n\n\n\nFailureModeEnum.cmA\n\n\n\nFailureModeEnum.cmB\n\n\n\nFailureModeEnum.cmC\n\n\n\nFailureModeEnum.vMe\n\n\n\nFailureModeEnum.vMs\n\n\n\nFailureModeEnum.as\n\n\n\nFailureModeEnum.ap\n\n\n\nFailureModeEnum.af\n\n\n\nFailureModeEnum.ns\n\n\n\nFailureModeEnum.na\n\n\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent", + "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.html#sym3x3tensorcomponent", + "title": "Sym3x3TensorComponent", + "section": "Sym3x3TensorComponent", + "text": "Provides tensor indices for symmetrical 3x3 tensors.\nSym3x3TensorComponent.TENSOR11\n\nSym3x3TensorComponent.TENSOR22\n\nSym3x3TensorComponent.TENSOR33\n\nSym3x3TensorComponent.TENSOR21\n\nSym3x3TensorComponent.TENSOR31\n\nSym3x3TensorComponent.TENSOR32\n\nSym3x3TensorComponent\nSym3x3TensorComponent.TENSOR11\nSym3x3TensorComponent.TENSOR22\nSym3x3TensorComponent.TENSOR33\nSym3x3TensorComponent.TENSOR21\nSym3x3TensorComponent.TENSOR31\nSym3x3TensorComponent.TENSOR32" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.fracture_plane_angle", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.fracture_plane_angle.html#fracture_plane_angle", - "title": "fracture_plane_angle", - "section": "fracture_plane_angle", - "text": "Fracture plane angle in degrees. The default is 53. The value must be greater than 45. The value depends on the out-of-plane shear friction coefficient.\nfloat\nfracture_plane_angle\n53\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent", + "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.html#ansys.dpf.composites.constants.Sym3x3TensorComponent", + "title": "Sym3x3TensorComponent > Sym3x3TensorComponent > Sym3x3TensorComponent", + "section": "Sym3x3TensorComponent > Sym3x3TensorComponent", + "text": "class ansys.dpf.composites.constants.Sym3x3TensorComponent(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nProvides tensor indices for symmetrical 3x3 tensors.\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nSym3x3TensorComponent.TENSOR11\n\n\n\nSym3x3TensorComponent.TENSOR22\n\n\n\nSym3x3TensorComponent.TENSOR33\n\n\n\nSym3x3TensorComponent.TENSOR21\n\n\n\nSym3x3TensorComponent.TENSOR31\n\n\n\nSym3x3TensorComponent.TENSOR32\n\n\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.fracture_plane_angle", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.fracture_plane_angle.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.fracture_plane_angle", - "title": "fracture_plane_angle > fracture_plane_angle > fracture_plane_angle", - "section": "fracture_plane_angle > fracture_plane_angle", - "text": "property CuntzeCriterion.fracture_plane_angle: float\n\nFracture plane angle in degrees. The default is 53. The value must be greater than 45. The value depends on the out-of-plane shear friction coefficient.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.active.html#active", + "title": "active", + "section": "active", + "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.find", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.find.html#find", - "title": "find", - "section": "find", - "text": "Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end].\nOptional arguments start and end are interpreted as in slice notation.\nReturn -1 on failure.\nfind" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.active.html#ansys.dpf.composites.failure_criteria.HashinCriterion.active", + "title": "active > active > active", + "section": "active > active", + "text": "property HashinCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.find", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.find.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.find", - "title": "find > find > find", - "section": "find > find", - "text": "FailureMeasureEnum.find(sub, [start, [end]], /)\n\nReturn the lowest index in S where substring sub is found, such that sub is contained within S[start:end].\n\nOptional arguments start and end are interpreted as in slice notation.\nReturn -1 on failure.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.name.html#name", + "title": "name", + "section": "name", + "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_constant_property_dict", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_constant_property_dict.html#get_constant_property_dict", - "title": "get_constant_property_dict", - "section": "get_constant_property_dict", - "text": "Get a dictionary with constant properties.\nReturns a dictionary with the DPF material ID as a key and\na dictionary with the requested properties as the value. Only constant properties\nare supported. Variable properties are evaluated at their\ndefault values.\nBecause this method can be slow to evaluate, it should not\nbe called in a loop.\nmaterial_properties (Collection[MaterialProperty]) – Material properties to request.\nmaterials_provider (Operator) – DPF Materials provider operator. This value is Available from the\nCompositeModel.material_operators attribute.\ndata_source_or_streams_provider (DataSources | Operator) – DPF data source or stream provider that contains the RST file.\nmesh (MeshedRegion) – DPF meshed region enriched with lay-up information.\ndict[int64, dict[MaterialProperty, float]]\nget_constant_property_dict\nCollection\nMaterialProperty\nOperator\nCompositeModel.material_operators\nDataSources\nOperator\nMeshedRegion\ndict\nint64\ndict\nMaterialProperty\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.name.html#ansys.dpf.composites.failure_criteria.CoreFailureCriterion.name", + "title": "name > name > name", + "section": "name > name", + "text": "property CoreFailureCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_constant_property_dict", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_constant_property_dict.html#ansys.dpf.composites.layup_info.material_properties.get_constant_property_dict", - "title": "get_constant_property_dict > get_constant_property_dict > get_constant_property_dict", - "section": "get_constant_property_dict > get_constant_property_dict", - "text": "ansys.dpf.composites.layup_info.material_properties.get_constant_property_dict(material_properties, materials_provider, data_source_or_streams_provider, mesh)\n\nGet a dictionary with constant properties.\n\nReturns a dictionary with the DPF material ID as a key and\na dictionary with the requested properties as the value. Only constant properties\nare supported. Variable properties are evaluated at their\ndefault values.\nBecause this method can be slow to evaluate, it should not\nbe called in a loop.\n\nParameters\n\nmaterial_properties (Collection[MaterialProperty]) – Material properties to request.\n\nmaterials_provider (Operator) – DPF Materials provider operator. This value is Available from the\nCompositeModel.material_operators attribute.\n\ndata_source_or_streams_provider (DataSources | Operator) – DPF data source or stream provider that contains the RST file.\n\nmesh (MeshedRegion) – DPF meshed region enriched with lay-up information.\n\nReturn type\n\ndict[int64, dict[MaterialProperty, float]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e3", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e3.html#wf_e3", + "title": "wf_e3", + "section": "wf_e3", + "text": "Weighting factor of the failure mode e3.\nfloat\nwf_e3\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXt", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXt.html#strain_limits_ext", - "title": "Strain_Limits_eXt", - "section": "Strain_Limits_eXt", - "text": "Strain_Limits_eXt" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e3", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e3.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e3", + "title": "wf_e3 > wf_e3 > wf_e3", + "section": "wf_e3 > wf_e3", + "text": "property MaxStrainCriterion.wf_e3: float\n\nWeighting factor of the failure mode e3.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXt", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXt.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXt", - "title": "Strain_Limits_eXt > Strain_Limits_eXt > Strain_Limits_eXt", - "section": "Strain_Limits_eXt > Strain_Limits_eXt", - "text": "MaterialProperty.Strain_Limits_eXt: str = 'strain_tensile_x_direction'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G23", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G23.html#engineering_constants_g23", + "title": "Engineering_Constants_G23", + "section": "Engineering_Constants_G23", + "text": "Engineering_Constants_G23" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e3", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e3.html#e3", - "title": "e3", - "section": "e3", - "text": "Activates the failure evaluation regarding the strain in the material 3 direction (out-of-plane).\nbool\ne3\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G23", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G23.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G23", + "title": "Engineering_Constants_G23 > Engineering_Constants_G23 > Engineering_Constants_G23", + "section": "Engineering_Constants_G23 > Engineering_Constants_G23", + "text": "MaterialProperty.Engineering_Constants_G23: str = 'shear_modulus_yz'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e3", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e3.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e3", - "title": "e3 > e3 > e3", - "section": "e3 > e3", - "text": "property MaxStrainCriterion.e3: bool\n\nActivates the failure evaluation regarding the strain in the material 3 direction (out-of-plane).\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.rst_files", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.rst_files.html#rst_files", + "title": "rst_files", + "section": "rst_files", + "text": "Path of the result (RST) files.\nlist[Union[str, PathLike[str]]]\nrst_files\nlist\nUnion\nstr\nPathLike\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E1", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E1.html#engineering_constants_e1", - "title": "Engineering_Constants_E1", - "section": "Engineering_Constants_E1", - "text": "Engineering_Constants_E1" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.rst_files", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.rst_files.html#ansys.dpf.composites.result_definition.ResultDefinition.rst_files", + "title": "rst_files > rst_files > rst_files", + "section": "rst_files > rst_files", + "text": "property ResultDefinition.rst_files: list[str | PathLike[str]]\n\nPath of the result (RST) files.\n\nReturn type\n\nlist[Union[str, PathLike[str]]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E1", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E1.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E1", - "title": "Engineering_Constants_E1 > Engineering_Constants_E1 > Engineering_Constants_E1", - "section": "Engineering_Constants_E1 > Engineering_Constants_E1", - "text": "MaterialProperty.Engineering_Constants_E1: str = 'young_modulus_x_direction'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.ACP", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.ACP.html#acp", + "title": "ACP", + "section": "ACP", + "text": "ACP" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_corner_nodes", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_corner_nodes.html#n_corner_nodes", - "title": "n_corner_nodes", - "section": "n_corner_nodes", - "text": "n_corner_nodes" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.ACP", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.ACP.html#ansys.dpf.composites.layup_info.LayupModelContextType.ACP", + "title": "ACP > ACP > ACP", + "section": "ACP > ACP", + "text": "LayupModelContextType.ACP = 1\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_corner_nodes", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_corner_nodes.html#ansys.dpf.composites.layup_info.ElementInfo.n_corner_nodes", - "title": "n_corner_nodes > n_corner_nodes > n_corner_nodes", - "section": "n_corner_nodes > n_corner_nodes", - "text": "ElementInfo.n_corner_nodes: int\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.mode_interaction_coeff", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.mode_interaction_coeff.html#mode_interaction_coeff", + "title": "mode_interaction_coeff", + "section": "mode_interaction_coeff", + "text": "Mode interaction coefficient. The default is 2.6.\nfloat\nmode_interaction_coeff\n2.6\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.h", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.h.html#h", - "title": "h", - "section": "h", - "text": "h" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.mode_interaction_coeff", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.mode_interaction_coeff.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.mode_interaction_coeff", + "title": "mode_interaction_coeff > mode_interaction_coeff > mode_interaction_coeff", + "section": "mode_interaction_coeff > mode_interaction_coeff", + "text": "property CuntzeCriterion.mode_interaction_coeff: float\n\nMode interaction coefficient. The default is 2.6.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.h", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.h.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.h", - "title": "h > h > h", - "section": "h > h", - "text": "FailureModeEnum.h = 501\n\n" + "objectID": "examples/gallery_examples/013_thermal_example", + "href": "examples/gallery_examples/013_thermal_example.html#thermal-analysis", + "title": "Thermal analysis", + "section": "Thermal analysis", + "text": "This example shows how to evaluate a thermal analysis.\nThe simulation’s thermal analysis results are also\nthe input of a structural analysis.\nTherefore, the RST file contains temperature and structural results.\nThe example imitates a printed circuit board (PCB) that was\nmodeled with Ansys Composites PrepPost (ACP), using the solid model feature to\ngenerate the volume mesh.\nDescriptions of how to extract temperatures for a specific ply\nand material are provided.\nWhen using a Workbench project,\nuse the get_composite_files_from_workbench_result_folder()\nmethod to obtain the input files.\nThermal analysis\nget_composite_files_from_workbench_result_folder()" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R13", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R13.html#hill_yield_criterion_r13", - "title": "Hill_Yield_Criterion_R13", - "section": "Hill_Yield_Criterion_R13", - "text": "Hill_Yield_Criterion_R13" + "objectID": "examples/gallery_examples/013_thermal_example", + "href": "examples/gallery_examples/013_thermal_example.html#set-up-analysis", + "title": "Thermal analysis > Set up analysis", + "section": "Set up analysis", + "text": "Setting up the analysis consists of loading the required modules, connecting to the\nDPF server, and retrieving the example files.\nSet up analysis" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R13", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R13.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R13", - "title": "Hill_Yield_Criterion_R13 > Hill_Yield_Criterion_R13 > Hill_Yield_Criterion_R13", - "section": "Hill_Yield_Criterion_R13 > Hill_Yield_Criterion_R13", - "text": "MaterialProperty.Hill_Yield_Criterion_R13: str = 'yield_stress_ratio_xz_hill_criterion'\n\n" + "objectID": "examples/gallery_examples/013_thermal_example", + "href": "examples/gallery_examples/013_thermal_example.html#initialize-the-model", + "title": "Thermal analysis > Initialize the model", + "section": "Initialize the model", + "text": "Initialize the composite model with the composite files and server.\nThe model provides access to the mesh, results, lay-up, and materials.\nInitialize the model" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_ratio", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_ratio.html#larc_constants_fracture_toughness_ratio", - "title": "Larc_Constants_fracture_toughness_ratio", - "section": "Larc_Constants_fracture_toughness_ratio", - "text": "Larc_Constants_fracture_toughness_ratio" + "objectID": "examples/gallery_examples/013_thermal_example", + "href": "examples/gallery_examples/013_thermal_example.html#get-temperature-results", + "title": "Thermal analysis > Get temperature results", + "section": "Get temperature results", + "text": "The temperatures are stored under structural_temperature.\nGet temperature results\nstructural_temperature" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_ratio", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_ratio.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_ratio", - "title": "Larc_Constants_fracture_toughness_ratio > Larc_Constants_fracture_toughness_ratio > Larc_Constants_fracture_toughness_ratio", - "section": "Larc_Constants_fracture_toughness_ratio > Larc_Constants_fracture_toughness_ratio", - "text": "MaterialProperty.Larc_Constants_fracture_toughness_ratio: str = 'fracture_toughness_ratio_larc_constants'\n\n" + "objectID": "examples/gallery_examples/013_thermal_example", + "href": "examples/gallery_examples/013_thermal_example.html#get-ply-results", + "title": "Thermal analysis > Get ply results", + "section": "Get ply results", + "text": "Extract the ply-wise results by passing the ply name\nto the function get_ply_wise_data().\nGet ply results\nget_ply_wise_data()" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_constant_property", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_constant_property.html#get_constant_property", - "title": "get_constant_property", - "section": "get_constant_property", - "text": "Get a constant material property.\nOnly constant properties are supported. Variable properties are evaluated at their\ndefault values.\nmaterial_property (MaterialProperty) – Material property.\ndpf_material_id (int64) – DPF material ID.\nmaterials_provider (Operator) – DPF Materials provider operator. This value is available from the\nCompositeModel.material_operators attribute.\nunit_system (Union[UnitSystem, Operator])\nfloat\nget_constant_property\nMaterialProperty\nint64\nOperator\nCompositeModel.material_operators\nUnion\nUnitSystem\nOperator\nfloat" + "objectID": "examples/gallery_examples/013_thermal_example", + "href": "examples/gallery_examples/013_thermal_example.html#get-results-by-material", + "title": "Thermal analysis > Get results by material", + "section": "Get results by material", + "text": "You can filter the results by material.\nIn this example, the element-wise maximum temperature\nis extracted for the material Honeycomb Aluminum Alloy.\nTotal running time of the script: (0 minutes 4.181 seconds)\nDownload Jupyter notebook: 013_thermal_example.ipynb\nDownload Python source code: 013_thermal_example.py\nDownload zipped: 013_thermal_example.zip\nGallery generated by Sphinx-Gallery\nGet results by material\nDownload Jupyter notebook: 013_thermal_example.ipynb\nDownload Python source code: 013_thermal_example.py\nDownload zipped: 013_thermal_example.zip" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_constant_property", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_constant_property.html#ansys.dpf.composites.layup_info.material_properties.get_constant_property", - "title": "get_constant_property > get_constant_property > get_constant_property", - "section": "get_constant_property > get_constant_property", - "text": "ansys.dpf.composites.layup_info.material_properties.get_constant_property(material_property, dpf_material_id, materials_provider, unit_system)\n\nGet a constant material property.\n\nOnly constant properties are supported. Variable properties are evaluated at their\ndefault values.\n\nParameters\n\nmaterial_property (MaterialProperty) – Material property.\n\ndpf_material_id (int64) – DPF material ID.\n\nmaterials_provider (Operator) – DPF Materials provider operator. This value is available from the\nCompositeModel.material_operators attribute.\n\nunit_system (Union[UnitSystem, Operator])\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_s", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_s.html#puck_constants_s", + "title": "Puck_Constants_s", + "section": "Puck_Constants_s", + "text": "Puck_Constants_s" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_dict.html#to_dict", - "title": "to_dict", - "section": "to_dict", - "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_s", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_s.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_s", + "title": "Puck_Constants_s > Puck_Constants_s > Puck_Constants_s", + "section": "Puck_Constants_s > Puck_Constants_s", + "text": "MaterialProperty.Puck_Constants_s: str = 'degradation_parameter_s_puck_constants'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_dict", - "title": "to_dict > to_dict > to_dict", - "section": "to_dict > to_dict", - "text": "ShearCrimpingCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.dim", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.dim.html#dim", + "title": "dim", + "section": "dim", + "text": "Specifies which formulation of the failure criterion is used.\nint\ndim\nint" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s13", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s13.html#s13", - "title": "s13", - "section": "s13", - "text": "s13" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.dim", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.dim.html#ansys.dpf.composites.failure_criteria.TsaiHillCriterion.dim", + "title": "dim > dim > dim", + "section": "dim > dim", + "text": "property TsaiHillCriterion.dim: int\n\nSpecifies which formulation of the failure criterion is used.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s13", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s13.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s13", - "title": "s13 > s13 > s13", - "section": "s13 > s13", - "text": "FailureModeEnum.s13 = 250\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.spots_per_ply", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.spots_per_ply.html#spots_per_ply", + "title": "spots_per_ply", + "section": "spots_per_ply", + "text": "Number of through-the-thickness integration points per ply.\nint\nspots_per_ply\nint" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isspace", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isspace.html#isspace", - "title": "isspace", - "section": "isspace", - "text": "Return True if the string is a whitespace string, False otherwise.\nA string is whitespace if all characters in the string are whitespace and there\nis at least one character in the string.\nisspace" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.spots_per_ply", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.spots_per_ply.html#ansys.dpf.composites.sampling_point.SamplingPoint.spots_per_ply", + "title": "spots_per_ply > spots_per_ply > spots_per_ply", + "section": "spots_per_ply > spots_per_ply", + "text": "property SamplingPoint.spots_per_ply: int\n\nNumber of through-the-thickness integration points per ply.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isspace", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isspace.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isspace", - "title": "isspace > isspace > isspace", - "section": "isspace > isspace", - "text": "FailureMeasureEnum.isspace(/)\n\nReturn True if the string is a whitespace string, False otherwise.\n\nA string is whitespace if all characters in the string are whitespace and there\nis at least one character in the string.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.vme", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.vme.html#vme", + "title": "vme", + "section": "vme", + "text": "Whether to activate the von Mises strain criterion.\nbool\nvme\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aX", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aX.html#thermal_expansion_coefficients_ax", - "title": "Thermal_Expansion_Coefficients_aX", - "section": "Thermal_Expansion_Coefficients_aX", - "text": "Thermal_Expansion_Coefficients_aX" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.vme", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.vme.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.vme", + "title": "vme > vme > vme", + "section": "vme > vme", + "text": "property VonMisesCriterion.vme: bool\n\nWhether to activate the von Mises strain criterion.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aX", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aX.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aX", - "title": "Thermal_Expansion_Coefficients_aX > Thermal_Expansion_Coefficients_aX > Thermal_Expansion_Coefficients_aX", - "section": "Thermal_Expansion_Coefficients_aX > Thermal_Expansion_Coefficients_aX", - "text": "MaterialProperty.Thermal_Expansion_Coefficients_aX: str = 'coefficient_thermal_expansion_x'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_offsets_by_spots", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_offsets_by_spots.html#get_offsets_by_spots", + "title": "get_offsets_by_spots", + "section": "get_offsets_by_spots", + "text": "Access the y coordinates of the selected spots (interfaces) for each ply.\nspots (Collection[Spot], default: (, , )) – Collection of spots.\ncore_scale_factor (float, default: 1.0) – Factor for scaling the thickness of core plies.\nndarray[Any, dtype[float64]]\nget_offsets_by_spots\nCollection\nSpot\n(, , )\nfloat\n1.0\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MIN", - "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MIN.html#min", - "title": "MIN", - "section": "MIN", - "text": "MIN" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_offsets_by_spots", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_offsets_by_spots.html#ansys.dpf.composites.sampling_point.SamplingPoint.get_offsets_by_spots", + "title": "get_offsets_by_spots > get_offsets_by_spots > get_offsets_by_spots", + "section": "get_offsets_by_spots > get_offsets_by_spots", + "text": "SamplingPoint.get_offsets_by_spots(spots=(Spot.BOTTOM, Spot.MIDDLE, Spot.TOP), core_scale_factor=1.0)\n\nAccess the y coordinates of the selected spots (interfaces) for each ply.\n\nParameters\n\nspots (Collection[Spot], default: (, , )) – Collection of spots.\n\ncore_scale_factor (float, default: 1.0) – Factor for scaling the thickness of core plies.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MIN", - "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MIN.html#ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MIN", - "title": "MIN > MIN > MIN", - "section": "MIN > MIN", - "text": "SpotReductionStrategy.MIN = 'MIN'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e2", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e2.html#e2", + "title": "e2", + "section": "e2", + "text": "Strains in the material 2 direction of each ply.\nndarray[Any, dtype[float64]]\ne2\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e3", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e3.html#e3", - "title": "e3", - "section": "e3", - "text": "Strains in the material 3 direction of each ply.\nndarray[Any, dtype[float64]]\ne3\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e2", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e2.html#ansys.dpf.composites.sampling_point.SamplingPoint.e2", + "title": "e2 > e2 > e2", + "section": "e2 > e2", + "text": "property SamplingPoint.e2: ndarray[Any, dtype[float64]]\n\nStrains in the material 2 direction of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e3", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e3.html#ansys.dpf.composites.sampling_point.SamplingPoint.e3", - "title": "e3 > e3 > e3", - "section": "e3 > e3", - "text": "property SamplingPoint.e3: ndarray[Any, dtype[float64]]\n\nStrains in the material 3 direction of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.get_dpf_material_id_by_analyis_ply_map", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.get_dpf_material_id_by_analyis_ply_map.html#get_dpf_material_id_by_analyis_ply_map", + "title": "get_dpf_material_id_by_analyis_ply_map", + "section": "get_dpf_material_id_by_analyis_ply_map", + "text": "Get Dict that maps analysis ply names to dpf_material_ids.\nmesh (MeshedRegion) – DPF Meshed region enriched with lay-up information\ndata_source_or_streams_provider (DataSources | Operator) – DPF data source with rst file or streams_provider. The streams provider is\navailable from CompositeModel.core_model (under metadata.streams_provider).\nCache the output because the computation can be performance-critical.\ndict[str, int64]\nget_dpf_material_id_by_analyis_ply_map\nMeshedRegion\nDataSources\nOperator\nCompositeModel.core_model\ndict\nstr\nint64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.named_selections", - "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.named_selections.html#named_selections", - "title": "named_selections", - "section": "named_selections", - "text": "named_selections" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.get_dpf_material_id_by_analyis_ply_map", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.get_dpf_material_id_by_analyis_ply_map.html#ansys.dpf.composites.layup_info.get_dpf_material_id_by_analyis_ply_map", + "title": "get_dpf_material_id_by_analyis_ply_map > get_dpf_material_id_by_analyis_ply_map > get_dpf_material_id_by_analyis_ply_map", + "section": "get_dpf_material_id_by_analyis_ply_map > get_dpf_material_id_by_analyis_ply_map", + "text": "ansys.dpf.composites.layup_info.get_dpf_material_id_by_analyis_ply_map(mesh, data_source_or_streams_provider)\n\nGet Dict that maps analysis ply names to dpf_material_ids.\n\nParameters\n\nmesh (MeshedRegion) – DPF Meshed region enriched with lay-up information\n\ndata_source_or_streams_provider (DataSources | Operator) – DPF data source with rst file or streams_provider. The streams provider is\navailable from CompositeModel.core_model (under metadata.streams_provider).\n\nNotes\n\nCache the output because the computation can be performance-critical.\n\nReturn type\n\ndict[str, int64]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.named_selections", - "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.named_selections.html#ansys.dpf.composites.composite_scope.CompositeScope.named_selections", - "title": "named_selections > named_selections > named_selections", - "section": "named_selections > named_selections", - "text": "CompositeScope.named_selections: Sequence[str] | None = None\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_dict.html#to_dict", + "title": "to_dict", + "section": "to_dict", + "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yc", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yc.html#stress_limits_yc", - "title": "Stress_Limits_Yc", - "section": "Stress_Limits_Yc", - "text": "Stress_Limits_Yc" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_dict", + "title": "to_dict > to_dict > to_dict", + "section": "to_dict > to_dict", + "text": "FaceSheetWrinklingCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yc", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yc.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yc", - "title": "Stress_Limits_Yc > Stress_Limits_Yc > Stress_Limits_Yc", - "section": "Stress_Limits_Yc > Stress_Limits_Yc", - "text": "MaterialProperty.Stress_Limits_Yc: str = 'stress_compressive_y_direction'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.MIXED", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.MIXED.html#mixed", + "title": "MIXED", + "section": "MIXED", + "text": "MIXED" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.safety_margin", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.safety_margin.html#safety_margin", - "title": "safety_margin", - "section": "safety_margin", - "text": "safety_margin" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.MIXED", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.MIXED.html#ansys.dpf.composites.layup_info.LayupModelContextType.MIXED", + "title": "MIXED > MIXED > MIXED", + "section": "MIXED > MIXED", + "text": "LayupModelContextType.MIXED = 3\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.safety_margin", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.safety_margin.html#ansys.dpf.composites.sampling_point.FailureResult.safety_margin", - "title": "safety_margin > safety_margin > safety_margin", - "section": "safety_margin > safety_margin", - "text": "FailureResult.safety_margin: float\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.expandtabs", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.expandtabs.html#expandtabs", + "title": "expandtabs", + "section": "expandtabs", + "text": "Return a copy where all tab characters are expanded using spaces.\nIf tabsize is not given, a tab size of 8 characters is assumed.\nexpandtabs" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.expandtabs", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.expandtabs.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.expandtabs", + "title": "expandtabs > expandtabs > expandtabs", + "section": "expandtabs > expandtabs", + "text": "FailureMeasureEnum.expandtabs(/, tabsize=8)\n\nReturn a copy where all tab characters are expanded using spaces.\n\nIf tabsize is not given, a tab size of 8 characters is assumed.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1c", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1c.html#e1c", - "title": "e1c", - "section": "e1c", - "text": "e1c" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.LAMINATE_OFFSET", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.LAMINATE_OFFSET.html#laminate_offset", + "title": "LAMINATE_OFFSET", + "section": "LAMINATE_OFFSET", + "text": "LAMINATE_OFFSET" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1c", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1c.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e1c", - "title": "e1c > e1c > e1c", - "section": "e1c > e1c", - "text": "FailureModeEnum.e1c = 112\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.LAMINATE_OFFSET", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.LAMINATE_OFFSET.html#ansys.dpf.composites.layup_info.LayupProperty.LAMINATE_OFFSET", + "title": "LAMINATE_OFFSET > LAMINATE_OFFSET > LAMINATE_OFFSET", + "section": "LAMINATE_OFFSET > LAMINATE_OFFSET", + "text": "LayupProperty.LAMINATE_OFFSET = 3\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.old_composite_sources", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.old_composite_sources.html#old_composite_sources", - "title": "old_composite_sources", - "section": "old_composite_sources", - "text": "old_composite_sources" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.ply_scope", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.ply_scope.html#ply_scope", + "title": "ply_scope", + "section": "ply_scope", + "text": "ply_scope" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.old_composite_sources", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.old_composite_sources.html#ansys.dpf.composites.data_sources.CompositeDataSources.old_composite_sources", - "title": "old_composite_sources > old_composite_sources > old_composite_sources", - "section": "old_composite_sources > old_composite_sources", - "text": "CompositeDataSources.old_composite_sources: dict[str, DataSources]\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.ply_scope", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.ply_scope.html#ansys.dpf.composites.result_definition.ResultDefinitionScope.ply_scope", + "title": "ply_scope > ply_scope > ply_scope", + "section": "ply_scope > ply_scope", + "text": "ResultDefinitionScope.ply_scope: Sequence[str]\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXc.html#exc", - "title": "eXc", - "section": "eXc", - "text": "Global compressive strain limit in material direction 1.\nfloat\neXc\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_operators", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_operators.html#material_operators", + "title": "material_operators", + "section": "material_operators", + "text": "Material operators.\nMaterialOperators\nmaterial_operators\nMaterialOperators" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXc.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXc", - "title": "eXc > eXc > eXc", - "section": "eXc > eXc", - "text": "property MaxStrainCriterion.eXc: float\n\nGlobal compressive strain limit in material direction 1.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_operators", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_operators.html#ansys.dpf.composites.composite_model.CompositeModel.material_operators", + "title": "material_operators > material_operators > material_operators", + "section": "material_operators > material_operators", + "text": "property CompositeModel.material_operators: MaterialOperators\n\nMaterial operators.\n\nReturn type\n\nMaterialOperators\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2c", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2c.html#s2c", - "title": "s2c", - "section": "s2c", - "text": "s2c" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.failure_modes", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.failure_modes.html#failure_modes", + "title": "failure_modes", + "section": "failure_modes", + "text": "Critical failure mode of each ply.\nSequence[str]\nfailure_modes\nSequence\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2c", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2c.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s2c", - "title": "s2c > s2c > s2c", - "section": "s2c > s2c", - "text": "FailureModeEnum.s2c = 222\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.failure_modes", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.failure_modes.html#ansys.dpf.composites.sampling_point.SamplingPoint.failure_modes", + "title": "failure_modes > failure_modes > failure_modes", + "section": "failure_modes > failure_modes", + "text": "property SamplingPoint.failure_modes: Sequence[str]\n\nCritical failure mode of each ply.\n\nReturn type\n\nSequence[str]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.format_map", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.format_map.html#format_map", - "title": "format_map", - "section": "format_map", - "text": "Return a formatted version of the string, using substitutions from mapping.\nThe substitutions are identified by braces (‘{’ and ‘}’).\nformat_map" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.honeycomb_core_coeff", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.honeycomb_core_coeff.html#honeycomb_core_coeff", + "title": "honeycomb_core_coeff", + "section": "honeycomb_core_coeff", + "text": "Wrinkling coefficient (reduction factor) for honeycombs. The default is 0.33.\nfloat\nhoneycomb_core_coeff\n0.33\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.format_map", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.format_map.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.format_map", - "title": "format_map > format_map > format_map", - "section": "format_map > format_map", - "text": "FailureMeasureEnum.format_map(mapping, /)\n\nReturn a formatted version of the string, using substitutions from mapping.\nThe substitutions are identified by braces (‘{’ and ‘}’).\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.honeycomb_core_coeff", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.honeycomb_core_coeff.html#ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.honeycomb_core_coeff", + "title": "honeycomb_core_coeff > honeycomb_core_coeff > honeycomb_core_coeff", + "section": "honeycomb_core_coeff > honeycomb_core_coeff", + "text": "property FaceSheetWrinklingCriterion.honeycomb_core_coeff: float\n\nWrinkling coefficient (reduction factor) for honeycombs. The default is 0.33.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/014_cyclic_symmetry_example", - "href": "examples/gallery_examples/014_cyclic_symmetry_example.html#cyclic-symmetry", - "title": "Cyclic symmetry", - "section": "Cyclic symmetry", - "text": "This example shows how to postprocess a cyclic symmetry analysis.\nThe initial (original) sector can be postprocessed with the same tools\nas a standard analysis. The postprocessing workflow is demonstrated by\nrunning a failure analysis, extracting ply-wise stresses, and implementing\na custom failure criterion.\nThe postprocessing of expanded sectors is not yet supported.\nWhen using a Workbench project,\nuse the composite_files_from_workbench_harmonic_analysis()\nmethod to obtain the input files.\nCyclic symmetry\ncomposite_files_from_workbench_harmonic_analysis()" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isalpha", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isalpha.html#isalpha", + "title": "isalpha", + "section": "isalpha", + "text": "Return True if the string is an alphabetic string, False otherwise.\nA string is alphabetic if all characters in the string are alphabetic and there\nis at least one character in the string.\nisalpha" }, { - "objectID": "examples/gallery_examples/014_cyclic_symmetry_example", - "href": "examples/gallery_examples/014_cyclic_symmetry_example.html#set-up-analysis", - "title": "Cyclic symmetry > Set up analysis", - "section": "Set up analysis", - "text": "Setting up the analysis consists of loading the required modules, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries and helper functions.\nStart a DPF server and copy the example files into the current working directory.\nCreate a composite model.\nEvaluate a combined failure criterion.\nPlot the failure results.\nSet up analysis" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isalpha", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isalpha.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isalpha", + "title": "isalpha > isalpha > isalpha", + "section": "isalpha > isalpha", + "text": "FailureMeasureEnum.isalpha(/)\n\nReturn True if the string is an alphabetic string, False otherwise.\n\nA string is alphabetic if all characters in the string are alphabetic and there\nis at least one character in the string.\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/014_cyclic_symmetry_example", - "href": "examples/gallery_examples/014_cyclic_symmetry_example.html#plot-ply-wise-stresses", - "title": "Cyclic symmetry > Plot ply-wise stresses", - "section": "Plot ply-wise stresses", - "text": "All functions in PyDPF - Composites can be used to\npostprocess the initial (original) sector.\nPlot ply-wise stresses" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.name.html#name", + "title": "name", + "section": "name", + "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" }, { - "objectID": "examples/gallery_examples/014_cyclic_symmetry_example", - "href": "examples/gallery_examples/014_cyclic_symmetry_example.html#custom-failure-criterion", - "title": "Cyclic symmetry > Custom failure criterion", - "section": "Custom failure criterion", - "text": "The following code block shows how to implement a custom failure criterion.\nIt computes the inverse reserve factor for each element with respect to\nfiber failure. The criterion distinguishes between tension and compression.\nCustom failure criterion" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.name.html#ansys.dpf.composites.failure_criteria.PuckCriterion.name", + "title": "name > name > name", + "section": "name > name", + "text": "property PuckCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/014_cyclic_symmetry_example", - "href": "examples/gallery_examples/014_cyclic_symmetry_example.html#plot-deformations-on-the-expanded-model", - "title": "Cyclic symmetry > Plot deformations on the expanded model", - "section": "Plot deformations on the expanded model", - "text": "You can expand the deformations of the cyclic symmetry model as shown below.\nThe same expansion is possible for strains and stresses. For more information, see Ansys DPF.\nTotal running time of the script: (0 minutes 5.728 seconds)\nDownload Jupyter notebook: 014_cyclic_symmetry_example.ipynb\nDownload Python source code: 014_cyclic_symmetry_example.py\nDownload zipped: 014_cyclic_symmetry_example.zip\nGallery generated by Sphinx-Gallery\nPlot deformations on the expanded model\nDownload Jupyter notebook: 014_cyclic_symmetry_example.ipynb\nDownload Python source code: 014_cyclic_symmetry_example.py\nDownload zipped: 014_cyclic_symmetry_example.zip" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.insert", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.insert.html#insert", + "title": "insert", + "section": "insert", + "text": "Add a failure criterion to a list of selected criteria.\nfc (FailureCriterionBase) – Failure criterion to add. If a failure criterion of the same type\nalready exists, it is overwritten.\nNone\ninsert\nFailureCriterionBase\nNone" }, { - "objectID": "examples/gallery_examples/013_thermal_example", - "href": "examples/gallery_examples/013_thermal_example.html#thermal-analysis", - "title": "Thermal analysis", - "section": "Thermal analysis", - "text": "This example shows how to evaluate a thermal analysis.\nThe simulation’s thermal analysis results are also\nthe input of a structural analysis.\nTherefore, the RST file contains temperature and structural results.\nThe example imitates a printed circuit board (PCB) that was\nmodeled with Ansys Composites PrepPost (ACP), using the solid model feature to\ngenerate the volume mesh.\nDescriptions of how to extract temperatures for a specific ply\nand material are provided.\nWhen using a Workbench project,\nuse the get_composite_files_from_workbench_result_folder()\nmethod to obtain the input files.\nThermal analysis\nget_composite_files_from_workbench_result_folder()" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.insert", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.insert.html#ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.insert", + "title": "insert > insert > insert", + "section": "insert > insert", + "text": "CombinedFailureCriterion.insert(fc)\n\nAdd a failure criterion to a list of selected criteria.\n\nParameters\n\nfc (FailureCriterionBase) – Failure criterion to add. If a failure criterion of the same type\nalready exists, it is overwritten.\n\nExamples\n\n>>> combined_failure = CombinedFailureCriterion(\"max_stress 3D\")\n>>> max_stress = MaxStressCriterion(s1=True, s2=True, s3=True,\n s12=True, s13=True, s23=True)\n>>> combined_failure.insert(max_stress)\n\nReturn type\n\nNone\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/013_thermal_example", - "href": "examples/gallery_examples/013_thermal_example.html#set-up-analysis", - "title": "Thermal analysis > Set up analysis", - "section": "Set up analysis", - "text": "Setting up the analysis consists of loading the required modules, connecting to the\nDPF server, and retrieving the example files.\nSet up analysis" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.files_are_local", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.files_are_local.html#files_are_local", + "title": "files_are_local", + "section": "files_are_local", + "text": "files_are_local" }, { - "objectID": "examples/gallery_examples/013_thermal_example", - "href": "examples/gallery_examples/013_thermal_example.html#initialize-the-model", - "title": "Thermal analysis > Initialize the model", - "section": "Initialize the model", - "text": "Initialize the composite model with the composite files and server.\nThe model provides access to the mesh, results, lay-up, and materials.\nInitialize the model" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.files_are_local", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.files_are_local.html#ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.files_are_local", + "title": "files_are_local > files_are_local > files_are_local", + "section": "files_are_local > files_are_local", + "text": "ShortFiberCompositesFiles.files_are_local: bool = True\n\n" }, { - "objectID": "examples/gallery_examples/013_thermal_example", - "href": "examples/gallery_examples/013_thermal_example.html#get-temperature-results", - "title": "Thermal analysis > Get temperature results", - "section": "Get temperature results", - "text": "The temperatures are stored under structural_temperature.\nGet temperature results\nstructural_temperature" + "objectID": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices_by_dpf_material_ids", + "href": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices_by_dpf_material_ids.html#get_selected_indices_by_dpf_material_ids", + "title": "get_selected_indices_by_dpf_material_ids", + "section": "get_selected_indices_by_dpf_material_ids", + "text": "Get selected indices by DPF material IDs.\nThis method selects all indices that are in a layer with one of the selected materials.\nelement_info (ElementInfo) – Lay-up information for the element.\ndpf_material_ids (Collection[int64]) – Collection of DPF materials.\nSelected elementary indices\nNDArray[int64]\nget_selected_indices_by_dpf_material_ids\nCollection\nint64" }, { - "objectID": "examples/gallery_examples/013_thermal_example", - "href": "examples/gallery_examples/013_thermal_example.html#get-ply-results", - "title": "Thermal analysis > Get ply results", - "section": "Get ply results", - "text": "Extract the ply-wise results by passing the ply name\nto the function get_ply_wise_data().\nGet ply results\nget_ply_wise_data()" + "objectID": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices_by_dpf_material_ids", + "href": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices_by_dpf_material_ids.html#ansys.dpf.composites.select_indices.get_selected_indices_by_dpf_material_ids", + "title": "get_selected_indices_by_dpf_material_ids > get_selected_indices_by_dpf_material_ids > get_selected_indices_by_dpf_material_ids", + "section": "get_selected_indices_by_dpf_material_ids > get_selected_indices_by_dpf_material_ids", + "text": "ansys.dpf.composites.select_indices.get_selected_indices_by_dpf_material_ids(element_info, dpf_material_ids)\n\nGet selected indices by DPF material IDs.\n\nThis method selects all indices that are in a layer with one of the selected materials.\n\nParameters\n\nelement_info (ElementInfo) – Lay-up information for the element.\n\ndpf_material_ids (Collection[int64]) – Collection of DPF materials.\n\nReturns\n\nSelected elementary indices\n\nReturn type\n\nNDArray[int64]\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/013_thermal_example", - "href": "examples/gallery_examples/013_thermal_example.html#get-results-by-material", - "title": "Thermal analysis > Get results by material", - "section": "Get results by material", - "text": "You can filter the results by material.\nIn this example, the element-wise maximum temperature\nis extracted for the material Honeycomb Aluminum Alloy.\nTotal running time of the script: (0 minutes 4.427 seconds)\nDownload Jupyter notebook: 013_thermal_example.ipynb\nDownload Python source code: 013_thermal_example.py\nDownload zipped: 013_thermal_example.zip\nGallery generated by Sphinx-Gallery\nGet results by material\nDownload Jupyter notebook: 013_thermal_example.ipynb\nDownload Python source code: 013_thermal_example.py\nDownload zipped: 013_thermal_example.zip" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2t", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2t.html#s2t", + "title": "s2t", + "section": "s2t", + "text": "s2t" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.name.html#name", - "title": "name", - "section": "name", - "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2t", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2t.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s2t", + "title": "s2t > s2t > s2t", + "section": "s2t > s2t", + "text": "FailureModeEnum.s2t = 221\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.name.html#ansys.dpf.composites.failure_criteria.TsaiWuCriterion.name", - "title": "name > name > name", - "section": "name > name", - "text": "property TsaiWuCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices", + "href": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices.html#get_selected_indices", + "title": "get_selected_indices", + "section": "get_selected_indices", + "text": "Get elementary indices based on element information, layers, nodes, and spots.\nelement_info (ElementInfo) – Lay-up information for the element.\nlayers (Optional[Collection[int]], default: None) – List of selected layers.\nnodes (Optional[Collection[int]], default: None) – List of selected corner nodes.\nspots (Optional[Collection[Spot]], default: None) – List of selected spots.\ndisable_checks (bool, default: False) – Whether to disable checks. Set to True to disable checks.\nDisabling checks results in better performance but potentially\ncryptic error messages or invalid indices.\nArray of selected indices.\nNDArray\nReturns an empty selection if any of the collections is empty.\nThe indices (nodes, layers, and spots) are 0-based. Pay attention to this\nwhen using the “composite::minmax_per_element_operator” or\nevaluate_failure_criteria\nwhere the min/max layer indices\nare 1-based starting with Workbench 2024 R1 (DPF server 7.1).\nget_selected_indices\nElementInfo\nOptional\nCollection\nint\nNone\nOptional\nCollection\nint\nNone\nOptional\nCollection\nSpot\nNone\nbool\nFalse\nTrue\nevaluate_failure_criteria" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.html#continuousfibercompositesfiles", - "title": "ContinuousFiberCompositesFiles", - "section": "ContinuousFiberCompositesFiles", - "text": "Provides the container for continuous fiber composite file paths.\nContinuousFiberCompositesFiles.files_are_local\n\nContinuousFiberCompositesFiles.rst\n\nContinuousFiberCompositesFiles.composite\n\nContinuousFiberCompositesFiles.engineering_data\n\nContinuousFiberCompositesFiles\nContinuousFiberCompositesFiles.files_are_local\nContinuousFiberCompositesFiles.rst\nContinuousFiberCompositesFiles.composite\nContinuousFiberCompositesFiles.engineering_data" + "objectID": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices", + "href": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices.html#ansys.dpf.composites.select_indices.get_selected_indices", + "title": "get_selected_indices > get_selected_indices > get_selected_indices", + "section": "get_selected_indices > get_selected_indices", + "text": "ansys.dpf.composites.select_indices.get_selected_indices(element_info, layers=None, nodes=None, spots=None, disable_checks=False)\n\nGet elementary indices based on element information, layers, nodes, and spots.\n\nParameters\n\nelement_info (ElementInfo) – Lay-up information for the element.\n\nlayers (Optional[Collection[int]], default: None) – List of selected layers.\n\nnodes (Optional[Collection[int]], default: None) – List of selected corner nodes.\n\nspots (Optional[Collection[Spot]], default: None) – List of selected spots.\n\ndisable_checks (bool, default: False) – Whether to disable checks. Set to True to disable checks.\nDisabling checks results in better performance but potentially\ncryptic error messages or invalid indices.\n\nReturns\n\nArray of selected indices.\n\nReturn type\n\nNDArray\n\nNotes\n\nReturns an empty selection if any of the collections is empty.\n\nThe indices (nodes, layers, and spots) are 0-based. Pay attention to this\nwhen using the “composite::minmax_per_element_operator” or\nevaluate_failure_criteria\nwhere the min/max layer indices\nare 1-based starting with Workbench 2024 R1 (DPF server 7.1).\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.html#ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles", - "title": "ContinuousFiberCompositesFiles > ContinuousFiberCompositesFiles > ContinuousFiberCompositesFiles", - "section": "ContinuousFiberCompositesFiles > ContinuousFiberCompositesFiles", - "text": "class ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles(rst, composite, engineering_data, files_are_local=True)\n\nProvides the container for continuous fiber composite file paths.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nContinuousFiberCompositesFiles.files_are_local\n\n\n\nContinuousFiberCompositesFiles.rst\n\n\n\nContinuousFiberCompositesFiles.composite\n\n\n\nContinuousFiberCompositesFiles.engineering_data\n\n\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1t", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1t.html#e1t", + "title": "e1t", + "section": "e1t", + "text": "e1t" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1t", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1t.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e1t", + "title": "e1t > e1t > e1t", + "section": "e1t > e1t", + "text": "FailureModeEnum.e1t = 111\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.endswith", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.endswith.html#endswith", - "title": "endswith", - "section": "endswith", - "text": "Return True if the string ends with the specified suffix, False otherwise.\nA string or a tuple of strings to try.\nOptional start position. Default: start of the string.\nOptional stop position. Default: end of the string.\nendswith" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_layup_operator", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_layup_operator.html#get_layup_operator", + "title": "get_layup_operator", + "section": "get_layup_operator", + "text": "Get the lay-up operator.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nOperator\nget_layup_operator\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nOperator" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.endswith", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.endswith.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.endswith", - "title": "endswith > endswith > endswith", - "section": "endswith > endswith", - "text": "FailureMeasureEnum.endswith(suffix, [start, [end]], /)\n\nReturn True if the string ends with the specified suffix, False otherwise.\n\nsuffix\n\nA string or a tuple of strings to try.\n\nstart\n\nOptional start position. Default: start of the string.\n\nend\n\nOptional stop position. Default: end of the string.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_layup_operator", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_layup_operator.html#ansys.dpf.composites.composite_model.CompositeModel.get_layup_operator", + "title": "get_layup_operator > get_layup_operator > get_layup_operator", + "section": "get_layup_operator > get_layup_operator", + "text": "CompositeModel.get_layup_operator(composite_definition_label=None)\n\nGet the lay-up operator.\n\nParameters\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\n\nReturn type\n\nOperator\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/010_harmonic_example", - "href": "examples/gallery_examples/010_harmonic_example.html#postprocess-a-harmonic-analysis", - "title": "Postprocess a harmonic analysis", - "section": "Postprocess a harmonic analysis", - "text": "This example shows how to evaluate failure criteria for a harmonic simulation.\nIt shows how to create a phase sweep to compute the maximum IRF in the frequency-phase\nspace and shows how to identify the critical failure mode and the critical layer.\nWhen using a Workbench project,\nuse the composite_files_from_workbench_harmonic_analysis()\nmethod to obtain the input files.\nPostprocess a harmonic analysis\ncomposite_files_from_workbench_harmonic_analysis()" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.html#materialproperty", + "title": "MaterialProperty", + "section": "MaterialProperty", + "text": "Provides the material properties that are available.\nMaterialProperty.Engineering_Constants_E1\n\nMaterialProperty.Engineering_Constants_E2\n\nMaterialProperty.Engineering_Constants_E3\n\nMaterialProperty.Engineering_Constants_E\n\nMaterialProperty.Engineering_Constants_G12\n\nMaterialProperty.Engineering_Constants_G23\n\nMaterialProperty.Engineering_Constants_G13\n\nMaterialProperty.Engineering_Constants_nu12\n\nMaterialProperty.Engineering_Constants_nu23\n\nMaterialProperty.Engineering_Constants_nu13\n\nMaterialProperty.Engineering_Constants_nu\n\nMaterialProperty.Strain_Limits_effective_strain\n\nMaterialProperty.Tensile_Yield_Strength_effective_stress\n\nMaterialProperty.Strain_Limits_eXt\n\nMaterialProperty.Strain_Limits_eYt\n\nMaterialProperty.Strain_Limits_eZt\n\nMaterialProperty.Strain_Limits_eXc\n\nMaterialProperty.Strain_Limits_eYc\n\nMaterialProperty.Strain_Limits_eZc\n\nMaterialProperty.Strain_Limits_eSxy\n\nMaterialProperty.Strain_Limits_eSyz\n\nMaterialProperty.Strain_Limits_eSxz\n\nMaterialProperty.Stress_Limits_Xt\n\nMaterialProperty.Stress_Limits_Yt\n\nMaterialProperty.Stress_Limits_Zt\n\nMaterialProperty.Stress_Limits_Xc\n\nMaterialProperty.Stress_Limits_Yc\n\nMaterialProperty.Stress_Limits_Zc\n\nMaterialProperty.Stress_Limits_Sxy\n\nMaterialProperty.Stress_Limits_Syz\n\nMaterialProperty.Stress_Limits_Sxz\n\nMaterialProperty.Thermal_Conductivity_K\n\nMaterialProperty.Thermal_Conductivity_K1\n\nMaterialProperty.Thermal_Conductivity_K2\n\nMaterialProperty.Thermal_Conductivity_K3\n\nMaterialProperty.Specific_Heat_cp\n\nMaterialProperty.Thermal_Expansion_Coefficients_a\n\nMaterialProperty.Thermal_Expansion_Coefficients_aX\n\nMaterialProperty.Thermal_Expansion_Coefficients_aY\n\nMaterialProperty.Thermal_Expansion_Coefficients_aZ\n\nMaterialProperty.Fabric_Fiber_Angle_phi\n\nMaterialProperty.Hill_Yield_Criterion_R11\n\nMaterialProperty.Hill_Yield_Criterion_R22\n\nMaterialProperty.Hill_Yield_Criterion_R33\n\nMaterialProperty.Hill_Yield_Criterion_R12\n\nMaterialProperty.Hill_Yield_Criterion_R23\n\nMaterialProperty.Hill_Yield_Criterion_R13\n\nMaterialProperty.Tsai_Wu_Constant_xy\n\nMaterialProperty.Tsai_Wu_Constant_yz\n\nMaterialProperty.Tsai_Wu_Constant_xz\n\nMaterialProperty.Puck_Constants_p_21_pos\n\nMaterialProperty.Puck_Constants_p_21_neg\n\nMaterialProperty.Puck_Constants_p_22_pos\n\nMaterialProperty.Puck_Constants_p_22_neg\n\nMaterialProperty.Puck_Constants_s\n\nMaterialProperty.Puck_Constants_m\n\nMaterialProperty.Puck_Constants_interface_weakening_factor\n\nMaterialProperty.Larc_Constants_fracture_angle_under_compression\n\nMaterialProperty.Larc_Constants_fracture_toughness_ratio\n\nMaterialProperty.Larc_Constants_fracture_toughness_mode_1\n\nMaterialProperty.Larc_Constants_fracture_toughness_mode_2\n\nMaterialProperty\nMaterialProperty.Engineering_Constants_E1\nMaterialProperty.Engineering_Constants_E2\nMaterialProperty.Engineering_Constants_E3\nMaterialProperty.Engineering_Constants_E\nMaterialProperty.Engineering_Constants_G12\nMaterialProperty.Engineering_Constants_G23\nMaterialProperty.Engineering_Constants_G13\nMaterialProperty.Engineering_Constants_nu12\nMaterialProperty.Engineering_Constants_nu23\nMaterialProperty.Engineering_Constants_nu13\nMaterialProperty.Engineering_Constants_nu\nMaterialProperty.Strain_Limits_effective_strain\nMaterialProperty.Tensile_Yield_Strength_effective_stress\nMaterialProperty.Strain_Limits_eXt\nMaterialProperty.Strain_Limits_eYt\nMaterialProperty.Strain_Limits_eZt\nMaterialProperty.Strain_Limits_eXc\nMaterialProperty.Strain_Limits_eYc\nMaterialProperty.Strain_Limits_eZc\nMaterialProperty.Strain_Limits_eSxy\nMaterialProperty.Strain_Limits_eSyz\nMaterialProperty.Strain_Limits_eSxz\nMaterialProperty.Stress_Limits_Xt\nMaterialProperty.Stress_Limits_Yt\nMaterialProperty.Stress_Limits_Zt\nMaterialProperty.Stress_Limits_Xc\nMaterialProperty.Stress_Limits_Yc\nMaterialProperty.Stress_Limits_Zc\nMaterialProperty.Stress_Limits_Sxy\nMaterialProperty.Stress_Limits_Syz\nMaterialProperty.Stress_Limits_Sxz\nMaterialProperty.Thermal_Conductivity_K\nMaterialProperty.Thermal_Conductivity_K1\nMaterialProperty.Thermal_Conductivity_K2\nMaterialProperty.Thermal_Conductivity_K3\nMaterialProperty.Specific_Heat_cp\nMaterialProperty.Thermal_Expansion_Coefficients_a\nMaterialProperty.Thermal_Expansion_Coefficients_aX\nMaterialProperty.Thermal_Expansion_Coefficients_aY\nMaterialProperty.Thermal_Expansion_Coefficients_aZ\nMaterialProperty.Fabric_Fiber_Angle_phi\nMaterialProperty.Hill_Yield_Criterion_R11\nMaterialProperty.Hill_Yield_Criterion_R22\nMaterialProperty.Hill_Yield_Criterion_R33\nMaterialProperty.Hill_Yield_Criterion_R12\nMaterialProperty.Hill_Yield_Criterion_R23\nMaterialProperty.Hill_Yield_Criterion_R13\nMaterialProperty.Tsai_Wu_Constant_xy\nMaterialProperty.Tsai_Wu_Constant_yz\nMaterialProperty.Tsai_Wu_Constant_xz\nMaterialProperty.Puck_Constants_p_21_pos\nMaterialProperty.Puck_Constants_p_21_neg\nMaterialProperty.Puck_Constants_p_22_pos\nMaterialProperty.Puck_Constants_p_22_neg\nMaterialProperty.Puck_Constants_s\nMaterialProperty.Puck_Constants_m\nMaterialProperty.Puck_Constants_interface_weakening_factor\nMaterialProperty.Larc_Constants_fracture_angle_under_compression\nMaterialProperty.Larc_Constants_fracture_toughness_ratio\nMaterialProperty.Larc_Constants_fracture_toughness_mode_1\nMaterialProperty.Larc_Constants_fracture_toughness_mode_2" }, { - "objectID": "examples/gallery_examples/010_harmonic_example", - "href": "examples/gallery_examples/010_harmonic_example.html#set-up-analysis", - "title": "Postprocess a harmonic analysis > Set up analysis", - "section": "Set up analysis", - "text": "Setting up the analysis consists of loading the required modules, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries and matplotlib\nStart a DPF server and copy the example files into the current working directory.\nCreate a composite model\nDefine a failure criterion\nSet up analysis" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty", + "title": "MaterialProperty > MaterialProperty > MaterialProperty", + "section": "MaterialProperty > MaterialProperty", + "text": "class ansys.dpf.composites.layup_info.material_properties.MaterialProperty(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nProvides the material properties that are available.\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nMaterialProperty.Engineering_Constants_E1\n\n\n\nMaterialProperty.Engineering_Constants_E2\n\n\n\nMaterialProperty.Engineering_Constants_E3\n\n\n\nMaterialProperty.Engineering_Constants_E\n\n\n\nMaterialProperty.Engineering_Constants_G12\n\n\n\nMaterialProperty.Engineering_Constants_G23\n\n\n\nMaterialProperty.Engineering_Constants_G13\n\n\n\nMaterialProperty.Engineering_Constants_nu12\n\n\n\nMaterialProperty.Engineering_Constants_nu23\n\n\n\nMaterialProperty.Engineering_Constants_nu13\n\n\n\nMaterialProperty.Engineering_Constants_nu\n\n\n\nMaterialProperty.Strain_Limits_effective_strain\n\n\n\nMaterialProperty.Tensile_Yield_Strength_effective_stress\n\n\n\nMaterialProperty.Strain_Limits_eXt\n\n\n\nMaterialProperty.Strain_Limits_eYt\n\n\n\nMaterialProperty.Strain_Limits_eZt\n\n\n\nMaterialProperty.Strain_Limits_eXc\n\n\n\nMaterialProperty.Strain_Limits_eYc\n\n\n\nMaterialProperty.Strain_Limits_eZc\n\n\n\nMaterialProperty.Strain_Limits_eSxy\n\n\n\nMaterialProperty.Strain_Limits_eSyz\n\n\n\nMaterialProperty.Strain_Limits_eSxz\n\n\n\nMaterialProperty.Stress_Limits_Xt\n\n\n\nMaterialProperty.Stress_Limits_Yt\n\n\n\nMaterialProperty.Stress_Limits_Zt\n\n\n\nMaterialProperty.Stress_Limits_Xc\n\n\n\nMaterialProperty.Stress_Limits_Yc\n\n\n\nMaterialProperty.Stress_Limits_Zc\n\n\n\nMaterialProperty.Stress_Limits_Sxy\n\n\n\nMaterialProperty.Stress_Limits_Syz\n\n\n\nMaterialProperty.Stress_Limits_Sxz\n\n\n\nMaterialProperty.Thermal_Conductivity_K\n\n\n\nMaterialProperty.Thermal_Conductivity_K1\n\n\n\nMaterialProperty.Thermal_Conductivity_K2\n\n\n\nMaterialProperty.Thermal_Conductivity_K3\n\n\n\nMaterialProperty.Specific_Heat_cp\n\n\n\nMaterialProperty.Thermal_Expansion_Coefficients_a\n\n\n\nMaterialProperty.Thermal_Expansion_Coefficients_aX\n\n\n\nMaterialProperty.Thermal_Expansion_Coefficients_aY\n\n\n\nMaterialProperty.Thermal_Expansion_Coefficients_aZ\n\n\n\nMaterialProperty.Fabric_Fiber_Angle_phi\n\n\n\nMaterialProperty.Hill_Yield_Criterion_R11\n\n\n\nMaterialProperty.Hill_Yield_Criterion_R22\n\n\n\nMaterialProperty.Hill_Yield_Criterion_R33\n\n\n\nMaterialProperty.Hill_Yield_Criterion_R12\n\n\n\nMaterialProperty.Hill_Yield_Criterion_R23\n\n\n\nMaterialProperty.Hill_Yield_Criterion_R13\n\n\n\nMaterialProperty.Tsai_Wu_Constant_xy\n\n\n\nMaterialProperty.Tsai_Wu_Constant_yz\n\n\n\nMaterialProperty.Tsai_Wu_Constant_xz\n\n\n\nMaterialProperty.Puck_Constants_p_21_pos\n\n\n\nMaterialProperty.Puck_Constants_p_21_neg\n\n\n\nMaterialProperty.Puck_Constants_p_22_pos\n\n\n\nMaterialProperty.Puck_Constants_p_22_neg\n\n\n\nMaterialProperty.Puck_Constants_s\n\n\n\nMaterialProperty.Puck_Constants_m\n\n\n\nMaterialProperty.Puck_Constants_interface_weakening_factor\n\n\n\nMaterialProperty.Larc_Constants_fracture_angle_under_compression\n\n\n\nMaterialProperty.Larc_Constants_fracture_toughness_ratio\n\n\n\nMaterialProperty.Larc_Constants_fracture_toughness_mode_1\n\n\n\nMaterialProperty.Larc_Constants_fracture_toughness_mode_2\n\n\n\n" }, { - "objectID": "examples/gallery_examples/010_harmonic_example", - "href": "examples/gallery_examples/010_harmonic_example.html#obtain-stresses-and-strains-and-compute-max-irf-over-all-phases-and-frequencies", - "title": "Postprocess a harmonic analysis > Obtain stresses and strains and compute max IRF over all phases and frequencies", - "section": "Obtain stresses and strains and compute max IRF over all phases and frequencies", - "text": "Get complex stresses and strains at all frequencies\nGet operators that provide material data\nDefine the frequency sweep. This is relatively coarse so the example does not take\ntoo much time.\nInitialize result containers. We create a result container for the failure value,\nthe failure mode and the layer index in which the failure occurs.\nLoop over all the phases and evaluate the failure criterion.\nThe result is added to the field containers declared in the previous cell.\nIn the end each container contains a field for each combination of frequency\nand phase\nCompute maximum over all the phases and frequencies for each element and plot the resulting\nIRF values\nObtain stresses and strains and compute max IRF over all phases and frequencies" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.active.html#active", + "title": "active", + "section": "active", + "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" }, { - "objectID": "examples/gallery_examples/010_harmonic_example", - "href": "examples/gallery_examples/010_harmonic_example.html#detailed-analysis-of-the-critical-element", - "title": "Postprocess a harmonic analysis > Detailed analysis of the critical element", - "section": "Detailed analysis of the critical element", - "text": "Identify the element with the maximum IRF\nScope container with all frequencies and phases to critical element so we can plot\nthe critical IRF over all the frequencies\nCompute the maximum IRF over all the phases for each frequency and plot the result for\nthe critical element. Note: this can be different from maximum overall IRF\nat each frequency, because we look only at the element that has the highest IRF overall.\nCompute the critical phase\nCompute critical layer and critical failure mode.\nTotal running time of the script: (0 minutes 10.117 seconds)\nDownload Jupyter notebook: 010_harmonic_example.ipynb\nDownload Python source code: 010_harmonic_example.py\nDownload zipped: 010_harmonic_example.zip\nGallery generated by Sphinx-Gallery\nDetailed analysis of the critical element\nDownload Jupyter notebook: 010_harmonic_example.ipynb\nDownload Python source code: 010_harmonic_example.py\nDownload zipped: 010_harmonic_example.zip" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.active.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.active", + "title": "active > active > active", + "section": "active > active", + "text": "property LaRCCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lmt", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lmt.html#lmt", - "title": "lmt", - "section": "lmt", - "text": "Whether to activate the failure evaluation of the matrix due to tension.\nbool\nlmt\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.c", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.c.html#c", + "title": "c", + "section": "c", + "text": "c" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lmt", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lmt.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.lmt", - "title": "lmt > lmt > lmt", - "section": "lmt > lmt", - "text": "property LaRCCriterion.lmt: bool\n\nWhether to activate the failure evaluation of the matrix due to tension.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.c", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.c.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.c", + "title": "c > c > c", + "section": "c > c", + "text": "FailureModeEnum.c = 1000\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.composite", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.composite.html#composite", - "title": "composite", - "section": "composite", - "text": "composite" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.plies", + "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.plies.html#plies", + "title": "plies", + "section": "plies", + "text": "plies" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.composite", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.composite.html#ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.composite", - "title": "composite > composite > composite", - "section": "composite > composite", - "text": "ContinuousFiberCompositesFiles.composite: dict[str, CompositeDefinitionFiles]\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.plies", + "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.plies.html#ansys.dpf.composites.composite_scope.CompositeScope.plies", + "title": "plies > plies > plies", + "section": "plies > plies", + "text": "CompositeScope.plies: Sequence[str] | None = None\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZc.html#ezc", - "title": "eZc", - "section": "eZc", - "text": "Global compressive strain limit in material direction 3.\nfloat\neZc\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.element_type", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.element_type.html#element_type", + "title": "element_type", + "section": "element_type", + "text": "element_type" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZc.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZc", - "title": "eZc > eZc > eZc", - "section": "eZc > eZc", - "text": "property MaxStrainCriterion.eZc: float\n\nGlobal compressive strain limit in material direction 3.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.element_type", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.element_type.html#ansys.dpf.composites.layup_info.ElementInfo.element_type", + "title": "element_type > element_type > element_type", + "section": "element_type > element_type", + "text": "ElementInfo.element_type: int\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmC", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmC.html#pmc", - "title": "pmC", - "section": "pmC", - "text": "pmC" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R33", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R33.html#hill_yield_criterion_r33", + "title": "Hill_Yield_Criterion_R33", + "section": "Hill_Yield_Criterion_R33", + "text": "Hill_Yield_Criterion_R33" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmC", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmC.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.pmC", - "title": "pmC > pmC > pmC", - "section": "pmC > pmC", - "text": "FailureModeEnum.pmC = 804\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R33", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R33.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R33", + "title": "Hill_Yield_Criterion_R33 > Hill_Yield_Criterion_R33 > Hill_Yield_Criterion_R33", + "section": "Hill_Yield_Criterion_R33 > Hill_Yield_Criterion_R33", + "text": "MaterialProperty.Hill_Yield_Criterion_R33: str = 'yield_stress_ratio_z_hill_criterion'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.M", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.M.html#m", - "title": "M", - "section": "M", - "text": "Specifies the effect of fiber parallel stresses regarding inter-fiber failure. M = [0, 1). The default is 0.5.\nfloat\nM\n0.5\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.html#layuppropertiesprovider", + "title": "LayupPropertiesProvider", + "section": "LayupPropertiesProvider", + "text": "Provider for lay-up properties.\nSome properties such as layered dpf_material_ids and\ninformation about the element type are available\nthrough the ElementInfoProvider.\nlayup_provider (Operator) – Use add_layup_info_to_mesh() to obtain a lay-up provider.\nmesh (MeshedRegion)\nLayupPropertiesProvider.get_analysis_plies(...)\nGet analysis ply names.\nLayupPropertiesProvider.get_element_laminate_offset(...)\nGet laminate offset of element.\nLayupPropertiesProvider.get_layer_angles(...)\nGet angles for all layers.\nLayupPropertiesProvider.get_layer_shear_angles(...)\nGet shear angle for all layers.\nLayupPropertiesProvider.get_layer_thicknesses(...)\nGet thicknesses for all layers.\nLayupPropertiesProvider\nElementInfoProvider\nOperator\nadd_layup_info_to_mesh()\nMeshedRegion\nLayupPropertiesProvider.get_analysis_plies\nLayupPropertiesProvider.get_element_laminate_offset\nLayupPropertiesProvider.get_layer_angles\nLayupPropertiesProvider.get_layer_shear_angles\nLayupPropertiesProvider.get_layer_thicknesses" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.M", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.M.html#ansys.dpf.composites.failure_criteria.PuckCriterion.M", - "title": "M > M > M", - "section": "M > M", - "text": "property PuckCriterion.M: float\n\nSpecifies the effect of fiber parallel stresses regarding inter-fiber failure. M = [0, 1). The default is 0.5.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.html#ansys.dpf.composites.layup_info.LayupPropertiesProvider", + "title": "LayupPropertiesProvider > LayupPropertiesProvider > LayupPropertiesProvider", + "section": "LayupPropertiesProvider > LayupPropertiesProvider", + "text": "class ansys.dpf.composites.layup_info.LayupPropertiesProvider(layup_provider, mesh)\n\nProvider for lay-up properties.\n\nSome properties such as layered dpf_material_ids and\ninformation about the element type are available\nthrough the ElementInfoProvider.\n\nParameters\n\nlayup_provider (Operator) – Use add_layup_info_to_mesh() to obtain a lay-up provider.\n\nmesh (MeshedRegion)\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nLayupPropertiesProvider.get_analysis_plies(...)\n\nGet analysis ply names.\n\nLayupPropertiesProvider.get_element_laminate_offset(...)\n\nGet laminate offset of element.\n\nLayupPropertiesProvider.get_layer_angles(...)\n\nGet angles for all layers.\n\nLayupPropertiesProvider.get_layer_shear_angles(...)\n\nGet shear angle for all layers.\n\nLayupPropertiesProvider.get_layer_thicknesses(...)\n\nGet thicknesses for all layers.\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.time", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.time.html#time", - "title": "time", - "section": "time", - "text": "Time or solution step.\nDPF Composites automatically selects the last time step if time is not set.\nYou can use the CompositeModel.get_result_times_or_frequencies() method\nto list the available times or frequencies in the result file.\nOptional[float]\ntime\nCompositeModel.get_result_times_or_frequencies()\nOptional\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s3", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s3.html#s3", + "title": "s3", + "section": "s3", + "text": "Stresses in the material 3 direction of each ply.\nndarray[Any, dtype[float64]]\ns3\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.time", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.time.html#ansys.dpf.composites.result_definition.ResultDefinition.time", - "title": "time > time > time", - "section": "time > time", - "text": "property ResultDefinition.time: float | None\n\nTime or solution step.\n\nDPF Composites automatically selects the last time step if time is not set.\n\nYou can use the CompositeModel.get_result_times_or_frequencies() method\nto list the available times or frequencies in the result file.\n\nReturn type\n\nOptional[float]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s3", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s3.html#ansys.dpf.composites.sampling_point.SamplingPoint.s3", + "title": "s3 > s3 > s3", + "section": "s3 > s3", + "text": "property SamplingPoint.s3: ndarray[Any, dtype[float64]]\n\nStresses in the material 3 direction of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.add_interlaminar_normal_stresses", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.add_interlaminar_normal_stresses.html#add_interlaminar_normal_stresses", - "title": "add_interlaminar_normal_stresses", - "section": "add_interlaminar_normal_stresses", - "text": "Add interlaminar normal stresses to the stresses fields container.\nInterlaminar normal stresses (s3) are not available for layered shells.\nThis function performs a post-processing step which computes s3 and adds\nit to the stress field. s3 is automatically computed if a formulation\nof a failure criterion depends on this stress component, for instance\nPuck 3D .\nFor a usage example, see\nsphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py.\nstresses (FieldsContainer) – Stresses fields container to add interlaminar normal stresses to.\nstrains (FieldsContainer)\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nInterlaminar normal stresses are only added to the layered elements defined\nin the specified composite definition.\nNone\nadd_interlaminar_normal_stresses\nPuck 3D\nFieldsContainer\nFieldsContainer\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nNone" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.wf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.wf.html#wf", + "title": "wf", + "section": "wf", + "text": "Weighting factor of the failure mode (wb or wt). The default is 0.5.\nfloat\nwf\n0.5\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.add_interlaminar_normal_stresses", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.add_interlaminar_normal_stresses.html#ansys.dpf.composites.composite_model.CompositeModel.add_interlaminar_normal_stresses", - "title": "add_interlaminar_normal_stresses > add_interlaminar_normal_stresses > add_interlaminar_normal_stresses", - "section": "add_interlaminar_normal_stresses > add_interlaminar_normal_stresses", - "text": "CompositeModel.add_interlaminar_normal_stresses(stresses, strains, composite_definition_label=None)\n\nAdd interlaminar normal stresses to the stresses fields container.\n\nInterlaminar normal stresses (s3) are not available for layered shells.\nThis function performs a post-processing step which computes s3 and adds\nit to the stress field. s3 is automatically computed if a formulation\nof a failure criterion depends on this stress component, for instance\nPuck 3D .\n\nFor a usage example, see\nsphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py.\n\nParameters\n\nstresses (FieldsContainer) – Stresses fields container to add interlaminar normal stresses to.\n\nstrains (FieldsContainer)\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nInterlaminar normal stresses are only added to the layered elements defined\nin the specified composite definition.\n\nReturn type\n\nNone\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.wf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.wf.html#ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.wf", + "title": "wf > wf > wf", + "section": "wf > wf", + "text": "property FaceSheetWrinklingCriterion.wf: float\n\nWeighting factor of the failure mode (wb or wt). The default is 0.5.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_sampling_point", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_sampling_point.html#get_sampling_point", - "title": "get_sampling_point", - "section": "get_sampling_point", - "text": "Get a sampling point for an element ID and failure criteria.\ncombined_criterion (CombinedFailureCriterion) – Combined failure criterion to evaluate.\nelement_id (int) – Element ID or label of the sampling point.\ntime (Optional[float], default: None) – Time or frequency at which to evaluate the sampling point. If None,\nthe last time or frequency in the result file is used.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nSamplingPoint\nget_sampling_point\nCombinedFailureCriterion\nint\nOptional\nfloat\nNone\nNone\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nSamplingPoint" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_SOLID_ELEMENT_ID", + "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_SOLID_ELEMENT_ID.html#max_solid_element_id", + "title": "MAX_SOLID_ELEMENT_ID", + "section": "MAX_SOLID_ELEMENT_ID", + "text": "MAX_SOLID_ELEMENT_ID" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_sampling_point", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_sampling_point.html#ansys.dpf.composites.composite_model.CompositeModel.get_sampling_point", - "title": "get_sampling_point > get_sampling_point > get_sampling_point", - "section": "get_sampling_point > get_sampling_point", - "text": "CompositeModel.get_sampling_point(combined_criterion, element_id, time=None, composite_definition_label=None)\n\nGet a sampling point for an element ID and failure criteria.\n\nParameters\n\ncombined_criterion (CombinedFailureCriterion) – Combined failure criterion to evaluate.\n\nelement_id (int) – Element ID or label of the sampling point.\n\ntime (Optional[float], default: None) – Time or frequency at which to evaluate the sampling point. If None,\nthe last time or frequency in the result file is used.\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\n\nReturn type\n\nSamplingPoint\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_SOLID_ELEMENT_ID", + "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_SOLID_ELEMENT_ID.html#ansys.dpf.composites.constants.FailureOutput.MAX_SOLID_ELEMENT_ID", + "title": "MAX_SOLID_ELEMENT_ID > MAX_SOLID_ELEMENT_ID > MAX_SOLID_ELEMENT_ID", + "section": "MAX_SOLID_ELEMENT_ID > MAX_SOLID_ELEMENT_ID", + "text": "FailureOutput.MAX_SOLID_ELEMENT_ID = 7\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s12", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s12.html#s12", - "title": "s12", - "section": "s12", - "text": "Whether to activate the failure evaluation regarding the in-plane shear stress s12.\nbool\ns12\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.server_helpers.load_composites_plugin", + "href": "api/_autosummary/ansys.dpf.composites.server_helpers.load_composites_plugin.html#load_composites_plugin", + "title": "load_composites_plugin", + "section": "load_composites_plugin", + "text": "Load composites plugins and its dependencies.\nserver (BaseServer)\nansys_path (Optional[str], default: None) – Ansys root path, for example C:\\Program Files\\ANSYS Inc\\v232.\nIf None, it is assumed that all the plugins and their dependencies\nare found in the PATH/LD_LIBRARY_PATH. If ansys_path\nis set, the composite_operators and\nAns.Dpf.EngineeringData plugins are loaded from their location\nin the installer.\nNone\nload_composites_plugin\nBaseServer\nOptional\nstr\nNone\nNone" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s12", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s12.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.s12", - "title": "s12 > s12 > s12", - "section": "s12 > s12", - "text": "property MaxStressCriterion.s12: bool\n\nWhether to activate the failure evaluation regarding the in-plane shear stress s12.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.server_helpers.load_composites_plugin", + "href": "api/_autosummary/ansys.dpf.composites.server_helpers.load_composites_plugin.html#ansys.dpf.composites.server_helpers.load_composites_plugin", + "title": "load_composites_plugin > load_composites_plugin > load_composites_plugin", + "section": "load_composites_plugin > load_composites_plugin", + "text": "ansys.dpf.composites.server_helpers.load_composites_plugin(server, ansys_path=None)\n\nLoad composites plugins and its dependencies.\n\nParameters\n\nserver (BaseServer)\n\nansys_path (Optional[str], default: None) – Ansys root path, for example C:\\Program Files\\ANSYS Inc\\v232.\nIf None, it is assumed that all the plugins and their dependencies\nare found in the PATH/LD_LIBRARY_PATH. If ansys_path\nis set, the composite_operators and\nAns.Dpf.EngineeringData plugins are loaded from their location\nin the installer.\n\nReturn type\n\nNone\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/004_get_material_properties_example", - "href": "examples/gallery_examples/004_get_material_properties_example.html#material-properties-and-custom-failure-criterion", - "title": "Material properties and custom failure criterion", - "section": "Material properties and custom failure criterion", - "text": "This example shows how to access constant material properties and how to\nimplement a custom failure criterion. The failure criterion is computed for\nall layers and integration points. Finally, the elemental maximum is computed and shown.\nOnly constant material properties are currently supported.\nWhen using a Workbench project,\nuse the get_composite_files_from_workbench_result_folder()\nmethod to obtain the input files.\nMaterial properties and custom failure criterion\nget_composite_files_from_workbench_result_folder()" + "objectID": "index", + "href": "index.html#pydpf---composites", + "title": "PyDPF - Composites", + "section": "PyDPF - Composites", + "text": "PyDPF - Composites enables the post-processing of composite structures based on\nAnsys DPF and the DPF Composites plugin. It implements\nclasses on top of DPF Composites operators and data accessors for short\nfiber and layered composites (layered shell and solid elements). This module\ncan be used to postprocess fiber reinforced plastics and layered composites, and\nto implement custom failure criteria and computation.\nContains installation instructions and a simple\nexample to create a failure plot from a Workbench project.\nDemonstrates the use of PyDPF - Composites for various workflows.\nDescribes the public Python classes, methods, and functions.\nProvides developer installation and usage information.\nThe minimum set of inputs to run a postprocessing for composites is the result files of an\nMAPDL solution and a material file (MATML) which was generated by Engineering Data.\nLay-up files from ACP are optional and only required for some advanced operations. Refer to\nLimitations.\nPyDPF - Composites" + }, + { + "objectID": "index", + "href": "index.html#key-features", + "title": "PyDPF - Composites > Key features", + "section": "Key features", + "text": "Here are some key features of PyDPF - Composites:\nPostprocessing of layered shell and solid elements. MAPDL models as well as models preprocessed with ACP are supported.\nFailure criteria evaluation as shown in Composite failure analysis.\nA SamplingPoint class for extracting and visualizing a result over the entire thickness of a laminate as shown in\nSampling point.\nA ResultDefinition class for configuring combined failure criteria and scopes.\nAccessors for getting layered properties such as plies and materials as shown in\nLayered properties\nand Material properties and custom failure criterion.\nInterface to implement custom failure criteria and analysis as shown in\nMaterial properties and custom failure criterion.\nPostprocessing of homogeneous elements.\nKey features\nSamplingPoint\nResultDefinition" }, { - "objectID": "examples/gallery_examples/004_get_material_properties_example", - "href": "examples/gallery_examples/004_get_material_properties_example.html#script", - "title": "Material properties and custom failure criterion > Script", - "section": "Script", - "text": "Import dependencies\nStart a server and get the examples files.\nThis will copy the example files into the current working directory.\nSet up the composite model\nGet dictionary that maps dpf_material_id to properties\nThe creation of the dictionary is currently quite slow and\nshould be done before using the properties in a loop.\nCurrently only constant properties are supported.\nFor variable material properties, the default value is returned.\nGet strain field\nImplement a custom failure criterion: basic max strain\nTotal running time of the script: (0 minutes 3.523 seconds)\nDownload Jupyter notebook: 004_get_material_properties_example.ipynb\nDownload Python source code: 004_get_material_properties_example.py\nDownload zipped: 004_get_material_properties_example.zip\nGallery generated by Sphinx-Gallery\nScript\nDownload Jupyter notebook: 004_get_material_properties_example.ipynb\nDownload Python source code: 004_get_material_properties_example.py\nDownload zipped: 004_get_material_properties_example.zip" + "objectID": "index", + "href": "index.html#limitations", + "title": "PyDPF - Composites > Limitations", + "section": "Limitations", + "text": "Only the Mechanical APDL solver is supported.\nThe post-processing of expanded cyclic symmetry models is not implemented.\nThe following operators and features are only supported if the model was\npreprocessed with ACP and if the corresponding lay-up definition file is passed to the CompositeModel class.\nThe evaluation of the failure criteria for sandwich\n(FaceSheetWrinklingCriterion,\nShearCrimpingCriterion)\nfor solid elements. Layered shell elements are always supported.\nThe computation of interlaminar normal stresses (s3) for layered shell elements.\nWithout ACP layup definitions, s3 is always zero. This also affects 3D failure criteria which use s3,\nsuch as Puck 3D. This limitation does not affect (layered) solid elements.\nThe support of variable materials and material fields. Without ACP, only the\ntemperature is considered for the evaluation of variable material properties.\nGlobal plies, and scoping by plies. Layer-wise post-processing is always supported.\nPlotting results on the reference surface of a laminate.\nNote: MAPDL models that have not been preprocessed with ACP can be converted. For more\ninformation, see Import of Legacy Mechanical APDL Composite Models in the Ansys Help.\nLimitations\nCompositeModel\nFaceSheetWrinklingCriterion\nShearCrimpingCriterion" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.active.html#active", - "title": "active", - "section": "active", - "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZt", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZt.html#ezt", + "title": "eZt", + "section": "eZt", + "text": "Global strain limit in material direction 3.\nfloat\neZt\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.active.html#ansys.dpf.composites.failure_criteria.PuckCriterion.active", - "title": "active > active > active", - "section": "active > active", - "text": "property PuckCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZt", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZt.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eZt", + "title": "eZt > eZt > eZt", + "section": "eZt > eZt", + "text": "property MaxStrainCriterion.eZt: float\n\nGlobal strain limit in material direction 3.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_files", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_files.html#composite_files", - "title": "composite_files", - "section": "composite_files", - "text": "Get the composite file paths on the server.\nContinuousFiberCompositesFiles\ncomposite_files\nContinuousFiberCompositesFiles" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.layup_model_type", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.layup_model_type.html#layup_model_type", + "title": "layup_model_type", + "section": "layup_model_type", + "text": "Get the context type of the lay-up model.\nThe type specifies whether the lay-up data was loaded from an ACP model, RST, or both.\nType can be one of the following values: NOT_AVAILABLE, ACP, RST, MIXED.\nLayupModelContextType\nlayup_model_type\nNOT_AVAILABLE\nACP\nRST\nMIXED\nLayupModelContextType" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_files", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_files.html#ansys.dpf.composites.composite_model.CompositeModel.composite_files", - "title": "composite_files > composite_files > composite_files", - "section": "composite_files > composite_files", - "text": "property CompositeModel.composite_files: ContinuousFiberCompositesFiles\n\nGet the composite file paths on the server.\n\nReturn type\n\nContinuousFiberCompositesFiles\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.layup_model_type", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.layup_model_type.html#ansys.dpf.composites.composite_model.CompositeModel.layup_model_type", + "title": "layup_model_type > layup_model_type > layup_model_type", + "section": "layup_model_type > layup_model_type", + "text": "property CompositeModel.layup_model_type: LayupModelContextType\n\nGet the context type of the lay-up model.\n\nThe type specifies whether the lay-up data was loaded from an ACP model, RST, or both.\nType can be one of the following values: NOT_AVAILABLE, ACP, RST, MIXED.\n\nReturn type\n\nLayupModelContextType\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.html#maxstraincriterion", - "title": "MaxStrainCriterion", - "section": "MaxStrainCriterion", - "text": "Defines the maximum strain failure criterion for orthotropic reinforced materials.\ne1 (bool, default: True) – Activates the failure evaluation regarding the strain in the material 1 direction.\ne2 (bool, default: True) – Activates the failure evaluation regarding the strain in the material 2 direction.\ne3 (bool, default: False) – Activates the failure evaluation regarding the strain in the material 3 direction (out-of-plane).\ne12 (bool, default: True) – Whether to activate the failure evaluation regarding the in-plane shear strain e12.\ne13 (bool, default: False) – Whether to activate the failure evaluation regarding the interlaminar shear strain e13.\ne23 (bool, default: False) – Whether to activate the failure evaluation regarding the interlaminar shear strain e23.\nwf_e1 (float, default: 1.0) – Weighting factor of the failure mode e1.\nwf_e2 (float, default: 1.0) – Weighting factor of the failure mode e2.\nwf_e3 (float, default: 1.0) – Weighting factor of the failure mode e3.\nwf_e12 (float, default: 1.0) – Weighting factor of the failure mode e12.\nwf_e13 (float, default: 1.0) – Weighting factor of the failure mode e13.\nwf_e23 (float, default: 1.0) – Weighting factor of the failure mode e23.\neXt (float, default: 0.0) – Global tensile strain limit in material direction 1.\neXc (float, default: 0.0) – Global compressive strain limit in material direction 1.\neYt (float, default: 0.0) – Global tensile strain limit in material direction 2.\neYc (float, default: 0.0) – Global compressive strain limit in material direction 2.\neZt (float, default: 0.0) – Global strain limit in material direction 3.\neZc (float, default: 0.0) – Global compressive strain limit in material direction 3.\neSxy (float, default: 0.0) – Global strain limit in material direction 12.\neSxz (float, default: 0.0) – Global strain limit in material direction 13.\neSyz (float, default: 0.0) – Global strain limit in material direction 23.\nMaxStrainCriterion.to_dict()\n\nMaxStrainCriterion.to_json()\n\nMaxStrainCriterion.active\nThe failure criterion is suppressed if active is False.\nMaxStrainCriterion.e1\nActivates the failure evaluation regarding the strain in the material 1 direction.\nMaxStrainCriterion.e12\nWhether to activate the failure evaluation regarding the in-plane shear strain e12.\nMaxStrainCriterion.e13\nWhether to activate the failure evaluation regarding the interlaminar shear strain e13.\nMaxStrainCriterion.e2\nActivates the failure evaluation regarding the strain in the material 2 direction.\nMaxStrainCriterion.e23\nWhether to activate the failure evaluation regarding the interlaminar shear strain e23.\nMaxStrainCriterion.e3\nActivates the failure evaluation regarding the strain in the material 3 direction (out-of-plane).\nMaxStrainCriterion.eSxy\nGlobal strain limit in material direction 12.\nMaxStrainCriterion.eSxz\nGlobal strain limit in material direction 13.\nMaxStrainCriterion.eSyz\nGlobal strain limit in material direction 23.\nMaxStrainCriterion.eXc\nGlobal compressive strain limit in material direction 1.\nMaxStrainCriterion.eXt\nGlobal tensile strain limit in material direction 1.\nMaxStrainCriterion.eYc\nGlobal compressive strain limit in material direction 1.\nMaxStrainCriterion.eYt\nGlobal tensile strain limit in material direction 2.\nMaxStrainCriterion.eZc\nGlobal compressive strain limit in material direction 3.\nMaxStrainCriterion.eZt\nGlobal strain limit in material direction 3.\nMaxStrainCriterion.force_global_strain_limits\nWhether to use one set of global strain limits instead of the strain limits of the materials.\nMaxStrainCriterion.name\nName of the failure criterion.\nMaxStrainCriterion.wf_e1\nWeighting factor of the failure mode e1.\nMaxStrainCriterion.wf_e12\nWeighting factor of the failure mode e12.\nMaxStrainCriterion.wf_e13\nWeighting factor of the failure mode e13.\nMaxStrainCriterion.wf_e2\nWeighting factor of the failure mode e2.\nMaxStrainCriterion.wf_e23\nWeighting factor of the failure mode e23.\nMaxStrainCriterion.wf_e3\nWeighting factor of the failure mode e3.\nMaxStrainCriterion\nbool\nTrue\nbool\nTrue\nbool\nFalse\nbool\nTrue\nbool\nFalse\nbool\nFalse\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n0.0\nfloat\n0.0\nfloat\n0.0\nfloat\n0.0\nfloat\n0.0\nfloat\n0.0\nfloat\n0.0\nfloat\n0.0\nfloat\n0.0\nMaxStrainCriterion.to_dict\nMaxStrainCriterion.to_json\nMaxStrainCriterion.active\nMaxStrainCriterion.e1\nMaxStrainCriterion.e12\nMaxStrainCriterion.e13\nMaxStrainCriterion.e2\nMaxStrainCriterion.e23\nMaxStrainCriterion.e3\nMaxStrainCriterion.eSxy\nMaxStrainCriterion.eSxz\nMaxStrainCriterion.eSyz\nMaxStrainCriterion.eXc\nMaxStrainCriterion.eXt\nMaxStrainCriterion.eYc\nMaxStrainCriterion.eYt\nMaxStrainCriterion.eZc\nMaxStrainCriterion.eZt\nMaxStrainCriterion.force_global_strain_limits\nMaxStrainCriterion.name\nMaxStrainCriterion.wf_e1\nMaxStrainCriterion.wf_e12\nMaxStrainCriterion.wf_e13\nMaxStrainCriterion.wf_e2\nMaxStrainCriterion.wf_e23\nMaxStrainCriterion.wf_e3" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfoProvider", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfoProvider.html#elementinfoprovider", + "title": "ElementInfoProvider", + "section": "ElementInfoProvider", + "text": "Provider for ElementInfo.\nUse get_element_info_provider() to create ElementInfoProvider\nobjects.\nInitialize the class before a loop and\ncall get_element_info() for each element.\nNote that the ElementInfoProvider class is not fully supported for\ndistributed RST files. The get_element_info() method will raise an\nexception if the DPF server version does not support reading the required\ninformation.\nmesh (MeshedRegion)\nlayer_indices (PropertyField)\nelement_types_apdl (PropertyField)\nelement_types_dpf (PropertyField)\nkeyopt_8_values (PropertyField)\nkeyopt_3_values (PropertyField)\nmaterial_ids (PropertyField)\nno_bounds_checks (bool, default: False) – Disable bounds checks.\nResults in better performance but potentially cryptic\nerror messages\nElementInfoProvider.get_element_info(element_id)\nGet ElementInfo for a given element id.\nElementInfoProvider\nElementInfo\nget_element_info_provider()\nElementInfoProvider\nget_element_info()\nElementInfoProvider\nget_element_info()\nMeshedRegion\nPropertyField\nPropertyField\nPropertyField\nPropertyField\nPropertyField\nPropertyField\nbool\nFalse\nElementInfoProvider.get_element_info\nElementInfo" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion", - "title": "MaxStrainCriterion > MaxStrainCriterion > MaxStrainCriterion", - "section": "MaxStrainCriterion > MaxStrainCriterion", - "text": "class ansys.dpf.composites.failure_criteria.MaxStrainCriterion(*, e1=True, e2=True, e3=False, e12=True, e13=False, e23=False, wf_e1=1.0, wf_e2=1.0, wf_e3=1.0, wf_e12=1.0, wf_e13=1.0, wf_e23=1.0, force_global_strain_limits=False, eXt=0.0, eXc=0.0, eYt=0.0, eYc=0.0, eZt=0.0, eZc=0.0, eSxy=0.0, eSxz=0.0, eSyz=0.0)\n\nDefines the maximum strain failure criterion for orthotropic reinforced materials.\n\nParameters\n\ne1 (bool, default: True) – Activates the failure evaluation regarding the strain in the material 1 direction.\n\ne2 (bool, default: True) – Activates the failure evaluation regarding the strain in the material 2 direction.\n\ne3 (bool, default: False) – Activates the failure evaluation regarding the strain in the material 3 direction (out-of-plane).\n\ne12 (bool, default: True) – Whether to activate the failure evaluation regarding the in-plane shear strain e12.\n\ne13 (bool, default: False) – Whether to activate the failure evaluation regarding the interlaminar shear strain e13.\n\ne23 (bool, default: False) – Whether to activate the failure evaluation regarding the interlaminar shear strain e23.\n\nwf_e1 (float, default: 1.0) – Weighting factor of the failure mode e1.\n\nwf_e2 (float, default: 1.0) – Weighting factor of the failure mode e2.\n\nwf_e3 (float, default: 1.0) – Weighting factor of the failure mode e3.\n\nwf_e12 (float, default: 1.0) – Weighting factor of the failure mode e12.\n\nwf_e13 (float, default: 1.0) – Weighting factor of the failure mode e13.\n\nwf_e23 (float, default: 1.0) – Weighting factor of the failure mode e23.\n\neXt (float, default: 0.0) – Global tensile strain limit in material direction 1.\n\neXc (float, default: 0.0) – Global compressive strain limit in material direction 1.\n\neYt (float, default: 0.0) – Global tensile strain limit in material direction 2.\n\neYc (float, default: 0.0) – Global compressive strain limit in material direction 2.\n\neZt (float, default: 0.0) – Global strain limit in material direction 3.\n\neZc (float, default: 0.0) – Global compressive strain limit in material direction 3.\n\neSxy (float, default: 0.0) – Global strain limit in material direction 12.\n\neSxz (float, default: 0.0) – Global strain limit in material direction 13.\n\neSyz (float, default: 0.0) – Global strain limit in material direction 23.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nMaxStrainCriterion.to_dict()\n\n\n\nMaxStrainCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nMaxStrainCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nMaxStrainCriterion.e1\n\nActivates the failure evaluation regarding the strain in the material 1 direction.\n\nMaxStrainCriterion.e12\n\nWhether to activate the failure evaluation regarding the in-plane shear strain e12.\n\nMaxStrainCriterion.e13\n\nWhether to activate the failure evaluation regarding the interlaminar shear strain e13.\n\nMaxStrainCriterion.e2\n\nActivates the failure evaluation regarding the strain in the material 2 direction.\n\nMaxStrainCriterion.e23\n\nWhether to activate the failure evaluation regarding the interlaminar shear strain e23.\n\nMaxStrainCriterion.e3\n\nActivates the failure evaluation regarding the strain in the material 3 direction (out-of-plane).\n\nMaxStrainCriterion.eSxy\n\nGlobal strain limit in material direction 12.\n\nMaxStrainCriterion.eSxz\n\nGlobal strain limit in material direction 13.\n\nMaxStrainCriterion.eSyz\n\nGlobal strain limit in material direction 23.\n\nMaxStrainCriterion.eXc\n\nGlobal compressive strain limit in material direction 1.\n\nMaxStrainCriterion.eXt\n\nGlobal tensile strain limit in material direction 1.\n\nMaxStrainCriterion.eYc\n\nGlobal compressive strain limit in material direction 1.\n\nMaxStrainCriterion.eYt\n\nGlobal tensile strain limit in material direction 2.\n\nMaxStrainCriterion.eZc\n\nGlobal compressive strain limit in material direction 3.\n\nMaxStrainCriterion.eZt\n\nGlobal strain limit in material direction 3.\n\nMaxStrainCriterion.force_global_strain_limits\n\nWhether to use one set of global strain limits instead of the strain limits of the materials.\n\nMaxStrainCriterion.name\n\nName of the failure criterion.\n\nMaxStrainCriterion.wf_e1\n\nWeighting factor of the failure mode e1.\n\nMaxStrainCriterion.wf_e12\n\nWeighting factor of the failure mode e12.\n\nMaxStrainCriterion.wf_e13\n\nWeighting factor of the failure mode e13.\n\nMaxStrainCriterion.wf_e2\n\nWeighting factor of the failure mode e2.\n\nMaxStrainCriterion.wf_e23\n\nWeighting factor of the failure mode e23.\n\nMaxStrainCriterion.wf_e3\n\nWeighting factor of the failure mode e3.\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfoProvider", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfoProvider.html#ansys.dpf.composites.layup_info.ElementInfoProvider", + "title": "ElementInfoProvider > ElementInfoProvider > ElementInfoProvider", + "section": "ElementInfoProvider > ElementInfoProvider", + "text": "class ansys.dpf.composites.layup_info.ElementInfoProvider(mesh, layer_indices, element_types_apdl, element_types_dpf, keyopt_8_values, keyopt_3_values, material_ids, solver_material_ids=None, no_bounds_checks=False)\n\nProvider for ElementInfo.\n\nUse get_element_info_provider() to create ElementInfoProvider\nobjects.\n\nInitialize the class before a loop and\ncall get_element_info() for each element.\n\nNote that the ElementInfoProvider class is not fully supported for\ndistributed RST files. The get_element_info() method will raise an\nexception if the DPF server version does not support reading the required\ninformation.\n\nParameters\n\nmesh (MeshedRegion)\n\nlayer_indices (PropertyField)\n\nelement_types_apdl (PropertyField)\n\nelement_types_dpf (PropertyField)\n\nkeyopt_8_values (PropertyField)\n\nkeyopt_3_values (PropertyField)\n\nmaterial_ids (PropertyField)\n\nno_bounds_checks (bool, default: False) – Disable bounds checks.\nResults in better performance but potentially cryptic\nerror messages\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nElementInfoProvider.get_element_info(element_id)\n\nGet ElementInfo for a given element id.\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_all_dpf_material_ids", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_all_dpf_material_ids.html#get_all_dpf_material_ids", - "title": "get_all_dpf_material_ids", - "section": "get_all_dpf_material_ids", - "text": "Get all DPF material IDs.\nmesh (MeshedRegion) – DPF meshed region enriched with lay-up information.\ndata_source_or_streams_provider (DataSources | Operator) – DPF data source or stream provider that contains the RST file.\nCollection[int64]\nget_all_dpf_material_ids\nMeshedRegion\nDataSources\nOperator\nCollection\nint64" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_analysis_plies", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_analysis_plies.html#get_analysis_plies", + "title": "get_analysis_plies", + "section": "get_analysis_plies", + "text": "Get analysis ply names. Returns None if element is not layered.\nelement_id (int) – Element Id/Label\nOptional[Sequence[str]]\nget_analysis_plies\nint\nOptional\nSequence\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_all_dpf_material_ids", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_all_dpf_material_ids.html#ansys.dpf.composites.layup_info.material_properties.get_all_dpf_material_ids", - "title": "get_all_dpf_material_ids > get_all_dpf_material_ids > get_all_dpf_material_ids", - "section": "get_all_dpf_material_ids > get_all_dpf_material_ids", - "text": "ansys.dpf.composites.layup_info.material_properties.get_all_dpf_material_ids(mesh, data_source_or_streams_provider)\n\nGet all DPF material IDs.\n\nParameters\n\nmesh (MeshedRegion) – DPF meshed region enriched with lay-up information.\n\ndata_source_or_streams_provider (DataSources | Operator) – DPF data source or stream provider that contains the RST file.\n\nReturn type\n\nCollection[int64]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_analysis_plies", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_analysis_plies.html#ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_analysis_plies", + "title": "get_analysis_plies > get_analysis_plies > get_analysis_plies", + "section": "get_analysis_plies > get_analysis_plies", + "text": "LayupPropertiesProvider.get_analysis_plies(element_id)\n\nGet analysis ply names. Returns None if element is not layered.\n\nParameters\n\nelement_id (int) – Element Id/Label\n\nReturn type\n\nOptional[Sequence[str]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.wt", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.wt.html#wt", - "title": "wt", - "section": "wt", - "text": "wt" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.interface_weakening_factor", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.interface_weakening_factor.html#interface_weakening_factor", + "title": "interface_weakening_factor", + "section": "interface_weakening_factor", + "text": "Multiplicator for the interlaminar strength if failure mode pd is active. The default is 0.8.\nfloat\ninterface_weakening_factor\npd\n0.8\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.wt", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.wt.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.wt", - "title": "wt > wt > wt", - "section": "wt > wt", - "text": "FailureModeEnum.wt = 322\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.interface_weakening_factor", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.interface_weakening_factor.html#ansys.dpf.composites.failure_criteria.PuckCriterion.interface_weakening_factor", + "title": "interface_weakening_factor > interface_weakening_factor > interface_weakening_factor", + "section": "interface_weakening_factor > interface_weakening_factor", + "text": "property PuckCriterion.interface_weakening_factor: float\n\nMultiplicator for the interlaminar strength if failure mode pd is active. The default is 0.8.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.name.html#name", - "title": "name", - "section": "name", - "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.ply_type", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.ply_type.html#ply_type", + "title": "ply_type", + "section": "ply_type", + "text": "ply_type" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.name.html#ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.name", - "title": "name > name > name", - "section": "name > name", - "text": "property ShearCrimpingCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.ply_type", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.ply_type.html#ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.ply_type", + "title": "ply_type > ply_type > ply_type", + "section": "ply_type > ply_type", + "text": "MaterialMetadata.ply_type: str | None = None\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.vms", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.vms.html#vms", - "title": "vms", - "section": "vms", - "text": "Whether to activate the von Mises stress criterion.\nbool\nvms\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MIN", + "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MIN.html#min", + "title": "MIN", + "section": "MIN", + "text": "MIN" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.vms", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.vms.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.vms", - "title": "vms > vms > vms", - "section": "vms > vms", - "text": "property VonMisesCriterion.vms: bool\n\nWhether to activate the von Mises stress criterion.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MIN", + "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MIN.html#ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MIN", + "title": "MIN > MIN > MIN", + "section": "MIN > MIN", + "text": "SpotReductionStrategy.MIN = 'MIN'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.active.html#active", - "title": "active", - "section": "active", - "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" + "objectID": "examples/index", + "href": "examples/index.html#examples", + "title": "Examples", + "section": "Examples", + "text": "These examples demonstrate the behavior and usage of PyDPF - Composites.\nsphx_glr_examples_gallery_examples_001_failure_operator_example.py\nsphx_glr_examples_gallery_examples_002_sampling_point_example.py\nsphx_glr_examples_gallery_examples_003_short_fiber_example.py\nsphx_glr_examples_gallery_examples_004_get_material_properties_example.py\nsphx_glr_examples_gallery_examples_005_get_layup_properties_example.py\nsphx_glr_examples_gallery_examples_006_filter_composite_data_example.py\nsphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py\nsphx_glr_examples_gallery_examples_008_assembly_example.py\nsphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py\nsphx_glr_examples_gallery_examples_010_harmonic_example.py\nsphx_glr_examples_gallery_examples_011_rst_workflow.py\nsphx_glr_examples_gallery_examples_012_fatigue_example.py\nsphx_glr_examples_gallery_examples_013_thermal_example.py\nsphx_glr_examples_gallery_examples_014_cyclic_symmetry_example.py\nsphx_glr_examples_gallery_examples_099_dpf_composite_failure_workflow.py\nGallery generated by Sphinx-Gallery\nExamples" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.active.html#ansys.dpf.composites.failure_criteria.TsaiWuCriterion.active", - "title": "active > active > active", - "section": "active > active", - "text": "property TsaiWuCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.html#corefailurecriterion", + "title": "CoreFailureCriterion", + "section": "CoreFailureCriterion", + "text": "Defines the core shear failure criterion for\ncore materials like foam and honeycomb.\ninclude_ins (bool, default: False) – Whether to activate the formulation that considers interlaminar normal stresses.\nwf (float, default: 1.0) – Weighting factor of the failure mode (cs).\nCoreFailureCriterion.to_dict()\n\nCoreFailureCriterion.to_json()\n\nCoreFailureCriterion.active\nThe failure criterion is suppressed if active is False.\nCoreFailureCriterion.include_ins\nWhether to activate the formulation that considers interlaminar normal stresses.\nCoreFailureCriterion.name\nName of the failure criterion.\nCoreFailureCriterion.wf\nWeighting factor of the failure mode (cs).\nCoreFailureCriterion\nbool\nFalse\nfloat\n1.0\nCoreFailureCriterion.to_dict\nCoreFailureCriterion.to_json\nCoreFailureCriterion.active\nCoreFailureCriterion.include_ins\nCoreFailureCriterion.name\nCoreFailureCriterion.wf" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Fabric_Fiber_Angle_phi", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Fabric_Fiber_Angle_phi.html#fabric_fiber_angle_phi", - "title": "Fabric_Fiber_Angle_phi", - "section": "Fabric_Fiber_Angle_phi", - "text": "Fabric_Fiber_Angle_phi" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.html#ansys.dpf.composites.failure_criteria.CoreFailureCriterion", + "title": "CoreFailureCriterion > CoreFailureCriterion > CoreFailureCriterion", + "section": "CoreFailureCriterion > CoreFailureCriterion", + "text": "class ansys.dpf.composites.failure_criteria.CoreFailureCriterion(*, include_ins=False, wf=1.0)\n\nDefines the core shear failure criterion for\ncore materials like foam and honeycomb.\n\nParameters\n\ninclude_ins (bool, default: False) – Whether to activate the formulation that considers interlaminar normal stresses.\n\nwf (float, default: 1.0) – Weighting factor of the failure mode (cs).\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nCoreFailureCriterion.to_dict()\n\n\n\nCoreFailureCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nCoreFailureCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nCoreFailureCriterion.include_ins\n\nWhether to activate the formulation that considers interlaminar normal stresses.\n\nCoreFailureCriterion.name\n\nName of the failure criterion.\n\nCoreFailureCriterion.wf\n\nWeighting factor of the failure mode (cs).\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Fabric_Fiber_Angle_phi", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Fabric_Fiber_Angle_phi.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Fabric_Fiber_Angle_phi", - "title": "Fabric_Fiber_Angle_phi > Fabric_Fiber_Angle_phi > Fabric_Fiber_Angle_phi", - "section": "Fabric_Fiber_Angle_phi > Fabric_Fiber_Angle_phi", - "text": "MaterialProperty.Fabric_Fiber_Angle_phi: str = 'fabric_fiber_angle'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.name.html#name", + "title": "name", + "section": "name", + "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.partition", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.partition.html#partition", - "title": "partition", - "section": "partition", - "text": "Partition the string into three parts using the given separator.\nThis will search for the separator in the string. If the separator is found,\nreturns a 3-tuple containing the part before the separator, the separator\nitself, and the part after it.\nIf the separator is not found, returns a 3-tuple containing the original string\nand two empty strings.\npartition" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.name.html#ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.name", + "title": "name > name > name", + "section": "name > name", + "text": "property FaceSheetWrinklingCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.partition", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.partition.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.partition", - "title": "partition > partition > partition", - "section": "partition > partition", - "text": "FailureMeasureEnum.partition(sep, /)\n\nPartition the string into three parts using the given separator.\n\nThis will search for the separator in the string. If the separator is found,\nreturns a 3-tuple containing the part before the separator, the separator\nitself, and the part after it.\n\nIf the separator is not found, returns a 3-tuple containing the original string\nand two empty strings.\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/012_fatigue_example", + "href": "examples/gallery_examples/012_fatigue_example.html#evaluate-fatigue-for-a-composite-plate", + "title": "Evaluate fatigue for a composite plate", + "section": "Evaluate fatigue for a composite plate", + "text": "This example shows how to evaluate fatigue for a flat plate.\nIt shows how you can use PyPDF Composites to select specific layers and define a custom\ncombination method. For this example, the custom combination method is stress in fibre\ndirection.\nA random load time series is created. Taking into account that the load is assumed\nproportional, rainflow counting is applied to the load time series.\nLoad ranges are then applied on the stress combination method, and damage is evaluated\nby using a dummy S-N curve.\nBe aware that the fatpack package is not developed by Ansys, so it is the responsibility\nof the user to verify that it works as expected. For more information, see the\nfatpack package,\nWhen using a Workbench project,\nuse the composite_files_from_workbench_harmonic_analysis()\nmethod to obtain the input files.\nEvaluate fatigue for a composite plate\ncomposite_files_from_workbench_harmonic_analysis()" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.JSON_DICT_KEY", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.JSON_DICT_KEY.html#json_dict_key", - "title": "JSON_DICT_KEY", - "section": "JSON_DICT_KEY", - "text": "JSON_DICT_KEY" + "objectID": "examples/gallery_examples/012_fatigue_example", + "href": "examples/gallery_examples/012_fatigue_example.html#set-up-analysis", + "title": "Evaluate fatigue for a composite plate > Set up analysis", + "section": "Set up analysis", + "text": "Setting up the analysis consists of loading the required modules, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries and numpy, matplotlib and fatpack\nStart a DPF server and copy the example files into the current working directory.\nCreate a composite model\nSet up analysis" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.JSON_DICT_KEY", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.JSON_DICT_KEY.html#ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.JSON_DICT_KEY", - "title": "JSON_DICT_KEY > JSON_DICT_KEY > JSON_DICT_KEY", - "section": "JSON_DICT_KEY > JSON_DICT_KEY", - "text": "CombinedFailureCriterion.JSON_DICT_KEY = 'criteria'\n\n" + "objectID": "examples/gallery_examples/012_fatigue_example", + "href": "examples/gallery_examples/012_fatigue_example.html#read-stresses-and-define-a-specific-layer-and-a-component-of-stress-tensor", + "title": "Evaluate fatigue for a composite plate > Read stresses and define a specific layer and a component of stress tensor", + "section": "Read stresses and define a specific layer and a component of stress tensor", + "text": "Read stresses\nSelect layer P1L1__ModelingPly.2\nSelect Sigma11 as the combination method\nRead stresses and define a specific layer and a component of stress tensor" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2c", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2c.html#e2c", - "title": "e2c", - "section": "e2c", - "text": "e2c" + "objectID": "examples/gallery_examples/012_fatigue_example", + "href": "examples/gallery_examples/012_fatigue_example.html#load-time-series-and-apply-rainflow-counting", + "title": "Evaluate fatigue for a composite plate > Load time series and apply rainflow counting", + "section": "Load time series and apply rainflow counting", + "text": "A random time series is created. Load is assumed proportional, so rainflow counting\ncan be directly done on the load time series to get the load ranges.\nNo mean stress correction is applied.\nFatpack package is used for doing the rainflow counting\nLoad time series and apply rainflow counting" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2c", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2c.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e2c", - "title": "e2c > e2c > e2c", - "section": "e2c > e2c", - "text": "FailureModeEnum.e2c = 122\n\n" + "objectID": "examples/gallery_examples/012_fatigue_example", + "href": "examples/gallery_examples/012_fatigue_example.html#s-n-curve", + "title": "Evaluate fatigue for a composite plate > S-N curve", + "section": "S-N curve", + "text": "A dummy S-N curve is created. Note that this curve is not based on any\nexperimental data. Sc is chosen to be twice the orthotropic stress limit in the fiber direction.\nand Nc is set to 1.\nS-N curve" + }, + { + "objectID": "examples/gallery_examples/012_fatigue_example", + "href": "examples/gallery_examples/012_fatigue_example.html#damage-evaluation", + "title": "Evaluate fatigue for a composite plate > Damage evaluation", + "section": "Damage evaluation", + "text": "Stress S11 at time 1 and layer P1L1__ModelingPly.2 are read\nfor each load range. Its damage is evaluated using the dummy S-N curve.\nPlot damage\nDamage evaluation" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmc.html#wf_cmc", - "title": "wf_cmc", - "section": "wf_cmc", - "text": "Weighting factor of matrix failure due to compression or shear (cmc).\nfloat\nwf_cmc\nfloat" + "objectID": "examples/gallery_examples/012_fatigue_example", + "href": "examples/gallery_examples/012_fatigue_example.html#identify-the-element-with-the-maximum-damage", + "title": "Evaluate fatigue for a composite plate > Identify the element with the maximum damage", + "section": "Identify the element with the maximum damage", + "text": "Total running time of the script: (0 minutes 3.799 seconds)\nDownload Jupyter notebook: 012_fatigue_example.ipynb\nDownload Python source code: 012_fatigue_example.py\nDownload zipped: 012_fatigue_example.zip\nGallery generated by Sphinx-Gallery\nIdentify the element with the maximum damage\nDownload Jupyter notebook: 012_fatigue_example.ipynb\nDownload Python source code: 012_fatigue_example.py\nDownload zipped: 012_fatigue_example.zip" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmc.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmc", - "title": "wf_cmc > wf_cmc > wf_cmc", - "section": "wf_cmc > wf_cmc", - "text": "property CuntzeCriterion.wf_cmc: float\n\nWeighting factor of matrix failure due to compression or shear (cmc).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.scopes", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.scopes.html#scopes", + "title": "scopes", + "section": "scopes", + "text": "Scopes of the result definition.\nSequence[ResultDefinitionScope]\nscopes\nSequence\nResultDefinitionScope" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.failure_criteria", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.failure_criteria.html#failure_criteria", - "title": "failure_criteria", - "section": "failure_criteria", - "text": "List of failure criteria. Use insert and remove to edit the list.\ndict[str, FailureCriterionBase]\nfailure_criteria\ndict\nstr\nFailureCriterionBase" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.scopes", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.scopes.html#ansys.dpf.composites.result_definition.ResultDefinition.scopes", + "title": "scopes > scopes > scopes", + "section": "scopes > scopes", + "text": "property ResultDefinition.scopes: Sequence[ResultDefinitionScope]\n\nScopes of the result definition.\n\nReturn type\n\nSequence[ResultDefinitionScope]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.failure_criteria", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.failure_criteria.html#ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.failure_criteria", - "title": "failure_criteria > failure_criteria > failure_criteria", - "section": "failure_criteria > failure_criteria", - "text": "property CombinedFailureCriterion.failure_criteria: dict[str, FailureCriterionBase]\n\nList of failure criteria. Use insert and remove to edit the list.\n\nReturn type\n\ndict[str, FailureCriterionBase]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pf.html#pf", + "title": "pf", + "section": "pf", + "text": "Whether to activate the failure evaluation regarding fiber failure.\nbool\npf\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.lower", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.lower.html#lower", - "title": "lower", - "section": "lower", - "text": "Return a copy of the string converted to lowercase.\nlower" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pf.html#ansys.dpf.composites.failure_criteria.PuckCriterion.pf", + "title": "pf > pf > pf", + "section": "pf > pf", + "text": "property PuckCriterion.pf: bool\n\nWhether to activate the failure evaluation regarding fiber failure.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.lower", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.lower.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.lower", - "title": "lower > lower > lower", - "section": "lower > lower", - "text": "FailureMeasureEnum.lower(/)\n\nReturn a copy of the string converted to lowercase.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xc", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xc.html#stress_limits_xc", + "title": "Stress_Limits_Xc", + "section": "Stress_Limits_Xc", + "text": "Stress_Limits_Xc" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc6", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc6.html#lfc6", - "title": "lfc6", - "section": "lfc6", - "text": "lfc6" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xc", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xc.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xc", + "title": "Stress_Limits_Xc > Stress_Limits_Xc > Stress_Limits_Xc", + "section": "Stress_Limits_Xc > Stress_Limits_Xc", + "text": "MaterialProperty.Stress_Limits_Xc: str = 'stress_compressive_x_direction'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc6", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc6.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc6", - "title": "lfc6 > lfc6 > lfc6", - "section": "lfc6 > lfc6", - "text": "FailureModeEnum.lfc6 = 903\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.reserve_factor", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.reserve_factor.html#reserve_factor", + "title": "reserve_factor", + "section": "reserve_factor", + "text": "Lowest reserve factor of each ply.\nThis attribute is equivalent to the safety factor.\nndarray[Any, dtype[float64]]\nreserve_factor\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cft", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cft.html#wf_cft", - "title": "wf_cft", - "section": "wf_cft", - "text": "Weighting factor of fiber failure due to tension (cft).\nfloat\nwf_cft\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.reserve_factor", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.reserve_factor.html#ansys.dpf.composites.sampling_point.SamplingPoint.reserve_factor", + "title": "reserve_factor > reserve_factor > reserve_factor", + "section": "reserve_factor > reserve_factor", + "text": "property SamplingPoint.reserve_factor: ndarray[Any, dtype[float64]]\n\nLowest reserve factor of each ply.\n\nThis attribute is equivalent to the safety factor.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cft", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cft.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cft", - "title": "wf_cft > wf_cft > wf_cft", - "section": "wf_cft > wf_cft", - "text": "property CuntzeCriterion.wf_cft: float\n\nWeighting factor of fiber failure due to tension (cft).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xy", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xy.html#tsai_wu_constant_xy", + "title": "Tsai_Wu_Constant_xy", + "section": "Tsai_Wu_Constant_xy", + "text": "Tsai_Wu_Constant_xy" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.remove", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.remove.html#remove", - "title": "remove", - "section": "remove", - "text": "Remove a failure criterion.\nkey (str) – Name of the failure criterion.\nFailureCriterionBase\nRemoved failure criterion or None.\nremove\nstr\nFailureCriterionBase\nNone" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xy", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xy.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xy", + "title": "Tsai_Wu_Constant_xy > Tsai_Wu_Constant_xy > Tsai_Wu_Constant_xy", + "section": "Tsai_Wu_Constant_xy > Tsai_Wu_Constant_xy", + "text": "MaterialProperty.Tsai_Wu_Constant_xy: str = 'coupling_coef_xy_tsai_wu'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.remove", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.remove.html#ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.remove", - "title": "remove > remove > remove", - "section": "remove > remove", - "text": "CombinedFailureCriterion.remove(key)\n\nRemove a failure criterion.\n\nParameters\n\nkey (str) – Name of the failure criterion.\n\nReturn type\n\nFailureCriterionBase\n\nReturns\n\nRemoved failure criterion or None.\n\nExamples\n\n>>> combined_failure.remove(\"Max Stress\")\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.SHEAR_ANGLES", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.SHEAR_ANGLES.html#shear_angles", + "title": "SHEAR_ANGLES", + "section": "SHEAR_ANGLES", + "text": "SHEAR_ANGLES" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.active.html#active", - "title": "active", - "section": "active", - "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.SHEAR_ANGLES", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.SHEAR_ANGLES.html#ansys.dpf.composites.layup_info.LayerProperty.SHEAR_ANGLES", + "title": "SHEAR_ANGLES > SHEAR_ANGLES > SHEAR_ANGLES", + "section": "SHEAR_ANGLES > SHEAR_ANGLES", + "text": "LayerProperty.SHEAR_ANGLES = 2\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.active.html#ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.active", - "title": "active > active > active", - "section": "active > active", - "text": "property FaceSheetWrinklingCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.wf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.wf.html#wf", + "title": "wf", + "section": "wf", + "text": "Weighting factor of this failure criterion.\nfloat\nwf\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e23", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e23.html#e23", - "title": "e23", - "section": "e23", - "text": "Out-of-plane shear strains e23 of each ply.\nndarray[Any, dtype[float64]]\ne23\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.wf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.wf.html#ansys.dpf.composites.failure_criteria.TsaiHillCriterion.wf", + "title": "wf > wf > wf", + "section": "wf > wf", + "text": "property TsaiHillCriterion.wf: float\n\nWeighting factor of this failure criterion.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e23", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e23.html#ansys.dpf.composites.sampling_point.SamplingPoint.e23", - "title": "e23 > e23 > e23", - "section": "e23 > e23", - "text": "property SamplingPoint.e23: ndarray[Any, dtype[float64]]\n\nOut-of-plane shear strains e23 of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_shear_angles", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_shear_angles.html#get_layer_shear_angles", + "title": "get_layer_shear_angles", + "section": "get_layer_shear_angles", + "text": "Get shear angle for all layers. Returns None if element is not layered.\nelement_id (int) – Element Id/Label\nOptional[ndarray[Any, dtype[float64]]]\nget_layer_shear_angles\nint\nOptional\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.active.html#active", - "title": "active", - "section": "active", - "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_shear_angles", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_shear_angles.html#ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_shear_angles", + "title": "get_layer_shear_angles > get_layer_shear_angles > get_layer_shear_angles", + "section": "get_layer_shear_angles > get_layer_shear_angles", + "text": "LayupPropertiesProvider.get_layer_shear_angles(element_id)\n\nGet shear angle for all layers. Returns None if element is not layered.\n\nParameters\n\nelement_id (int) – Element Id/Label\n\nReturn type\n\nOptional[ndarray[Any, dtype[float64]]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.active.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.active", - "title": "active > active > active", - "section": "active > active", - "text": "property MaxStrainCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.capitalize", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.capitalize.html#capitalize", + "title": "capitalize", + "section": "capitalize", + "text": "Return a capitalized version of the string.\nMore specifically, make the first character have upper case and the rest lower\ncase.\ncapitalize" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.SHEAR_ANGLE", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.SHEAR_ANGLE.html#shear_angle", - "title": "SHEAR_ANGLE", - "section": "SHEAR_ANGLE", - "text": "SHEAR_ANGLE" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.capitalize", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.capitalize.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.capitalize", + "title": "capitalize > capitalize > capitalize", + "section": "capitalize > capitalize", + "text": "FailureMeasureEnum.capitalize(/)\n\nReturn a capitalized version of the string.\n\nMore specifically, make the first character have upper case and the rest lower\ncase.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.SHEAR_ANGLE", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.SHEAR_ANGLE.html#ansys.dpf.composites.layup_info.LayupProperty.SHEAR_ANGLE", - "title": "SHEAR_ANGLE > SHEAR_ANGLE > SHEAR_ANGLE", - "section": "SHEAR_ANGLE > SHEAR_ANGLE", - "text": "LayupProperty.SHEAR_ANGLE = 1\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lft", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lft.html#wf_lft", + "title": "wf_lft", + "section": "wf_lft", + "text": "Weighting factor of fiber failure due to tension (lft).\nfloat\nwf_lft\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2.html#s2", - "title": "s2", - "section": "s2", - "text": "s2" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lft", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lft.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lft", + "title": "wf_lft > wf_lft > wf_lft", + "section": "wf_lft > wf_lft", + "text": "property LaRCCriterion.wf_lft: float\n\nWeighting factor of fiber failure due to tension (lft).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s2", - "title": "s2 > s2 > s2", - "section": "s2 > s2", - "text": "FailureModeEnum.s2 = 220\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_support_provider", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_support_provider.html#material_support_provider", + "title": "material_support_provider", + "section": "material_support_provider", + "text": "Get material_support_provider.\nOperator\nmaterial_support_provider\nOperator" }, { - "objectID": "api/constants", - "href": "api/constants.html#constants", - "title": "Constants", - "section": "Constants", - "text": "FailureOutput(value[, names, module, ...])\nProvides failure output types.\nSpot(value[, names, module, qualname, type, ...])\nImplements an interface to access the spots of the results of layered elements.\nSym3x3TensorComponent(value[, names, ...])\nProvides tensor indices for symmetrical 3x3 tensors.\nConstants\nFailureOutput\nSpot\nSym3x3TensorComponent" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_support_provider", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_support_provider.html#ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_support_provider", + "title": "material_support_provider > material_support_provider > material_support_provider", + "section": "material_support_provider > material_support_provider", + "text": "property MaterialOperators.material_support_provider: Operator\n\nGet material_support_provider.\n\nReturn type\n\nOperator\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pf.html#pf", - "title": "pf", - "section": "pf", - "text": "pf" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_mesh", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_mesh.html#get_mesh", + "title": "get_mesh", + "section": "get_mesh", + "text": "Get the underlying DPF meshed region.\nThe meshed region contains the lay-up information.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nMeshedRegion\nget_mesh\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nMeshedRegion" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pf.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.pf", - "title": "pf > pf > pf", - "section": "pf > pf", - "text": "FailureModeEnum.pf = 801\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_mesh", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_mesh.html#ansys.dpf.composites.composite_model.CompositeModel.get_mesh", + "title": "get_mesh > get_mesh > get_mesh", + "section": "get_mesh > get_mesh", + "text": "CompositeModel.get_mesh(composite_definition_label=None)\n\nGet the underlying DPF meshed region.\n\nThe meshed region contains the lay-up information.\n\nParameters\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\n\nReturn type\n\nMeshedRegion\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.scopes", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.scopes.html#scopes", - "title": "scopes", - "section": "scopes", - "text": "Scopes of the result definition.\nSequence[ResultDefinitionScope]\nscopes\nSequence\nResultDefinitionScope" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3.html#e3", + "title": "e3", + "section": "e3", + "text": "e3" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.scopes", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.scopes.html#ansys.dpf.composites.result_definition.ResultDefinition.scopes", - "title": "scopes > scopes > scopes", - "section": "scopes > scopes", - "text": "property ResultDefinition.scopes: Sequence[ResultDefinitionScope]\n\nScopes of the result definition.\n\nReturn type\n\nSequence[ResultDefinitionScope]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e3", + "title": "e3 > e3 > e3", + "section": "e3 > e3", + "text": "FailureModeEnum.e3 = 130\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K3", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K3.html#thermal_conductivity_k3", - "title": "Thermal_Conductivity_K3", - "section": "Thermal_Conductivity_K3", - "text": "Thermal_Conductivity_K3" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.encode", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.encode.html#encode", + "title": "encode", + "section": "encode", + "text": "Encode the string using the codec registered for encoding.\nThe encoding in which to encode the string.\nThe error handling scheme to use for encoding errors.\nThe default is ‘strict’ meaning that encoding errors raise a\nUnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and\n‘xmlcharrefreplace’ as well as any other name registered with\ncodecs.register_error that can handle UnicodeEncodeErrors.\nencode" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K3", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K3.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K3", - "title": "Thermal_Conductivity_K3 > Thermal_Conductivity_K3 > Thermal_Conductivity_K3", - "section": "Thermal_Conductivity_K3 > Thermal_Conductivity_K3", - "text": "MaterialProperty.Thermal_Conductivity_K3: str = 'thermal_conductivity_z_direction'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.encode", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.encode.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.encode", + "title": "encode > encode > encode", + "section": "encode > encode", + "text": "FailureMeasureEnum.encode(/, encoding='utf-8', errors='strict')\n\nEncode the string using the codec registered for encoding.\n\nencoding\n\nThe encoding in which to encode the string.\n\nerrors\n\nThe error handling scheme to use for encoding errors.\nThe default is ‘strict’ meaning that encoding errors raise a\nUnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and\n‘xmlcharrefreplace’ as well as any other name registered with\ncodecs.register_error that can handle UnicodeEncodeErrors.\n\n!! processed by numpydoc !!" }, { "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.element_id", @@ -3115,711 +2989,739 @@ "text": "property SamplingPoint.element_id: int | None\n\nElement label for sampling the laminate.\n\nThis attribute returns -1 if the element ID is not set.\n\nReturn type\n\nOptional[int]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pf.html#wf_pf", - "title": "wf_pf", - "section": "wf_pf", - "text": "Weighting factor of the fiber failure (pf) mode.\nfloat\nwf_pf\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_dict.html#to_dict", + "title": "to_dict", + "section": "to_dict", + "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pf.html#ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pf", - "title": "wf_pf > wf_pf > wf_pf", - "section": "wf_pf > wf_pf", - "text": "property PuckCriterion.wf_pf: float\n\nWeighting factor of the fiber failure (pf) mode.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_dict", + "title": "to_dict > to_dict > to_dict", + "section": "to_dict > to_dict", + "text": "ShearCrimpingCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e12", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e12.html#wf_e12", - "title": "wf_e12", - "section": "wf_e12", - "text": "Weighting factor of the failure mode e12.\nfloat\nwf_e12\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.active.html#active", + "title": "active", + "section": "active", + "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e12", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e12.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e12", - "title": "wf_e12 > wf_e12 > wf_e12", - "section": "wf_e12 > wf_e12", - "text": "property MaxStrainCriterion.wf_e12: float\n\nWeighting factor of the failure mode e12.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.active.html#ansys.dpf.composites.failure_criteria.TsaiWuCriterion.active", + "title": "active > active > active", + "section": "active > active", + "text": "property TsaiWuCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.l", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.l.html#l", - "title": "l", - "section": "l", - "text": "l" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vms", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vms.html#wf_vms", + "title": "wf_vms", + "section": "wf_vms", + "text": "Weighting factor of the stress criterion (vms).\nfloat\nwf_vms\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.l", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.l.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.l", - "title": "l > l > l", - "section": "l > l", - "text": "FailureModeEnum.l = 900\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vms", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vms.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vms", + "title": "wf_vms > wf_vms > wf_vms", + "section": "wf_vms > wf_vms", + "text": "property VonMisesCriterion.wf_vms: float\n\nWeighting factor of the stress criterion (vms).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.wf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.wf.html#wf", - "title": "wf", - "section": "wf", - "text": "Weighting factor of this failure criterion.\nfloat\nwf\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.partition", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.partition.html#partition", + "title": "partition", + "section": "partition", + "text": "Partition the string into three parts using the given separator.\nThis will search for the separator in the string. If the separator is found,\nreturns a 3-tuple containing the part before the separator, the separator\nitself, and the part after it.\nIf the separator is not found, returns a 3-tuple containing the original string\nand two empty strings.\npartition" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.wf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.wf.html#ansys.dpf.composites.failure_criteria.TsaiWuCriterion.wf", - "title": "wf > wf > wf", - "section": "wf > wf", - "text": "property TsaiWuCriterion.wf: float\n\nWeighting factor of this failure criterion.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.partition", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.partition.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.partition", + "title": "partition > partition > partition", + "section": "partition > partition", + "text": "FailureMeasureEnum.partition(sep, /)\n\nPartition the string into three parts using the given separator.\n\nThis will search for the separator in the string. If the separator is found,\nreturns a 3-tuple containing the part before the separator, the separator\nitself, and the part after it.\n\nIf the separator is not found, returns a 3-tuple containing the original string\nand two empty strings.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.smax", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.smax.html#smax", - "title": "smax", - "section": "smax", - "text": "smax" + "objectID": "api/composite_scope", + "href": "api/composite_scope.html#composite-scope", + "title": "Composite scope", + "section": "Composite scope", + "text": "CompositeScope([elements, plies, time, ...])\nProvides the composite scope.\nComposite scope\nCompositeScope" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.smax", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.smax.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.smax", - "title": "smax > smax > smax", - "section": "smax > smax", - "text": "FailureModeEnum.smax = 201\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.wf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.wf.html#wf", + "title": "wf", + "section": "wf", + "text": "Weighting factor of the failure mode (wb or wt).\nfloat\nwf\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_json.html#to_json", + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.wf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.wf.html#ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.wf", + "title": "wf > wf > wf", + "section": "wf > wf", + "text": "property ShearCrimpingCriterion.wf: float\n\nWeighting factor of the failure mode (wb or wt).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_json.html#to_json", "title": "to_json", "section": "to_json", "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_json.html#ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_json", + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_json.html#ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_json", "title": "to_json > to_json > to_json", "section": "to_json > to_json", - "text": "HoffmanCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" + "text": "TsaiHillCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e1", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e1.html#e1", - "title": "e1", - "section": "e1", - "text": "Activates the failure evaluation regarding the strain in the material 1 direction.\nbool\ne1\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.dim", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.dim.html#dim", + "title": "dim", + "section": "dim", + "text": "Specifies which formulation of the failure criterion is used.\nint\ndim\nint" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e1", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e1.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e1", - "title": "e1 > e1 > e1", - "section": "e1 > e1", - "text": "property MaxStrainCriterion.e1: bool\n\nActivates the failure evaluation regarding the strain in the material 1 direction.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.dim", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.dim.html#ansys.dpf.composites.failure_criteria.HoffmanCriterion.dim", + "title": "dim > dim > dim", + "section": "dim > dim", + "text": "property HoffmanCriterion.dim: int\n\nSpecifies which formulation of the failure criterion is used.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ns", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ns.html#ns", - "title": "ns", - "section": "ns", - "text": "ns" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.active.html#active", + "title": "active", + "section": "active", + "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ns", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ns.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.ns", - "title": "ns > ns > ns", - "section": "ns > ns", - "text": "FailureModeEnum.ns = 9998\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.active.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.active", + "title": "active > active > active", + "section": "active > active", + "text": "property VonMisesCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s12", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s12.html#s12", - "title": "s12", - "section": "s12", - "text": "s12" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.dim", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.dim.html#dim", + "title": "dim", + "section": "dim", + "text": "Whether the 2D or 3D formulation of the criterion is used. The latter one also supports the failure mode delamination. Use 1 for a simplified Puck criterion.\nint\ndim\n1\nint" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s12", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s12.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s12", - "title": "s12 > s12 > s12", - "section": "s12 > s12", - "text": "FailureModeEnum.s12 = 240\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.dim", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.dim.html#ansys.dpf.composites.failure_criteria.PuckCriterion.dim", + "title": "dim > dim > dim", + "section": "dim > dim", + "text": "property PuckCriterion.dim: int\n\nWhether the 2D or 3D formulation of the criterion is used. The latter one also supports the failure mode delamination. Use 1 for a simplified Puck criterion.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cfc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cfc.html#cfc", - "title": "cfc", - "section": "cfc", - "text": "Activates the failure evaluation regarding compression in fiber direction.\nbool\ncfc\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.is_layered", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.is_layered.html#is_layered", + "title": "is_layered", + "section": "is_layered", + "text": "is_layered" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cfc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cfc.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.cfc", - "title": "cfc > cfc > cfc", - "section": "cfc > cfc", - "text": "property CuntzeCriterion.cfc: bool\n\nActivates the failure evaluation regarding compression in fiber direction.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.is_layered", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.is_layered.html#ansys.dpf.composites.layup_info.ElementInfo.is_layered", + "title": "is_layered > is_layered > is_layered", + "section": "is_layered > is_layered", + "text": "ElementInfo.is_layered: bool\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.AVG", - "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.AVG.html#avg", - "title": "AVG", - "section": "AVG", - "text": "AVG" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.safety_factor", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.safety_factor.html#safety_factor", + "title": "safety_factor", + "section": "safety_factor", + "text": "safety_factor" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.safety_factor", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.safety_factor.html#ansys.dpf.composites.sampling_point.FailureResult.safety_factor", + "title": "safety_factor > safety_factor > safety_factor", + "section": "safety_factor > safety_factor", + "text": "FailureResult.safety_factor: float\n\n" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lfc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lfc.html#wf_lfc", + "title": "wf_lfc", + "section": "wf_lfc", + "text": "Weighting factor of fiber failure due to compression (lfc).\nfloat\nwf_lfc\nfloat" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lfc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lfc.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lfc", + "title": "wf_lfc > wf_lfc > wf_lfc", + "section": "wf_lfc > wf_lfc", + "text": "property LaRCCriterion.wf_lfc: float\n\nWeighting factor of fiber failure due to compression (lfc).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.AVG", - "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.AVG.html#ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.AVG", - "title": "AVG > AVG > AVG", - "section": "AVG > AVG", - "text": "SpotReductionStrategy.AVG = 'AVG'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.name.html#name", + "title": "name", + "section": "name", + "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.html#puckcriterion", - "title": "PuckCriterion", - "section": "PuckCriterion", - "text": "Defines the Puck failure criterion for UD reinforced materials.\npf (bool, default: True) – Whether to activate the failure evaluation regarding fiber failure.\npma (bool, default: True) – Whether to activate the failure evaluation regarding matrix failure due to tension.\npmb (bool, default: True) – Whether to activate the failure evaluation regarding matrix failure due to compression.\npmc (bool, default: True) – Whether to activate the failure evaluation regarding matrix failure due to shear failure.\npd (bool, default: False) – Whether to activate the failure evaluation regarding delamination if dim is equal to 3.\ndim (int, default: 2) – Whether the 2D or 3D formulation of the criterion is used. The latter one also supports the failure mode delamination. Use 1 for a simplified Puck criterion.\nwf_pf (float, default: 1.0) – Weighting factor of the fiber failure (pf) mode.\nwf_pma (float, default: 1.0) – Weighting factor of the matrix failure (pma) mode.\nwf_pmb (float, default: 1.0) – Weighting factor of the matrix failure (pmb) mode.\nwf_pmc (float, default: 1.0) – Weighting factor of the matrix failure (pmc) mode.\nwf_pd (float, default: 1.0) – Weighting factor of the delamination failure (pd) mode.\ncfps (bool, default: True) – Whether to consider inter-fiber strength reduction due to fiber parallel stresses.\ns (float, default: 0.5) – Specifies the effect of fiber parallel stresses regarding inter-fiber failure. s = [0, 1) and the default is 0.5.\nm – Specifies the effect of fiber parallel stresses regarding inter-fiber failure. M = [0, 1). The default is 0.5.\ninterface_weakening_factor (float, default: 0.8) – Multiplicator for the interlaminar strength if failure mode pd is active. The default is 0.8.\nforce_global_constants (bool, default: False) – Whether to use global constants instead of the material-wise properties.\np21_neg (float, default: 0.275) – Global inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for compression.\np21_pos (float, default: 0.325) – Global inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for tension.,\np22_neg (float, default: 0.225) – Global inclination factor of the fracture plane \\perp \\perp for compression.\np22_pos (float, default: 0.225) – Global inclination factor of the fracture plane \\perp \\perp for tension.\nPuckCriterion.to_dict()\n\nPuckCriterion.to_json()\n\nPuckCriterion.M\nSpecifies the effect of fiber parallel stresses regarding inter-fiber failure.\nPuckCriterion.active\nThe failure criterion is suppressed if active is False.\nPuckCriterion.cfps\nWhether to consider inter-fiber strength reduction due to fiber parallel stresses.\nPuckCriterion.dim\nWhether the 2D or 3D formulation of the criterion is used.\nPuckCriterion.force_global_constants\nWhether to use global constants instead of the material-wise properties.\nPuckCriterion.interface_weakening_factor\nMultiplicator for the interlaminar strength if failure mode pd is active.\nPuckCriterion.name\nName of the failure criterion.\nPuckCriterion.p21_neg\nGlobal inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for compression.\nPuckCriterion.p21_pos\nGlobal inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for tension.\nPuckCriterion.p22_neg\nGlobal inclination factor of the fracture plane \\perp \\perp for compression.\nPuckCriterion.p22_pos\nGlobal inclination factor of the fracture plane \\perp \\perp for tension.\nPuckCriterion.pd\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\nPuckCriterion.pf\nWhether to activate the failure evaluation regarding fiber failure.\nPuckCriterion.pma\nWhether to activate the failure evaluation regarding matrix failure due to tension.\nPuckCriterion.pmb\nWhether to activate the failure evaluation regarding matrix failure due to compression.\nPuckCriterion.pmc\nWhether to activate the failure evaluation regarding matrix failure due to shear failure.\nPuckCriterion.s\nSpecifies the effect of fiber parallel stresses regarding inter-fiber failure.\nPuckCriterion.wf_pd\nWeighting factor of the delamination failure (pd) mode.\nPuckCriterion.wf_pf\nWeighting factor of the fiber failure (pf) mode.\nPuckCriterion.wf_pma\nWeighting factor of the matrix failure (pma) mode.\nPuckCriterion.wf_pmb\nWeighting factor of the matrix failure (pmb) mode.\nPuckCriterion.wf_pmc\nWeighting factor of the matrix failure (pmc) mode.\nPuckCriterion\nbool\nTrue\nbool\nTrue\nbool\nTrue\nbool\nTrue\nbool\nFalse\nint\n2\n1\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nbool\nTrue\nfloat\n0.5\n0.5\n0.5\nfloat\n0.8\npd\n0.8\nbool\nFalse\nfloat\n0.275\nfloat\n0.325\nfloat\n0.225\nfloat\n0.225\nPuckCriterion.to_dict\nPuckCriterion.to_json\nPuckCriterion.M\nPuckCriterion.active\nPuckCriterion.cfps\nPuckCriterion.dim\nPuckCriterion.force_global_constants\nPuckCriterion.interface_weakening_factor\npd\nPuckCriterion.name\nPuckCriterion.p21_neg\nPuckCriterion.p21_pos\nPuckCriterion.p22_neg\nPuckCriterion.p22_pos\nPuckCriterion.pd\nPuckCriterion.pf\nPuckCriterion.pma\nPuckCriterion.pmb\nPuckCriterion.pmc\nPuckCriterion.s\nPuckCriterion.wf_pd\nPuckCriterion.wf_pf\nPuckCriterion.wf_pma\nPuckCriterion.wf_pmb\nPuckCriterion.wf_pmc" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.name.html#ansys.dpf.composites.failure_criteria.HashinCriterion.name", + "title": "name > name > name", + "section": "name > name", + "text": "property HashinCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.html#ansys.dpf.composites.failure_criteria.PuckCriterion", - "title": "PuckCriterion > PuckCriterion > PuckCriterion", - "section": "PuckCriterion > PuckCriterion", - "text": "class ansys.dpf.composites.failure_criteria.PuckCriterion(*, pf=True, pma=True, pmb=True, pmc=True, pd=False, dim=2, wf_pf=1.0, wf_pma=1.0, wf_pmb=1.0, wf_pmc=1.0, wf_pd=1.0, cfps=True, s=0.5, M=0.5, interface_weakening_factor=0.8, force_global_constants=False, p21_neg=0.275, p21_pos=0.325, p22_neg=0.225, p22_pos=0.225)\n\nDefines the Puck failure criterion for UD reinforced materials.\n\nParameters\n\npf (bool, default: True) – Whether to activate the failure evaluation regarding fiber failure.\n\npma (bool, default: True) – Whether to activate the failure evaluation regarding matrix failure due to tension.\n\npmb (bool, default: True) – Whether to activate the failure evaluation regarding matrix failure due to compression.\n\npmc (bool, default: True) – Whether to activate the failure evaluation regarding matrix failure due to shear failure.\n\npd (bool, default: False) – Whether to activate the failure evaluation regarding delamination if dim is equal to 3.\n\ndim (int, default: 2) – Whether the 2D or 3D formulation of the criterion is used. The latter one also supports the failure mode delamination. Use 1 for a simplified Puck criterion.\n\nwf_pf (float, default: 1.0) – Weighting factor of the fiber failure (pf) mode.\n\nwf_pma (float, default: 1.0) – Weighting factor of the matrix failure (pma) mode.\n\nwf_pmb (float, default: 1.0) – Weighting factor of the matrix failure (pmb) mode.\n\nwf_pmc (float, default: 1.0) – Weighting factor of the matrix failure (pmc) mode.\n\nwf_pd (float, default: 1.0) – Weighting factor of the delamination failure (pd) mode.\n\ncfps (bool, default: True) – Whether to consider inter-fiber strength reduction due to fiber parallel stresses.\n\ns (float, default: 0.5) – Specifies the effect of fiber parallel stresses regarding inter-fiber failure. s = [0, 1) and the default is 0.5.\n\nm – Specifies the effect of fiber parallel stresses regarding inter-fiber failure. M = [0, 1). The default is 0.5.\n\ninterface_weakening_factor (float, default: 0.8) – Multiplicator for the interlaminar strength if failure mode pd is active. The default is 0.8.\n\nforce_global_constants (bool, default: False) – Whether to use global constants instead of the material-wise properties.\n\np21_neg (float, default: 0.275) – Global inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for compression.\n\np21_pos (float, default: 0.325) – Global inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for tension.,\n\np22_neg (float, default: 0.225) – Global inclination factor of the fracture plane \\perp \\perp for compression.\n\np22_pos (float, default: 0.225) – Global inclination factor of the fracture plane \\perp \\perp for tension.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nPuckCriterion.to_dict()\n\n\n\nPuckCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nPuckCriterion.M\n\nSpecifies the effect of fiber parallel stresses regarding inter-fiber failure.\n\nPuckCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nPuckCriterion.cfps\n\nWhether to consider inter-fiber strength reduction due to fiber parallel stresses.\n\nPuckCriterion.dim\n\nWhether the 2D or 3D formulation of the criterion is used.\n\nPuckCriterion.force_global_constants\n\nWhether to use global constants instead of the material-wise properties.\n\nPuckCriterion.interface_weakening_factor\n\nMultiplicator for the interlaminar strength if failure mode pd is active.\n\nPuckCriterion.name\n\nName of the failure criterion.\n\nPuckCriterion.p21_neg\n\nGlobal inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for compression.\n\nPuckCriterion.p21_pos\n\nGlobal inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for tension.\n\nPuckCriterion.p22_neg\n\nGlobal inclination factor of the fracture plane \\perp \\perp for compression.\n\nPuckCriterion.p22_pos\n\nGlobal inclination factor of the fracture plane \\perp \\perp for tension.\n\nPuckCriterion.pd\n\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\n\nPuckCriterion.pf\n\nWhether to activate the failure evaluation regarding fiber failure.\n\nPuckCriterion.pma\n\nWhether to activate the failure evaluation regarding matrix failure due to tension.\n\nPuckCriterion.pmb\n\nWhether to activate the failure evaluation regarding matrix failure due to compression.\n\nPuckCriterion.pmc\n\nWhether to activate the failure evaluation regarding matrix failure due to shear failure.\n\nPuckCriterion.s\n\nSpecifies the effect of fiber parallel stresses regarding inter-fiber failure.\n\nPuckCriterion.wf_pd\n\nWeighting factor of the delamination failure (pd) mode.\n\nPuckCriterion.wf_pf\n\nWeighting factor of the fiber failure (pf) mode.\n\nPuckCriterion.wf_pma\n\nWeighting factor of the matrix failure (pma) mode.\n\nPuckCriterion.wf_pmb\n\nWeighting factor of the matrix failure (pmb) mode.\n\nPuckCriterion.wf_pmc\n\nWeighting factor of the matrix failure (pmc) mode.\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.NOT_AVAILABLE", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.NOT_AVAILABLE.html#not_available", + "title": "NOT_AVAILABLE", + "section": "NOT_AVAILABLE", + "text": "NOT_AVAILABLE" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e12", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e12.html#e12", - "title": "e12", - "section": "e12", - "text": "Whether to activate the failure evaluation regarding the in-plane shear strain e12.\nbool\ne12\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.NOT_AVAILABLE", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.NOT_AVAILABLE.html#ansys.dpf.composites.layup_info.LayupModelContextType.NOT_AVAILABLE", + "title": "NOT_AVAILABLE > NOT_AVAILABLE > NOT_AVAILABLE", + "section": "NOT_AVAILABLE > NOT_AVAILABLE", + "text": "LayupModelContextType.NOT_AVAILABLE = 0\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e12", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e12.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e12", - "title": "e12 > e12 > e12", - "section": "e12 > e12", - "text": "property MaxStrainCriterion.e12: bool\n\nWhether to activate the failure evaluation regarding the in-plane shear strain e12.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e13", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e13.html#wf_e13", + "title": "wf_e13", + "section": "wf_e13", + "text": "Weighting factor of the failure mode e13.\nfloat\nwf_e13\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYt", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYt.html#eyt", - "title": "eYt", - "section": "eYt", - "text": "Global tensile strain limit in material direction 2.\nfloat\neYt\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e13", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e13.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e13", + "title": "wf_e13 > wf_e13 > wf_e13", + "section": "wf_e13 > wf_e13", + "text": "property MaxStrainCriterion.wf_e13: float\n\nWeighting factor of the failure mode e13.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYt", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYt.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYt", - "title": "eYt > eYt > eYt", - "section": "eYt > eYt", - "text": "property MaxStrainCriterion.eYt: float\n\nGlobal tensile strain limit in material direction 2.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.dpf_material_id", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.dpf_material_id.html#dpf_material_id", + "title": "dpf_material_id", + "section": "dpf_material_id", + "text": "dpf_material_id" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_neg", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_neg.html#puck_constants_p_21_neg", - "title": "Puck_Constants_p_21_neg", - "section": "Puck_Constants_p_21_neg", - "text": "Puck_Constants_p_21_neg" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.dpf_material_id", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.dpf_material_id.html#ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.dpf_material_id", + "title": "dpf_material_id > dpf_material_id > dpf_material_id", + "section": "dpf_material_id > dpf_material_id", + "text": "MaterialMetadata.dpf_material_id: int = 0\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_neg", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_neg.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_neg", - "title": "Puck_Constants_p_21_neg > Puck_Constants_p_21_neg > Puck_Constants_p_21_neg", - "section": "Puck_Constants_p_21_neg > Puck_Constants_p_21_neg", - "text": "MaterialProperty.Puck_Constants_p_21_neg: str = 'compressive_inclination_xz_puck_constants'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.expression", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.expression.html#expression", + "title": "expression", + "section": "expression", + "text": "Type of the result. The supported type is \"composite_failure\".\nstr\nexpression\n\"composite_failure\"\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_m", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_m.html#puck_constants_m", - "title": "Puck_Constants_m", - "section": "Puck_Constants_m", - "text": "Puck_Constants_m" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.expression", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.expression.html#ansys.dpf.composites.result_definition.ResultDefinition.expression", + "title": "expression > expression > expression", + "section": "expression > expression", + "text": "property ResultDefinition.expression: str\n\nType of the result. The supported type is \"composite_failure\".\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_m", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_m.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_m", - "title": "Puck_Constants_m > Puck_Constants_m > Puck_Constants_m", - "section": "Puck_Constants_m > Puck_Constants_m", - "text": "MaterialProperty.Puck_Constants_m: str = 'degradation_parameter_m_puck_constants'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p22_pos", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p22_pos.html#p22_pos", + "title": "p22_pos", + "section": "p22_pos", + "text": "Global inclination factor of the fracture plane \\perp \\perp for tension.\nfloat\np22_pos\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE_REF_SURFACE", - "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE_REF_SURFACE.html#failure_mode_ref_surface", - "title": "FAILURE_MODE_REF_SURFACE", - "section": "FAILURE_MODE_REF_SURFACE", - "text": "FAILURE_MODE_REF_SURFACE" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p22_pos", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p22_pos.html#ansys.dpf.composites.failure_criteria.PuckCriterion.p22_pos", + "title": "p22_pos > p22_pos > p22_pos", + "section": "p22_pos > p22_pos", + "text": "property PuckCriterion.p22_pos: float\n\nGlobal inclination factor of the fracture plane \\perp \\perp for tension.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE_REF_SURFACE", - "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE_REF_SURFACE.html#ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE_REF_SURFACE", - "title": "FAILURE_MODE_REF_SURFACE > FAILURE_MODE_REF_SURFACE > FAILURE_MODE_REF_SURFACE", - "section": "FAILURE_MODE_REF_SURFACE > FAILURE_MODE_REF_SURFACE", - "text": "FailureOutput.FAILURE_MODE_REF_SURFACE = 3\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3t", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3t.html#s3t", + "title": "s3t", + "section": "s3t", + "text": "s3t" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cft", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cft.html#cft", - "title": "cft", - "section": "cft", - "text": "cft" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3t", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3t.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s3t", + "title": "s3t > s3t > s3t", + "section": "s3t > s3t", + "text": "FailureModeEnum.s3t = 231\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cft", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cft.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.cft", - "title": "cft > cft > cft", - "section": "cft > cft", - "text": "FailureModeEnum.cft = 1001\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.check_has_single_scope", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.check_has_single_scope.html#check_has_single_scope", + "title": "check_has_single_scope", + "section": "check_has_single_scope", + "text": "Check that the result definition has one scope.\nNone\ncheck_has_single_scope\nNone" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2.html#e2", - "title": "e2", - "section": "e2", - "text": "e2" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.check_has_single_scope", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.check_has_single_scope.html#ansys.dpf.composites.result_definition.ResultDefinition.check_has_single_scope", + "title": "check_has_single_scope > check_has_single_scope > check_has_single_scope", + "section": "check_has_single_scope > check_has_single_scope", + "text": "ResultDefinition.check_has_single_scope(msg)\n\nCheck that the result definition has one scope.\n\nReturn type\n\nNone\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e2", - "title": "e2 > e2 > e2", - "section": "e2 > e2", - "text": "FailureModeEnum.e2 = 120\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cma", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cma.html#cma", + "title": "cma", + "section": "cma", + "text": "Activates the failure evaluation of the matrix due to tension.\nbool\ncma\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.html#resultdefinition", - "title": "ResultDefinition", - "section": "ResultDefinition", - "text": "Represents the result definition of DPF Composites.\nThis class is used to configure the DPF operators composite::failure_evaluator\nand composite::sampling_point_evaluator.\nResultDefinition.check_has_single_scope(msg)\nCheck that the result definition has one scope.\nResultDefinition.to_dict()\nGet the result definition in a dictionary representation.\nResultDefinition.to_json()\nConvert the dictionary representation of the result definition to a JSON dictionary.\nResultDefinition.combined_failure_criterion\nConfiguration of the failure criteria such as maximum stress, puck, and wrinkling.\nResultDefinition.expression\nType of the result.\nResultDefinition.material_file\nPath of the material files that store the material properties.\nResultDefinition.max_chunk_size\nMaximum chunk size (number of elements) for the result evaluation.\nResultDefinition.measure\nReturn type of the failure values.\nResultDefinition.name\nCustom name.\nResultDefinition.rst_files\nPath of the result (RST) files.\nResultDefinition.scopes\nScopes of the result definition.\nResultDefinition.stress_strain_eval_mode\nResults loaded from a result (RST) file by default.\nResultDefinition.time\nTime or solution step.\nResultDefinition\ncomposite::failure_evaluator\ncomposite::sampling_point_evaluator\nResultDefinition.check_has_single_scope\nResultDefinition.to_dict\nResultDefinition.to_json\nResultDefinition.combined_failure_criterion\nResultDefinition.expression\nResultDefinition.material_file\nResultDefinition.max_chunk_size\nResultDefinition.measure\nResultDefinition.name\nResultDefinition.rst_files\nResultDefinition.scopes\nResultDefinition.stress_strain_eval_mode\nResultDefinition.time" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cma", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cma.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.cma", + "title": "cma > cma > cma", + "section": "cma > cma", + "text": "property CuntzeCriterion.cma: bool\n\nActivates the failure evaluation of the matrix due to tension.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.html#ansys.dpf.composites.result_definition.ResultDefinition", - "title": "ResultDefinition > ResultDefinition > ResultDefinition", - "section": "ResultDefinition > ResultDefinition", - "text": "class ansys.dpf.composites.result_definition.ResultDefinition(name, combined_failure_criterion, composite_scopes, rst_files, material_file, measure='inverse_reserve_factor', stress_strain_eval_mode='rst_file', time=None, expression='composite_failure', max_chunk_size=50000)\n\nRepresents the result definition of DPF Composites.\n\nThis class is used to configure the DPF operators composite::failure_evaluator\nand composite::sampling_point_evaluator.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nResultDefinition.check_has_single_scope(msg)\n\nCheck that the result definition has one scope.\n\nResultDefinition.to_dict()\n\nGet the result definition in a dictionary representation.\n\nResultDefinition.to_json()\n\nConvert the dictionary representation of the result definition to a JSON dictionary.\n\n\n\nAttributes\n\n\n\n\n\n\n\nResultDefinition.combined_failure_criterion\n\nConfiguration of the failure criteria such as maximum stress, puck, and wrinkling.\n\nResultDefinition.expression\n\nType of the result.\n\nResultDefinition.material_file\n\nPath of the material files that store the material properties.\n\nResultDefinition.max_chunk_size\n\nMaximum chunk size (number of elements) for the result evaluation.\n\nResultDefinition.measure\n\nReturn type of the failure values.\n\nResultDefinition.name\n\nCustom name.\n\nResultDefinition.rst_files\n\nPath of the result (RST) files.\n\nResultDefinition.scopes\n\nScopes of the result definition.\n\nResultDefinition.stress_strain_eval_mode\n\nResults loaded from a result (RST) file by default.\n\nResultDefinition.time\n\nTime or solution step.\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.to_dict.html#to_dict", + "title": "to_dict", + "section": "to_dict", + "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.capitalize", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.capitalize.html#capitalize", - "title": "capitalize", - "section": "capitalize", - "text": "Return a capitalized version of the string.\nMore specifically, make the first character have upper case and the rest lower\ncase.\ncapitalize" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.HashinCriterion.to_dict", + "title": "to_dict > to_dict > to_dict", + "section": "to_dict > to_dict", + "text": "HashinCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.capitalize", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.capitalize.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.capitalize", - "title": "capitalize > capitalize > capitalize", - "section": "capitalize > capitalize", - "text": "FailureMeasureEnum.capitalize(/)\n\nReturn a capitalized version of the string.\n\nMore specifically, make the first character have upper case and the rest lower\ncase.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.join", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.join.html#join", + "title": "join", + "section": "join", + "text": "Concatenate any number of strings.\nThe string whose method is called is inserted in between each given string.\nThe result is returned as a new string.\nExample: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’\njoin" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isidentifier", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isidentifier.html#isidentifier", - "title": "isidentifier", - "section": "isidentifier", - "text": "Return True if the string is a valid Python identifier, False otherwise.\nCall keyword.iskeyword(s) to test whether string s is a reserved identifier,\nsuch as “def” or “class”.\nisidentifier" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.join", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.join.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.join", + "title": "join > join > join", + "section": "join > join", + "text": "FailureMeasureEnum.join(iterable, /)\n\nConcatenate any number of strings.\n\nThe string whose method is called is inserted in between each given string.\nThe result is returned as a new string.\n\nExample: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isidentifier", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isidentifier.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isidentifier", - "title": "isidentifier > isidentifier > isidentifier", - "section": "isidentifier > isidentifier", - "text": "FailureMeasureEnum.isidentifier(/)\n\nReturn True if the string is a valid Python identifier, False otherwise.\n\nCall keyword.iskeyword(s) to test whether string s is a reserved identifier,\nsuch as “def” or “class”.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s2", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s2.html#s2", + "title": "s2", + "section": "s2", + "text": "Stresses in the material 2 direction of each ply.\nndarray[Any, dtype[float64]]\ns2\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R23", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R23.html#hill_yield_criterion_r23", - "title": "Hill_Yield_Criterion_R23", - "section": "Hill_Yield_Criterion_R23", - "text": "Hill_Yield_Criterion_R23" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s2", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s2.html#ansys.dpf.composites.sampling_point.SamplingPoint.s2", + "title": "s2 > s2 > s2", + "section": "s2 > s2", + "text": "property SamplingPoint.s2: ndarray[Any, dtype[float64]]\n\nStresses in the material 2 direction of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R23", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R23.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R23", - "title": "Hill_Yield_Criterion_R23 > Hill_Yield_Criterion_R23 > Hill_Yield_Criterion_R23", - "section": "Hill_Yield_Criterion_R23 > Hill_Yield_Criterion_R23", - "text": "MaterialProperty.Hill_Yield_Criterion_R23: str = 'yield_stress_ratio_yz_hill_criterion'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2t", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2t.html#e2t", + "title": "e2t", + "section": "e2t", + "text": "e2t" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.mapping_file", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.mapping_file.html#mapping_file", - "title": "mapping_file", - "section": "mapping_file", - "text": "Path to the mapping file for all element labels in the element scope.\nmapping_file" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2t", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2t.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e2t", + "title": "e2t > e2t > e2t", + "section": "e2t > e2t", + "text": "FailureModeEnum.e2t = 121\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.mapping_file", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.mapping_file.html#ansys.dpf.composites.result_definition.ResultDefinitionScope.mapping_file", - "title": "mapping_file > mapping_file > mapping_file", - "section": "mapping_file > mapping_file", - "text": "ResultDefinitionScope.mapping_file: str | PathLike[str] | None = None\n\nPath to the mapping file for all element labels in the element scope.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR21", + "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR21.html#tensor21", + "title": "TENSOR21", + "section": "TENSOR21", + "text": "TENSOR21" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc2", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc2.html#lmc2", - "title": "lmc2", - "section": "lmc2", - "text": "lmc2" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR21", + "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR21.html#ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR21", + "title": "TENSOR21 > TENSOR21 > TENSOR21", + "section": "TENSOR21 > TENSOR21", + "text": "Sym3x3TensorComponent.TENSOR21 = 3\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc2", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc2.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc2", - "title": "lmc2 > lmc2 > lmc2", - "section": "lmc2 > lmc2", - "text": "FailureModeEnum.lmc2 = 905\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cma", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cma.html#wf_cma", + "title": "wf_cma", + "section": "wf_cma", + "text": "Weighting factor of matrix failure due to tension (cma).\nfloat\nwf_cma\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.ACP", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.ACP.html#acp", - "title": "ACP", - "section": "ACP", - "text": "ACP" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cma", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cma.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cma", + "title": "wf_cma > wf_cma > wf_cma", + "section": "wf_cma > wf_cma", + "text": "property CuntzeCriterion.wf_cma: float\n\nWeighting factor of matrix failure due to tension (cma).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.ACP", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.ACP.html#ansys.dpf.composites.layup_info.LayupModelContextType.ACP", - "title": "ACP > ACP > ACP", - "section": "ACP > ACP", - "text": "LayupModelContextType.ACP = 1\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.BOT", + "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.BOT.html#bot", + "title": "BOT", + "section": "BOT", + "text": "BOT" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE", - "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE.html#failure_mode", - "title": "FAILURE_MODE", - "section": "FAILURE_MODE", - "text": "FAILURE_MODE" + "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.BOT", + "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.BOT.html#ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.BOT", + "title": "BOT > BOT > BOT", + "section": "BOT > BOT", + "text": "SpotReductionStrategy.BOT = 'BOT'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE", - "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE.html#ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE", - "title": "FAILURE_MODE > FAILURE_MODE > FAILURE_MODE", - "section": "FAILURE_MODE > FAILURE_MODE", - "text": "FailureOutput.FAILURE_MODE = 0\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.THICKNESSES", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.THICKNESSES.html#thicknesses", + "title": "THICKNESSES", + "section": "THICKNESSES", + "text": "THICKNESSES" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vme", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vme.html#wf_vme", - "title": "wf_vme", - "section": "wf_vme", - "text": "Weighting factor of the strain criterion (vme).\nfloat\nwf_vme\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.THICKNESSES", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.THICKNESSES.html#ansys.dpf.composites.layup_info.LayerProperty.THICKNESSES", + "title": "THICKNESSES > THICKNESSES > THICKNESSES", + "section": "THICKNESSES > THICKNESSES", + "text": "LayerProperty.THICKNESSES = 0\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vme", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vme.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vme", - "title": "wf_vme > wf_vme > wf_vme", - "section": "wf_vme > wf_vme", - "text": "property VonMisesCriterion.wf_vme: float\n\nWeighting factor of the strain criterion (vme).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lmc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lmc.html#lmc", + "title": "lmc", + "section": "lmc", + "text": "Whether to activate the failure evaluation of the matrix due to compression.\nbool\nlmc\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R33", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R33.html#hill_yield_criterion_r33", - "title": "Hill_Yield_Criterion_R33", - "section": "Hill_Yield_Criterion_R33", - "text": "Hill_Yield_Criterion_R33" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lmc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lmc.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.lmc", + "title": "lmc > lmc > lmc", + "section": "lmc > lmc", + "text": "property LaRCCriterion.lmc: bool\n\nWhether to activate the failure evaluation of the matrix due to compression.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R33", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R33.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R33", - "title": "Hill_Yield_Criterion_R33 > Hill_Yield_Criterion_R33 > Hill_Yield_Criterion_R33", - "section": "Hill_Yield_Criterion_R33 > Hill_Yield_Criterion_R33", - "text": "MaterialProperty.Hill_Yield_Criterion_R33: str = 'yield_stress_ratio_z_hill_criterion'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e3", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e3.html#e3", + "title": "e3", + "section": "e3", + "text": "Strains in the material 3 direction of each ply.\nndarray[Any, dtype[float64]]\ne3\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.core_model", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.core_model.html#core_model", - "title": "core_model", - "section": "core_model", - "text": "Underlying DPF core model.\nModel\ncore_model\nModel" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e3", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e3.html#ansys.dpf.composites.sampling_point.SamplingPoint.e3", + "title": "e3 > e3 > e3", + "section": "e3 > e3", + "text": "property SamplingPoint.e3: ndarray[Any, dtype[float64]]\n\nStrains in the material 3 direction of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.core_model", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.core_model.html#ansys.dpf.composites.composite_model.CompositeModel.core_model", - "title": "core_model > core_model > core_model", - "section": "core_model > core_model", - "text": "property CompositeModel.core_model: Model\n\nUnderlying DPF core model.\n\nReturn type\n\nModel\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_json.html#to_json", + "title": "to_json", + "section": "to_json", + "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Spot.BOTTOM", - "href": "api/_autosummary/ansys.dpf.composites.constants.Spot.BOTTOM.html#bottom", - "title": "BOTTOM", - "section": "BOTTOM", - "text": "BOTTOM" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_json.html#ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_json", + "title": "to_json > to_json > to_json", + "section": "to_json > to_json", + "text": "TsaiWuCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Spot.BOTTOM", - "href": "api/_autosummary/ansys.dpf.composites.constants.Spot.BOTTOM.html#ansys.dpf.composites.constants.Spot.BOTTOM", - "title": "BOTTOM > BOTTOM > BOTTOM", - "section": "BOTTOM > BOTTOM", - "text": "Spot.BOTTOM = 1\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e12", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e12.html#wf_e12", + "title": "wf_e12", + "section": "wf_e12", + "text": "Weighting factor of the failure mode e12.\nfloat\nwf_e12\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.composite", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.composite.html#composite", - "title": "composite", - "section": "composite", - "text": "composite" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e12", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e12.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e12", + "title": "wf_e12 > wf_e12 > wf_e12", + "section": "wf_e12 > wf_e12", + "text": "property MaxStrainCriterion.wf_e12: float\n\nWeighting factor of the failure mode e12.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.composite", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.composite.html#ansys.dpf.composites.data_sources.CompositeDataSources.composite", - "title": "composite > composite > composite", - "section": "composite > composite", - "text": "CompositeDataSources.composite: DataSources | None\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR22", + "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR22.html#tensor22", + "title": "TENSOR22", + "section": "TENSOR22", + "text": "TENSOR22" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hm", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hm.html#hm", - "title": "hm", - "section": "hm", - "text": "hm" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR22", + "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR22.html#ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR22", + "title": "TENSOR22 > TENSOR22 > TENSOR22", + "section": "TENSOR22 > TENSOR22", + "text": "Sym3x3TensorComponent.TENSOR22 = 1\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hm", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hm.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.hm", - "title": "hm > hm > hm", - "section": "hm > hm", - "text": "FailureModeEnum.hm = 602\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.active.html#active", + "title": "active", + "section": "active", + "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xc", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xc.html#stress_limits_xc", - "title": "Stress_Limits_Xc", - "section": "Stress_Limits_Xc", - "text": "Stress_Limits_Xc" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.active.html#ansys.dpf.composites.failure_criteria.CoreFailureCriterion.active", + "title": "active > active > active", + "section": "active > active", + "text": "property CoreFailureCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xc", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xc.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xc", - "title": "Stress_Limits_Xc > Stress_Limits_Xc > Stress_Limits_Xc", - "section": "Stress_Limits_Xc > Stress_Limits_Xc", - "text": "MaterialProperty.Stress_Limits_Xc: str = 'stress_compressive_x_direction'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_json.html#to_json", + "title": "to_json", + "section": "to_json", + "text": "Return the combined failure criterion as a JSON dictionary.\nstr\nString representation (json.dumps file) that can be used for the result definition\nof the DPF Composites Failure evaluator operator.\nto_json\nstr\njson.dumps" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s1", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s1.html#s1", - "title": "s1", - "section": "s1", - "text": "Stresses in the material 1 direction of each ply.\nndarray[Any, dtype[float64]]\ns1\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_json.html#ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_json", + "title": "to_json > to_json > to_json", + "section": "to_json > to_json", + "text": "CombinedFailureCriterion.to_json()\n\nReturn the combined failure criterion as a JSON dictionary.\n\nReturn type\n\nstr\n\nReturns\n\nString representation (json.dumps file) that can be used for the result definition\nof the DPF Composites Failure evaluator operator.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s1", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s1.html#ansys.dpf.composites.sampling_point.SamplingPoint.s1", - "title": "s1 > s1 > s1", - "section": "s1 > s1", - "text": "property SamplingPoint.s1: ndarray[Any, dtype[float64]]\n\nStresses in the material 1 direction of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.elements", + "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.elements.html#elements", + "title": "elements", + "section": "elements", + "text": "elements" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE", - "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE.html#failure_value", - "title": "FAILURE_VALUE", - "section": "FAILURE_VALUE", - "text": "FAILURE_VALUE" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.elements", + "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.elements.html#ansys.dpf.composites.composite_scope.CompositeScope.elements", + "title": "elements > elements > elements", + "section": "elements > elements", + "text": "CompositeScope.elements: Sequence[int] | None = None\n\n" }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE", - "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE.html#ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE", - "title": "FAILURE_VALUE > FAILURE_VALUE > FAILURE_VALUE", - "section": "FAILURE_VALUE > FAILURE_VALUE", - "text": "FailureOutput.FAILURE_VALUE = 1\n\n" + { + "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE_REF_SURFACE", + "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE_REF_SURFACE.html#failure_value_ref_surface", + "title": "FAILURE_VALUE_REF_SURFACE", + "section": "FAILURE_VALUE_REF_SURFACE", + "text": "FAILURE_VALUE_REF_SURFACE" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rstrip", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rstrip.html#rstrip", - "title": "rstrip", - "section": "rstrip", - "text": "Return a copy of the string with trailing whitespace removed.\nIf chars is given and not None, remove characters in chars instead.\nrstrip" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE_REF_SURFACE", + "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE_REF_SURFACE.html#ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE_REF_SURFACE", + "title": "FAILURE_VALUE_REF_SURFACE > FAILURE_VALUE_REF_SURFACE > FAILURE_VALUE_REF_SURFACE", + "section": "FAILURE_VALUE_REF_SURFACE > FAILURE_VALUE_REF_SURFACE", + "text": "FailureOutput.FAILURE_VALUE_REF_SURFACE = 4\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rstrip", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rstrip.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.rstrip", - "title": "rstrip > rstrip > rstrip", - "section": "rstrip > rstrip", - "text": "FailureMeasureEnum.rstrip(chars=None, /)\n\nReturn a copy of the string with trailing whitespace removed.\n\nIf chars is given and not None, remove characters in chars instead.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_ratio", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_ratio.html#larc_constants_fracture_toughness_ratio", + "title": "Larc_Constants_fracture_toughness_ratio", + "section": "Larc_Constants_fracture_toughness_ratio", + "text": "Larc_Constants_fracture_toughness_ratio" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hm", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hm.html#hm", - "title": "hm", - "section": "hm", - "text": "Whether to activate the failure evaluation regarding matrix failure.\nbool\nhm\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_ratio", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_ratio.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_ratio", + "title": "Larc_Constants_fracture_toughness_ratio > Larc_Constants_fracture_toughness_ratio > Larc_Constants_fracture_toughness_ratio", + "section": "Larc_Constants_fracture_toughness_ratio > Larc_Constants_fracture_toughness_ratio", + "text": "MaterialProperty.Larc_Constants_fracture_toughness_ratio: str = 'fracture_toughness_ratio_larc_constants'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hm", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hm.html#ansys.dpf.composites.failure_criteria.HashinCriterion.hm", - "title": "hm > hm > hm", - "section": "hm > hm", - "text": "property HashinCriterion.hm: bool\n\nWhether to activate the failure evaluation regarding matrix failure.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYt", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYt.html#eyt", + "title": "eYt", + "section": "eYt", + "text": "Global tensile strain limit in material direction 2.\nfloat\neYt\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s13", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s13.html#wf_s13", - "title": "wf_s13", - "section": "wf_s13", - "text": "Weighting factor of the failure mode s13.\nfloat\nwf_s13\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYt", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYt.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYt", + "title": "eYt > eYt > eYt", + "section": "eYt > eYt", + "text": "property MaxStrainCriterion.eYt: float\n\nGlobal tensile strain limit in material direction 2.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s13", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s13.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s13", - "title": "wf_s13 > wf_s13 > wf_s13", - "section": "wf_s13 > wf_s13", - "text": "property MaxStressCriterion.wf_s13: float\n\nWeighting factor of the failure mode s13.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_info", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_info.html#get_element_info", + "title": "get_element_info", + "section": "get_element_info", + "text": "Get element information for an element ID.\nThis method returns None if the element type is not supported.\nelement_id (int) – Element ID or label.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nOptional[ElementInfo]\nget_element_info\nNone\nint\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nOptional\nElementInfo" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_operators", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_operators.html#material_operators", - "title": "material_operators", - "section": "material_operators", - "text": "Material operators.\nMaterialOperators\nmaterial_operators\nMaterialOperators" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_info", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_info.html#ansys.dpf.composites.composite_model.CompositeModel.get_element_info", + "title": "get_element_info > get_element_info > get_element_info", + "section": "get_element_info > get_element_info", + "text": "CompositeModel.get_element_info(element_id, composite_definition_label=None)\n\nGet element information for an element ID.\n\nThis method returns None if the element type is not supported.\n\nParameters\n\nelement_id (int) – Element ID or label.\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\n\nReturn type\n\nOptional[ElementInfo]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_operators", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_operators.html#ansys.dpf.composites.composite_model.CompositeModel.material_operators", - "title": "material_operators > material_operators > material_operators", - "section": "material_operators > material_operators", - "text": "property CompositeModel.material_operators: MaterialOperators\n\nMaterial operators.\n\nReturn type\n\nMaterialOperators\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E2", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E2.html#polar_properties_e2", + "title": "polar_properties_E2", + "section": "polar_properties_E2", + "text": "Polar property E2 of the laminate.\nndarray[Any, dtype[float64]]\npolar_properties_E2\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pma", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pma.html#pma", - "title": "pma", - "section": "pma", - "text": "Whether to activate the failure evaluation regarding matrix failure due to tension.\nbool\npma\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E2", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E2.html#ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E2", + "title": "polar_properties_E2 > polar_properties_E2 > polar_properties_E2", + "section": "polar_properties_E2 > polar_properties_E2", + "text": "property SamplingPoint.polar_properties_E2: ndarray[Any, dtype[float64]]\n\nPolar property E2 of the laminate.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pma", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pma.html#ansys.dpf.composites.failure_criteria.PuckCriterion.pma", - "title": "pma > pma > pma", - "section": "pma > pma", - "text": "property PuckCriterion.pma: bool\n\nWhether to activate the failure evaluation regarding matrix failure due to tension.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3c", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3c.html#e3c", + "title": "e3c", + "section": "e3c", + "text": "e3c" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.add_layup_info_to_mesh", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.add_layup_info_to_mesh.html#add_layup_info_to_mesh", - "title": "add_layup_info_to_mesh", - "section": "add_layup_info_to_mesh", - "text": "Add lay-up information to the mesh.\nCreates a lay-up provider operator that is run and returned.\ndata_sources (CompositeDataSources) – DPF data sources available from the CompositeModel.data_sources attribute.\nmesh (MeshedRegion) – DPF meshed region available from the CompositeModel.get_mesh() method.\nmaterial_operators (MaterialOperators) – MaterialOperators object available from the CompositeModel.material_operators\nattribute.\nunit_system (Optional[Union[UnitSystem, Operator]], default: None) – Unit system specification\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nrst_stream_provider (Optional[Operator], default: None) – Pass RST stream to load the section data directly from the RST file. This parameter is\nsupported in DPF version 8.0 (2024 R2) and later.\nOperator\nadd_layup_info_to_mesh\nCompositeDataSources\nCompositeModel.data_sources\nMeshedRegion\nCompositeModel.get_mesh()\nMaterialOperators\nCompositeModel.material_operators\nOptional\nUnion\nUnitSystem\nOperator\nNone\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nOptional\nOperator\nNone\nOperator" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3c", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3c.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e3c", + "title": "e3c > e3c > e3c", + "section": "e3c > e3c", + "text": "FailureModeEnum.e3c = 132\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.add_layup_info_to_mesh", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.add_layup_info_to_mesh.html#ansys.dpf.composites.layup_info.add_layup_info_to_mesh", - "title": "add_layup_info_to_mesh > add_layup_info_to_mesh > add_layup_info_to_mesh", - "section": "add_layup_info_to_mesh > add_layup_info_to_mesh", - "text": "ansys.dpf.composites.layup_info.add_layup_info_to_mesh(data_sources, material_operators, mesh, unit_system=None, composite_definition_label=None, rst_stream_provider=None)\n\nAdd lay-up information to the mesh.\n\nCreates a lay-up provider operator that is run and returned.\n\nParameters\n\ndata_sources (CompositeDataSources) – DPF data sources available from the CompositeModel.data_sources attribute.\n\nmesh (MeshedRegion) – DPF meshed region available from the CompositeModel.get_mesh() method.\n\nmaterial_operators (MaterialOperators) – MaterialOperators object available from the CompositeModel.material_operators\nattribute.\n\nunit_system (Optional[Union[UnitSystem, Operator]], default: None) – Unit system specification\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\n\nrst_stream_provider (Optional[Operator], default: None) – Pass RST stream to load the section data directly from the RST file. This parameter is\nsupported in DPF version 8.0 (2024 R2) and later.\n\nReturn type\n\nOperator\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxz", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxz.html#stress_limits_sxz", + "title": "Stress_Limits_Sxz", + "section": "Stress_Limits_Sxz", + "text": "Stress_Limits_Sxz" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_json.html#to_json", - "title": "to_json", - "section": "to_json", - "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxz", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxz.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxz", + "title": "Stress_Limits_Sxz > Stress_Limits_Sxz > Stress_Limits_Sxz", + "section": "Stress_Limits_Sxz > Stress_Limits_Sxz", + "text": "MaterialProperty.Stress_Limits_Sxz: str = 'stress_shear_xz'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_json.html#ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_json", - "title": "to_json > to_json > to_json", - "section": "to_json > to_json", - "text": "TsaiHillCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.removesuffix", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.removesuffix.html#removesuffix", + "title": "removesuffix", + "section": "removesuffix", + "text": "Return a str with the given suffix string removed if present.\nIf the string ends with the suffix string and that suffix is not empty,\nreturn string[:-len(suffix)]. Otherwise, return a copy of the original\nstring.\nremovesuffix" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_provider", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_provider.html#material_provider", - "title": "material_provider", - "section": "material_provider", - "text": "Get material_provider.\nOperator\nmaterial_provider\nOperator" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.removesuffix", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.removesuffix.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.removesuffix", + "title": "removesuffix > removesuffix > removesuffix", + "section": "removesuffix > removesuffix", + "text": "FailureMeasureEnum.removesuffix(suffix, /)\n\nReturn a str with the given suffix string removed if present.\n\nIf the string ends with the suffix string and that suffix is not empty,\nreturn string[:-len(suffix)]. Otherwise, return a copy of the original\nstring.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_provider", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_provider.html#ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_provider", - "title": "material_provider > material_provider > material_provider", - "section": "material_provider > material_provider", - "text": "property MaterialOperators.material_provider: Operator\n\nGet material_provider.\n\nReturn type\n\nOperator\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Spot.BOTTOM", + "href": "api/_autosummary/ansys.dpf.composites.constants.Spot.BOTTOM.html#bottom", + "title": "BOTTOM", + "section": "BOTTOM", + "text": "BOTTOM" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.dim", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.dim.html#dim", - "title": "dim", - "section": "dim", - "text": "Specifies which formulation of the failure criterion is used.\nint\ndim\nint" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Spot.BOTTOM", + "href": "api/_autosummary/ansys.dpf.composites.constants.Spot.BOTTOM.html#ansys.dpf.composites.constants.Spot.BOTTOM", + "title": "BOTTOM > BOTTOM > BOTTOM", + "section": "BOTTOM > BOTTOM", + "text": "Spot.BOTTOM = 1\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.dim", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.dim.html#ansys.dpf.composites.failure_criteria.TsaiHillCriterion.dim", - "title": "dim > dim > dim", - "section": "dim > dim", - "text": "property TsaiHillCriterion.dim: int\n\nSpecifies which formulation of the failure criterion is used.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.endswith", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.endswith.html#endswith", + "title": "endswith", + "section": "endswith", + "text": "Return True if the string ends with the specified suffix, False otherwise.\nA string or a tuple of strings to try.\nOptional start position. Default: start of the string.\nOptional stop position. Default: end of the string.\nendswith" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.swapcase", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.swapcase.html#swapcase", - "title": "swapcase", - "section": "swapcase", - "text": "Convert uppercase characters to lowercase and lowercase characters to uppercase.\nswapcase" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.endswith", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.endswith.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.endswith", + "title": "endswith > endswith > endswith", + "section": "endswith > endswith", + "text": "FailureMeasureEnum.endswith(suffix, [start, [end]], /)\n\nReturn True if the string ends with the specified suffix, False otherwise.\n\nsuffix\n\nA string or a tuple of strings to try.\n\nstart\n\nOptional start position. Default: start of the string.\n\nend\n\nOptional stop position. Default: end of the string.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.swapcase", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.swapcase.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.swapcase", - "title": "swapcase > swapcase > swapcase", - "section": "swapcase > swapcase", - "text": "FailureMeasureEnum.swapcase(/)\n\nConvert uppercase characters to lowercase and lowercase characters to uppercase.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.time", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.time.html#time", + "title": "time", + "section": "time", + "text": "Time or solution step.\nDPF Composites automatically selects the last time step if time is not set.\nYou can use the CompositeModel.get_result_times_or_frequencies() method\nto list the available times or frequencies in the result file.\nOptional[float]\ntime\nCompositeModel.get_result_times_or_frequencies()\nOptional\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.c", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.c.html#c", - "title": "c", - "section": "c", - "text": "c" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.time", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.time.html#ansys.dpf.composites.result_definition.ResultDefinition.time", + "title": "time > time > time", + "section": "time > time", + "text": "property ResultDefinition.time: float | None\n\nTime or solution step.\n\nDPF Composites automatically selects the last time step if time is not set.\n\nYou can use the CompositeModel.get_result_times_or_frequencies() method\nto list the available times or frequencies in the result file.\n\nReturn type\n\nOptional[float]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.c", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.c.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.c", - "title": "c > c > c", - "section": "c > c", - "text": "FailureModeEnum.c = 1000\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXc", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXc.html#strain_limits_exc", + "title": "Strain_Limits_eXc", + "section": "Strain_Limits_eXc", + "text": "Strain_Limits_eXc" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1t", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1t.html#e1t", - "title": "e1t", - "section": "e1t", - "text": "e1t" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXc", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXc.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXc", + "title": "Strain_Limits_eXc > Strain_Limits_eXc > Strain_Limits_eXc", + "section": "Strain_Limits_eXc > Strain_Limits_eXc", + "text": "MaterialProperty.Strain_Limits_eXc: str = 'strain_compressive_x_direction'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1t", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1t.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e1t", - "title": "e1t > e1t > e1t", - "section": "e1t > e1t", - "text": "FailureModeEnum.e1t = 111\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.engineering_data", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.engineering_data.html#engineering_data", + "title": "engineering_data", + "section": "engineering_data", + "text": "engineering_data" }, { - "objectID": "api/composite_model", - "href": "api/composite_model.html#composite-model", - "title": "Composite model", - "section": "Composite model", - "text": "CompositeModel(composite_files, server[, ...])\nProvides access to the basic composite postprocessing functionality.\nComposite model\nCompositeModel" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.engineering_data", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.engineering_data.html#ansys.dpf.composites.data_sources.CompositeDataSources.engineering_data", + "title": "engineering_data > engineering_data > engineering_data", + "section": "engineering_data > engineering_data", + "text": "CompositeDataSources.engineering_data: DataSources\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu.html#engineering_constants_nu", - "title": "Engineering_Constants_nu", - "section": "Engineering_Constants_nu", - "text": "Engineering_Constants_nu" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ap", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ap.html#ap", + "title": "ap", + "section": "ap", + "text": "ap" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu", - "title": "Engineering_Constants_nu > Engineering_Constants_nu > Engineering_Constants_nu", - "section": "Engineering_Constants_nu > Engineering_Constants_nu", - "text": "MaterialProperty.Engineering_Constants_nu: str = 'poisson_ratio'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ap", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ap.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.ap", + "title": "ap > ap > ap", + "section": "ap > ap", + "text": "FailureModeEnum.ap = 1202\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_dict.html#to_dict", - "title": "to_dict", - "section": "to_dict", - "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.definition", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.definition.html#definition", + "title": "definition", + "section": "definition", + "text": "definition" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_dict", - "title": "to_dict > to_dict > to_dict", - "section": "to_dict > to_dict", - "text": "CoreFailureCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.definition", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.definition.html#ansys.dpf.composites.data_sources.CompositeDefinitionFiles.definition", + "title": "definition > definition > definition", + "section": "definition > definition", + "text": "CompositeDefinitionFiles.definition: str | PathLike[str]\n\n" }, { "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E3", @@ -3836,389 +3738,452 @@ "text": "MaterialProperty.Engineering_Constants_E3: str = 'young_modulus_z_direction'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.wf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.wf.html#wf", - "title": "wf", - "section": "wf", - "text": "Weighting factor of this failure criterion.\nfloat\nwf\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.is_uptodate", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.is_uptodate.html#is_uptodate", + "title": "is_uptodate", + "section": "is_uptodate", + "text": "True if the Sampling Point is up-to-date.\nbool\nis_uptodate\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.wf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.wf.html#ansys.dpf.composites.failure_criteria.HoffmanCriterion.wf", - "title": "wf > wf > wf", - "section": "wf > wf", - "text": "property HoffmanCriterion.wf: float\n\nWeighting factor of this failure criterion.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.is_uptodate", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.is_uptodate.html#ansys.dpf.composites.sampling_point.SamplingPoint.is_uptodate", + "title": "is_uptodate > is_uptodate > is_uptodate", + "section": "is_uptodate > is_uptodate", + "text": "property SamplingPoint.is_uptodate: bool\n\nTrue if the Sampling Point is up-to-date.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.results", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.results.html#results", - "title": "results", - "section": "results", - "text": "Results of the sampling point results as a JSON dictionary.\nAny\nresults\nAny" + "objectID": "examples/gallery_examples/005_get_layup_properties_example", + "href": "examples/gallery_examples/005_get_layup_properties_example.html#lay-up-properties", + "title": "Lay-up properties", + "section": "Lay-up properties", + "text": "This example shows how to efficiently extract elemental lay-up properties such as\nthickness, angles, and analysis ply names. These are typically used for layer-wise\npostprocessing and data filtering.\nTo get the full layer information of an element, including results,\nconsider using the SamplingPoint class.\nWhen using a Workbench project,\nuse the composite_files_from_workbench_harmonic_analysis()\nmethod to obtain the input files.\nLay-up properties\nSamplingPoint\ncomposite_files_from_workbench_harmonic_analysis()" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.results", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.results.html#ansys.dpf.composites.sampling_point.SamplingPoint.results", - "title": "results > results > results", - "section": "results > results", - "text": "property SamplingPoint.results: Any\n\nResults of the sampling point results as a JSON dictionary.\n\nReturn type\n\nAny\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/005_get_layup_properties_example", + "href": "examples/gallery_examples/005_get_layup_properties_example.html#set-up-analysis", + "title": "Lay-up properties > Set up analysis", + "section": "Set up analysis", + "text": "Setting up the analysis consists of importing dependencies, connecting to the\nDPF server, and retrieving the example files.\nImport dependencies.\nStart a DPF server and copy the example files into the current working directory.\nSet up analysis" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices_by_dpf_material_ids", - "href": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices_by_dpf_material_ids.html#get_selected_indices_by_dpf_material_ids", - "title": "get_selected_indices_by_dpf_material_ids", - "section": "get_selected_indices_by_dpf_material_ids", - "text": "Get selected indices by DPF material IDs.\nThis method selects all indices that are in a layer with one of the selected materials.\nelement_info (ElementInfo) – Lay-up information for the element.\ndpf_material_ids (Collection[int64]) – Collection of DPF materials.\nSelected elementary indices\nNDArray[int64]\nget_selected_indices_by_dpf_material_ids\nCollection\nint64" + "objectID": "examples/gallery_examples/005_get_layup_properties_example", + "href": "examples/gallery_examples/005_get_layup_properties_example.html#set-up-model", + "title": "Lay-up properties > Set up model", + "section": "Set up model", + "text": "Set up the composite model.\nSet up model" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices_by_dpf_material_ids", - "href": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices_by_dpf_material_ids.html#ansys.dpf.composites.select_indices.get_selected_indices_by_dpf_material_ids", - "title": "get_selected_indices_by_dpf_material_ids > get_selected_indices_by_dpf_material_ids > get_selected_indices_by_dpf_material_ids", - "section": "get_selected_indices_by_dpf_material_ids > get_selected_indices_by_dpf_material_ids", - "text": "ansys.dpf.composites.select_indices.get_selected_indices_by_dpf_material_ids(element_info, dpf_material_ids)\n\nGet selected indices by DPF material IDs.\n\nThis method selects all indices that are in a layer with one of the selected materials.\n\nParameters\n\nelement_info (ElementInfo) – Lay-up information for the element.\n\ndpf_material_ids (Collection[int64]) – Collection of DPF materials.\n\nReturns\n\nSelected elementary indices\n\nReturn type\n\nNDArray[int64]\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/005_get_layup_properties_example", + "href": "examples/gallery_examples/005_get_layup_properties_example.html#get-lay-up-properties", + "title": "Lay-up properties > Get lay-up properties", + "section": "Get lay-up properties", + "text": "Get lay-up properties for all elements and show the first one as an example.\nGet lay-up properties" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3.html#e3", - "title": "e3", - "section": "e3", - "text": "e3" + "objectID": "examples/gallery_examples/005_get_layup_properties_example", + "href": "examples/gallery_examples/005_get_layup_properties_example.html#plot-lay-up-properties", + "title": "Lay-up properties > Plot lay-up properties", + "section": "Plot lay-up properties", + "text": "Plot basic layer properties (layer thicknesses, angles, and analysis ply names).\nTotal running time of the script: (0 minutes 1.484 seconds)\nDownload Jupyter notebook: 005_get_layup_properties_example.ipynb\nDownload Python source code: 005_get_layup_properties_example.py\nDownload zipped: 005_get_layup_properties_example.zip\nGallery generated by Sphinx-Gallery\nPlot lay-up properties\nDownload Jupyter notebook: 005_get_layup_properties_example.ipynb\nDownload Python source code: 005_get_layup_properties_example.py\nDownload zipped: 005_get_layup_properties_example.zip" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e3", - "title": "e3 > e3 > e3", - "section": "e3 > e3", - "text": "FailureModeEnum.e3 = 130\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s2", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s2.html#s2", + "title": "s2", + "section": "s2", + "text": "Whether to activate the failure evaluation regarding the stress in the material 2 direction.\nbool\ns2\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p21_pos", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p21_pos.html#p21_pos", - "title": "p21_pos", - "section": "p21_pos", - "text": "Global inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for tension.\nfloat\np21_pos\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s2", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s2.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.s2", + "title": "s2 > s2 > s2", + "section": "s2 > s2", + "text": "property MaxStressCriterion.s2: bool\n\nWhether to activate the failure evaluation regarding the stress in the material 2 direction.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p21_pos", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p21_pos.html#ansys.dpf.composites.failure_criteria.PuckCriterion.p21_pos", - "title": "p21_pos > p21_pos > p21_pos", - "section": "p21_pos > p21_pos", - "text": "property PuckCriterion.p21_pos: float\n\nGlobal inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for tension.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/result_definition", + "href": "api/result_definition.html#result-definition", + "title": "Result definition", + "section": "Result definition", + "text": "ResultDefinition(name, ...[, measure, ...])\nRepresents the result definition of DPF Composites.\nResultDefinitionScope(composite_definition)\nProvides the result definition scope.\nFailureMeasureEnum(value[, names, module, ...])\nProvides available failure measures.\nResult definition\nResultDefinition\nResultDefinitionScope\nFailureMeasureEnum" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s23", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s23.html#s23", - "title": "s23", - "section": "s23", - "text": "Out-of-plane shear stresses s23 of each ply.\nndarray[Any, dtype[float64]]\ns23\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.safety_margin", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.safety_margin.html#safety_margin", + "title": "safety_margin", + "section": "safety_margin", + "text": "safety_margin" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s23", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s23.html#ansys.dpf.composites.sampling_point.SamplingPoint.s23", - "title": "s23 > s23 > s23", - "section": "s23 > s23", - "text": "property SamplingPoint.s23: ndarray[Any, dtype[float64]]\n\nOut-of-plane shear stresses s23 of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.safety_margin", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.safety_margin.html#ansys.dpf.composites.sampling_point.FailureResult.safety_margin", + "title": "safety_margin > safety_margin > safety_margin", + "section": "safety_margin > safety_margin", + "text": "FailureResult.safety_margin: float\n\n" }, { - "objectID": "api/sampling_point", - "href": "api/sampling_point.html#sampling-point", - "title": "Sampling point", - "section": "Sampling point", - "text": "SamplingPoint(*args, **kwargs)\nImplements the Sampling Point object that wraps the DPF sampling point operator.\nSamplingPointFigure(figure, axes)\nProvides the sampling point figure and axes.\nFailureResult(mode, inverse_reserve_factor, ...)\nProvides the components of a failure result.\nSampling point\nSamplingPoint\nSampling Point\nSamplingPointFigure\nFailureResult" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.fracture_plane_angle", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.fracture_plane_angle.html#fracture_plane_angle", + "title": "fracture_plane_angle", + "section": "fracture_plane_angle", + "text": "Fracture plane angle in degrees. The default is 53. The value must be greater than 45. The value depends on the out-of-plane shear friction coefficient.\nfloat\nfracture_plane_angle\n53\nfloat" }, { - "objectID": "api/data_sources", - "href": "api/data_sources.html#data-sources", - "title": "Data sources", - "section": "Data sources", - "text": "CompositeDefinitionFiles(definition[, mapping])\nProvides the container for composite definition file paths.\nContinuousFiberCompositesFiles(rst, ...[, ...])\nProvides the container for continuous fiber composite file paths.\nShortFiberCompositesFiles(rst, dsdat, ...[, ...])\nProvides the container for short fiber composite file paths.\nCompositeDataSources(rst, material_support, ...)\nProvides data sources related to the composite lay-up.\nget_composite_files_from_workbench_result_folder(...)\nGet a ContinuousFiberCompositesFiles object from a result folder.\ncomposite_files_from_workbench_harmonic_analysis(...)\nGet a ContinuousFiberCompositesFiles object for a harmonic analysis.\nget_composites_data_sources(...)\nCreate DPF data sources from a ContinuousFiberCompositeFiles object.\nData sources\nCompositeDefinitionFiles\nContinuousFiberCompositesFiles\nShortFiberCompositesFiles\nCompositeDataSources\nget_composite_files_from_workbench_result_folder\nContinuousFiberCompositesFiles\ncomposite_files_from_workbench_harmonic_analysis\nContinuousFiberCompositesFiles\nget_composites_data_sources\nContinuousFiberCompositeFiles" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.fracture_plane_angle", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.fracture_plane_angle.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.fracture_plane_angle", + "title": "fracture_plane_angle > fracture_plane_angle > fracture_plane_angle", + "section": "fracture_plane_angle > fracture_plane_angle", + "text": "property CuntzeCriterion.fracture_plane_angle: float\n\nFracture plane angle in degrees. The default is 53. The value must be greater than 45. The value depends on the out-of-plane shear friction coefficient.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_1", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_1.html#larc_constants_fracture_toughness_mode_1", - "title": "Larc_Constants_fracture_toughness_mode_1", - "section": "Larc_Constants_fracture_toughness_mode_1", - "text": "Larc_Constants_fracture_toughness_mode_1" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.html#compositedatasources", + "title": "CompositeDataSources", + "section": "CompositeDataSources", + "text": "Provides data sources related to the composite lay-up.\nrst (ansys.dpf.core.data_sources.DataSources) – Result file. Currently only RST (MAPDL) is supported.\nmaterial_support (ansys.dpf.core.data_sources.DataSources) – NOTE: The material_support parameter is explicitly listed because it is currently not\nsupported (by the DPF Core) to use a distributed RST file as source for the\nmaterial support. Instead, we create a separate DataSources object for the\nmaterial support from the first RST file. This is a workaround until the\nsupport for distributed RST is added.\nengineering_data (ansys.dpf.core.data_sources.DataSources) – File with the material properties.\nold_composite_sources (dict[str, ansys.dpf.core.data_sources.DataSources]) – Member used to support assemblies in combination with the old\nDPF server (<7.0). It should be removed once the support of this\nserver version is dropped.\nCompositeDataSources.rst\n\nCompositeDataSources.material_support\n\nCompositeDataSources.composite\n\nCompositeDataSources.engineering_data\n\nCompositeDataSources.old_composite_sources\n\nCompositeDataSources\nmaterial_support\nCompositeDataSources.rst\nCompositeDataSources.material_support\nCompositeDataSources.composite\nCompositeDataSources.engineering_data\nCompositeDataSources.old_composite_sources" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_1", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_1.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_1", - "title": "Larc_Constants_fracture_toughness_mode_1 > Larc_Constants_fracture_toughness_mode_1 > Larc_Constants_fracture_toughness_mode_1", - "section": "Larc_Constants_fracture_toughness_mode_1 > Larc_Constants_fracture_toughness_mode_1", - "text": "MaterialProperty.Larc_Constants_fracture_toughness_mode_1: str = 'longitudinal_friction_coefficient_larc_constants'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.html#ansys.dpf.composites.data_sources.CompositeDataSources", + "title": "CompositeDataSources > CompositeDataSources > CompositeDataSources", + "section": "CompositeDataSources > CompositeDataSources", + "text": "class ansys.dpf.composites.data_sources.CompositeDataSources(rst, material_support, composite, engineering_data, old_composite_sources)\n\nProvides data sources related to the composite lay-up.\n\nParameters\n\nrst (ansys.dpf.core.data_sources.DataSources) – Result file. Currently only RST (MAPDL) is supported.\n\nmaterial_support (ansys.dpf.core.data_sources.DataSources) – NOTE: The material_support parameter is explicitly listed because it is currently not\nsupported (by the DPF Core) to use a distributed RST file as source for the\nmaterial support. Instead, we create a separate DataSources object for the\nmaterial support from the first RST file. This is a workaround until the\nsupport for distributed RST is added.\n\nengineering_data (ansys.dpf.core.data_sources.DataSources) – File with the material properties.\n\nold_composite_sources (dict[str, ansys.dpf.core.data_sources.DataSources]) – Member used to support assemblies in combination with the old\nDPF server (<7.0). It should be removed once the support of this\nserver version is dropped.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nCompositeDataSources.rst\n\n\n\nCompositeDataSources.material_support\n\n\n\nCompositeDataSources.composite\n\n\n\nCompositeDataSources.engineering_data\n\n\n\nCompositeDataSources.old_composite_sources\n\n\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_polar_plot", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_polar_plot.html#get_polar_plot", - "title": "get_polar_plot", - "section": "get_polar_plot", - "text": "Create a standard polar plot to visualize the polar properties of the laminate.\ncomponents (Sequence[str], default: ('E1', 'E2', 'G12')) – Stiffness quantities to plot.\nSamplingPointFigure\nget_polar_plot\nSequence\nstr\n('E1', 'E2', 'G12')\nSamplingPointFigure" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_constant_property_dict", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_constant_property_dict.html#get_constant_property_dict", + "title": "get_constant_property_dict", + "section": "get_constant_property_dict", + "text": "Get a dictionary with constant properties.\nReturns a dictionary with the DPF material ID as a key and\na dictionary with the requested properties as the value. Only constant properties\nare supported. Variable properties are evaluated at their\ndefault values.\nBecause this method can be slow to evaluate, it should not\nbe called in a loop.\nmaterial_properties (Collection[MaterialProperty]) – Material properties to request.\nmaterials_provider (Operator) – DPF Materials provider operator. This value is Available from the\nCompositeModel.material_operators attribute.\ndata_source_or_streams_provider (DataSources | Operator) – DPF data source or stream provider that contains the RST file.\nmesh (MeshedRegion) – DPF meshed region enriched with lay-up information.\ndict[int64, dict[MaterialProperty, float]]\nget_constant_property_dict\nCollection\nMaterialProperty\nOperator\nCompositeModel.material_operators\nDataSources\nOperator\nMeshedRegion\ndict\nint64\ndict\nMaterialProperty\nfloat" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_constant_property_dict", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_constant_property_dict.html#ansys.dpf.composites.layup_info.material_properties.get_constant_property_dict", + "title": "get_constant_property_dict > get_constant_property_dict > get_constant_property_dict", + "section": "get_constant_property_dict > get_constant_property_dict", + "text": "ansys.dpf.composites.layup_info.material_properties.get_constant_property_dict(material_properties, materials_provider, data_source_or_streams_provider, mesh)\n\nGet a dictionary with constant properties.\n\nReturns a dictionary with the DPF material ID as a key and\na dictionary with the requested properties as the value. Only constant properties\nare supported. Variable properties are evaluated at their\ndefault values.\nBecause this method can be slow to evaluate, it should not\nbe called in a loop.\n\nParameters\n\nmaterial_properties (Collection[MaterialProperty]) – Material properties to request.\n\nmaterials_provider (Operator) – DPF Materials provider operator. This value is Available from the\nCompositeModel.material_operators attribute.\n\ndata_source_or_streams_provider (DataSources | Operator) – DPF data source or stream provider that contains the RST file.\n\nmesh (MeshedRegion) – DPF meshed region enriched with lay-up information.\n\nReturn type\n\ndict[int64, dict[MaterialProperty, float]]\n\n!! processed by numpydoc !!" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pd", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pd.html#pd", + "title": "pd", + "section": "pd", + "text": "Whether to activate the failure evaluation regarding delamination if dim is equal to 3.\nbool\npd\nbool" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pd", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pd.html#ansys.dpf.composites.failure_criteria.PuckCriterion.pd", + "title": "pd > pd > pd", + "section": "pd > pd", + "text": "property PuckCriterion.pd: bool\n\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.center", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.center.html#center", + "title": "center", + "section": "center", + "text": "Return a centered string of length width.\nPadding is done using the specified fill character (default is a space).\ncenter" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.center", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.center.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.center", + "title": "center > center > center", + "section": "center > center", + "text": "FailureMeasureEnum.center(width, fillchar=' ', /)\n\nReturn a centered string of length width.\n\nPadding is done using the specified fill character (default is a space).\n\n!! processed by numpydoc !!" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.html#samplingpoint", + "title": "SamplingPoint", + "section": "SamplingPoint", + "text": "Implements the Sampling Point object that wraps the DPF sampling point operator.\nUse CompositeModel.get_sampling_point() to get a sampling point object.\nThis class provides for plotting the lay-up and results at a certain point of the\nlayered structure. The results, including analysis_plies, e1, s12, and\nfailure_modes, are always from the bottom to the top of the laminate (along\nthe element normal direction). Postprocessing results such as e1 are returned\nas flat arrays where self.spots_per_ply can be used to compute the index for\na certain ply.\nThe results of layered elements are stored per integration point. A layered shell element\nhas a number of in-plane integration points (depending on the integration scheme) and\ntypically three integration points through the thickness. The through-the-thickness\nintegration points are called spots. They are typically at the BOTTOM, MIDDLE,\nand TOP of the layer. This notation is used here to identify the corresponding data.\nThe SamplingPoint class returns three results per layer (one for each spot) because\nthe results of the in-plane integration points are interpolated to the centroid of the element.\nThe following table shows an example of a laminate with three layers. So a result, such as\ns1 has nine values, three for each ply.\nLayer\nIndex\nSpot\nLayer 3\n8\n7\n6\nTOP of Layer 3\nMIDDLE of Layer 3\nBOTTOM of Layer 3\nLayer 2\n5\n4\n3\nTOP of Layer 2\nMIDDLE of Layer 2\nBOTTOM of Layer 2\nLayer 1\n2\n1\n0\nTOP of Layer 1\nMIDDLE of Layer 1\nBOTTOM of Layer 1\nThe get_indices and get_offsets_by_spots methods simplify the indexing and\nfiltering of the data.\nSamplingPoint.add_ply_sequence_to_plot(axes)\nAdd the stacking (ply and text) to an axis or plot.\nSamplingPoint.add_results_to_plot(axes, ...)\nAdd results (strain, stress, or failure values) to an Axes object.\nSamplingPoint.get_indices([spots])\nGet the indices of the selected spots (interfaces) for each ply.\nSamplingPoint.get_offsets_by_spots([spots, ...])\nAccess the y coordinates of the selected spots (interfaces) for each ply.\nSamplingPoint.get_ply_wise_critical_failures()\nGet the critical failure value and modes per ply.\nSamplingPoint.get_polar_plot([components])\nCreate a standard polar plot to visualize the polar properties of the laminate.\nSamplingPoint.get_result_plots([...])\nGenerate a figure with a grid of axes (plot) for each selected result entity.\nSamplingPoint.analysis_plies\nList of analysis plies from the bottom to the top.\nSamplingPoint.e1\nStrains in the material 1 direction of each ply.\nSamplingPoint.e12\nIn-plane shear strains e12 of each ply.\nSamplingPoint.e13\nOut-of-plane shear strains e13 of each ply.\nSamplingPoint.e2\nStrains in the material 2 direction of each ply.\nSamplingPoint.e23\nOut-of-plane shear strains e23 of each ply.\nSamplingPoint.e3\nStrains in the material 3 direction of each ply.\nSamplingPoint.element_id\nElement label for sampling the laminate.\nSamplingPoint.failure_modes\nCritical failure mode of each ply.\nSamplingPoint.inverse_reserve_factor\nCritical inverse reserve factor of each ply.\nSamplingPoint.is_uptodate\nTrue if the Sampling Point is up-to-date.\nSamplingPoint.margin_of_safety\nLowest margin of safety of each ply.\nSamplingPoint.name\nName of the object.\nSamplingPoint.number_of_plies\nNumber of plies.\nSamplingPoint.offsets\nZ coordinates for each interface and ply.\nSamplingPoint.polar_properties_E1\nPolar property E1 of the laminate.\nSamplingPoint.polar_properties_E2\nPolar property E2 of the laminate.\nSamplingPoint.polar_properties_G12\nPolar property G12 of the laminate.\nSamplingPoint.reserve_factor\nLowest reserve factor of each ply.\nSamplingPoint.results\nResults of the sampling point results as a JSON dictionary.\nSamplingPoint.s1\nStresses in the material 1 direction of each ply.\nSamplingPoint.s12\nIn-plane shear stresses s12 of each ply.\nSamplingPoint.s13\nOut-of-plane shear stresses s13 of each ply.\nSamplingPoint.s2\nStresses in the material 2 direction of each ply.\nSamplingPoint.s23\nOut-of-plane shear stresses s23 of each ply.\nSamplingPoint.s3\nStresses in the material 3 direction of each ply.\nSamplingPoint.spots_per_ply\nNumber of through-the-thickness integration points per ply.\nSamplingPoint\nSampling Point\nCompositeModel.get_sampling_point()\nanalysis_plies\ne1\ns12\nfailure_modes\ne1\nself.spots_per_ply\nBOTTOM\nMIDDLE\nTOP\nSamplingPoint\ns1\nSamplingPoint.add_ply_sequence_to_plot\nSamplingPoint.add_results_to_plot\nAxes\nSamplingPoint.get_indices\nSamplingPoint.get_offsets_by_spots\nSamplingPoint.get_ply_wise_critical_failures\nSamplingPoint.get_polar_plot\nSamplingPoint.get_result_plots\nSamplingPoint.analysis_plies\nSamplingPoint.e1\nSamplingPoint.e12\nSamplingPoint.e13\nSamplingPoint.e2\nSamplingPoint.e23\nSamplingPoint.e3\nSamplingPoint.element_id\nSamplingPoint.failure_modes\nSamplingPoint.inverse_reserve_factor\nSamplingPoint.is_uptodate\nSamplingPoint.margin_of_safety\nSamplingPoint.name\nSamplingPoint.number_of_plies\nSamplingPoint.offsets\nSamplingPoint.polar_properties_E1\nSamplingPoint.polar_properties_E2\nSamplingPoint.polar_properties_G12\nSamplingPoint.reserve_factor\nSamplingPoint.results\nSamplingPoint.s1\nSamplingPoint.s12\nSamplingPoint.s13\nSamplingPoint.s2\nSamplingPoint.s23\nSamplingPoint.s3\nSamplingPoint.spots_per_ply" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.html#ansys.dpf.composites.sampling_point.SamplingPoint", + "title": "SamplingPoint > SamplingPoint > SamplingPoint", + "section": "SamplingPoint > SamplingPoint", + "text": "class ansys.dpf.composites.sampling_point.SamplingPoint(*args, **kwargs)\n\nImplements the Sampling Point object that wraps the DPF sampling point operator.\n\nUse CompositeModel.get_sampling_point() to get a sampling point object.\nThis class provides for plotting the lay-up and results at a certain point of the\nlayered structure. The results, including analysis_plies, e1, s12, and\nfailure_modes, are always from the bottom to the top of the laminate (along\nthe element normal direction). Postprocessing results such as e1 are returned\nas flat arrays where self.spots_per_ply can be used to compute the index for\na certain ply.\n\nNotes\n\nThe results of layered elements are stored per integration point. A layered shell element\nhas a number of in-plane integration points (depending on the integration scheme) and\ntypically three integration points through the thickness. The through-the-thickness\nintegration points are called spots. They are typically at the BOTTOM, MIDDLE,\nand TOP of the layer. This notation is used here to identify the corresponding data.\n\nThe SamplingPoint class returns three results per layer (one for each spot) because\nthe results of the in-plane integration points are interpolated to the centroid of the element.\nThe following table shows an example of a laminate with three layers. So a result, such as\ns1 has nine values, three for each ply.\n\n\n\n\n\n\n\nLayer\n\nIndex\n\nSpot\n\nLayer 3\n\n8\n\n7\n\n6\n\nTOP of Layer 3\n\nMIDDLE of Layer 3\n\nBOTTOM of Layer 3\n\nLayer 2\n\n5\n\n4\n\n3\n\nTOP of Layer 2\n\nMIDDLE of Layer 2\n\nBOTTOM of Layer 2\n\nLayer 1\n\n2\n\n1\n\n0\n\nTOP of Layer 1\n\nMIDDLE of Layer 1\n\nBOTTOM of Layer 1\n\nThe get_indices and get_offsets_by_spots methods simplify the indexing and\nfiltering of the data.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nSamplingPoint.add_ply_sequence_to_plot(axes)\n\nAdd the stacking (ply and text) to an axis or plot.\n\nSamplingPoint.add_results_to_plot(axes, ...)\n\nAdd results (strain, stress, or failure values) to an Axes object.\n\nSamplingPoint.get_indices([spots])\n\nGet the indices of the selected spots (interfaces) for each ply.\n\nSamplingPoint.get_offsets_by_spots([spots, ...])\n\nAccess the y coordinates of the selected spots (interfaces) for each ply.\n\nSamplingPoint.get_ply_wise_critical_failures()\n\nGet the critical failure value and modes per ply.\n\nSamplingPoint.get_polar_plot([components])\n\nCreate a standard polar plot to visualize the polar properties of the laminate.\n\nSamplingPoint.get_result_plots([...])\n\nGenerate a figure with a grid of axes (plot) for each selected result entity.\n\n\n\nAttributes\n\n\n\n\n\n\n\nSamplingPoint.analysis_plies\n\nList of analysis plies from the bottom to the top.\n\nSamplingPoint.e1\n\nStrains in the material 1 direction of each ply.\n\nSamplingPoint.e12\n\nIn-plane shear strains e12 of each ply.\n\nSamplingPoint.e13\n\nOut-of-plane shear strains e13 of each ply.\n\nSamplingPoint.e2\n\nStrains in the material 2 direction of each ply.\n\nSamplingPoint.e23\n\nOut-of-plane shear strains e23 of each ply.\n\nSamplingPoint.e3\n\nStrains in the material 3 direction of each ply.\n\nSamplingPoint.element_id\n\nElement label for sampling the laminate.\n\nSamplingPoint.failure_modes\n\nCritical failure mode of each ply.\n\nSamplingPoint.inverse_reserve_factor\n\nCritical inverse reserve factor of each ply.\n\nSamplingPoint.is_uptodate\n\nTrue if the Sampling Point is up-to-date.\n\nSamplingPoint.margin_of_safety\n\nLowest margin of safety of each ply.\n\nSamplingPoint.name\n\nName of the object.\n\nSamplingPoint.number_of_plies\n\nNumber of plies.\n\nSamplingPoint.offsets\n\nZ coordinates for each interface and ply.\n\nSamplingPoint.polar_properties_E1\n\nPolar property E1 of the laminate.\n\nSamplingPoint.polar_properties_E2\n\nPolar property E2 of the laminate.\n\nSamplingPoint.polar_properties_G12\n\nPolar property G12 of the laminate.\n\nSamplingPoint.reserve_factor\n\nLowest reserve factor of each ply.\n\nSamplingPoint.results\n\nResults of the sampling point results as a JSON dictionary.\n\nSamplingPoint.s1\n\nStresses in the material 1 direction of each ply.\n\nSamplingPoint.s12\n\nIn-plane shear stresses s12 of each ply.\n\nSamplingPoint.s13\n\nOut-of-plane shear stresses s13 of each ply.\n\nSamplingPoint.s2\n\nStresses in the material 2 direction of each ply.\n\nSamplingPoint.s23\n\nOut-of-plane shear stresses s23 of each ply.\n\nSamplingPoint.s3\n\nStresses in the material 3 direction of each ply.\n\nSamplingPoint.spots_per_ply\n\nNumber of through-the-thickness integration points per ply.\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_polar_plot", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_polar_plot.html#ansys.dpf.composites.sampling_point.SamplingPoint.get_polar_plot", - "title": "get_polar_plot > get_polar_plot > get_polar_plot", - "section": "get_polar_plot > get_polar_plot", - "text": "SamplingPoint.get_polar_plot(components=('E1', 'E2', 'G12'))\n\nCreate a standard polar plot to visualize the polar properties of the laminate.\n\nParameters\n\ncomponents (Sequence[str], default: ('E1', 'E2', 'G12')) – Stiffness quantities to plot.\n\nExamples\n\n>>> figure, axes = sampling_point.get_polar_plot(components=[\"E1\", \"G12\"])\n\nReturn type\n\nSamplingPointFigure\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.removeprefix", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.removeprefix.html#removeprefix", + "title": "removeprefix", + "section": "removeprefix", + "text": "Return a str with the given prefix string removed if present.\nIf the string starts with the prefix string, return string[len(prefix):].\nOtherwise, return a copy of the original string.\nremoveprefix" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.get_composite_files_from_workbench_result_folder", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.get_composite_files_from_workbench_result_folder.html#get_composite_files_from_workbench_result_folder", - "title": "get_composite_files_from_workbench_result_folder", - "section": "get_composite_files_from_workbench_result_folder", - "text": "Get a ContinuousFiberCompositesFiles object from a result folder.\nThis function assumes a typical Workbench folder structure for a composite\nsimulation. If this method is not able to build the ContinuousFiberCompositesFiles\nobject, you can follow these steps:\nIn the main Workbench window, activate the files panel by selecting\nView > Files. This shows the location of all files used in the\nworkbench project. You can determine the different attributes of the\nContinuousFiberCompositesFiles object:\nrst: A list of files containing either the single file.rst\nfile that belongs to the cell ID of the solution, or the distributed\nfile0.rst to fileN.rst files.\nengineering_data: The MatML.xml file in the same folder as the RST file.\ncomposite: There can be multiple composite definitions,\none definition for each ACP system if shell data is transferred\nand one definition for each solid model if solid data is transferred.\nAll the ACPCompositeDefinitions.h5 and ACPSolidModel*.h5\nfiles that are used in the solution must be added to the\nContinuousFiberCompositesFiles.composite dictionary.\nThe key can be chosen freely. Next to the ACPCompositeDefinitions.h5\nand ACPSolidModel\\*.h5 files, corresponding ACPCompositeDefinitions.mapping\nand ACPSolidModel*.mapping files can be found (optional).\nIf they exist, they must be added as well.\nThe following example shows how a\nContinuousFiberCompositesFiles object can be built.\nThe project in this example has two ACP Pre systems, one that exports\nshell information and one that exports solid information.\nThe files are located in these locations:\nResult file:\nproject_root_folder/dp0/SYS/MECH/file.rst\nEngineering data file:\nproject_root_folder/dp0/SYS/MECH/MatML.xml\nComposite definition and mapping files for the solid model:\nproject_root_folder/dp0/ACP-Pre-1/ACPSolidModel_SM.h5\nproject_root_folder/dp0/ACP-Pre-1/ACPSolidModel_SM.mapping\nComposite definition and mapping files for the shell model:\nproject_root_folder/dp0/ACP-Pre-2/ACPCompositeDefinitions.h5\nproject_root_folder/dp0/ACP-Pre-2/ACPCompositeDefinitions.mapping\nThe code creates the corresponding ContinuousFiberCompositesFiles object:\nresult_folder (Union[str, PathLike[str]]) – Result folder of the solution. Right-click the solution item in the Ansys Mechanical tree\nand select Open Solver Files Directory to obtain the result folder.\nensure_composite_definitions_found (bool, default: True) – Whether to check if at least one composite definition (shell or solid) has been found.\nContinuousFiberCompositesFiles\nget_composite_files_from_workbench_result_folder\nContinuousFiberCompositesFiles\nContinuousFiberCompositesFiles\nContinuousFiberCompositesFiles\nrst\nfile.rst\nfile0.rst\nfileN.rst\nengineering_data\nMatML.xml\ncomposite\nACPCompositeDefinitions.h5\nACPSolidModel*.h5\nContinuousFiberCompositesFiles.composite\nACPCompositeDefinitions.h5\nACPSolidModel\\*.h5\nACPCompositeDefinitions.mapping\nACPSolidModel*.mapping\nContinuousFiberCompositesFiles\nproject_root_folder/dp0/SYS/MECH/file.rst\nproject_root_folder/dp0/SYS/MECH/MatML.xml\nproject_root_folder/dp0/ACP-Pre-1/ACPSolidModel_SM.h5\nproject_root_folder/dp0/ACP-Pre-1/ACPSolidModel_SM.mapping\nproject_root_folder/dp0/ACP-Pre-2/ACPCompositeDefinitions.h5\nproject_root_folder/dp0/ACP-Pre-2/ACPCompositeDefinitions.mapping\nContinuousFiberCompositesFiles\nUnion\nstr\nPathLike\nstr\nbool\nTrue\nContinuousFiberCompositesFiles" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.removeprefix", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.removeprefix.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.removeprefix", + "title": "removeprefix > removeprefix > removeprefix", + "section": "removeprefix > removeprefix", + "text": "FailureMeasureEnum.removeprefix(prefix, /)\n\nReturn a str with the given prefix string removed if present.\n\nIf the string starts with the prefix string, return string[len(prefix):].\nOtherwise, return a copy of the original string.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.get_composite_files_from_workbench_result_folder", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.get_composite_files_from_workbench_result_folder.html#ansys.dpf.composites.data_sources.get_composite_files_from_workbench_result_folder", - "title": "get_composite_files_from_workbench_result_folder > get_composite_files_from_workbench_result_folder > get_composite_files_from_workbench_result_folder", - "section": "get_composite_files_from_workbench_result_folder > get_composite_files_from_workbench_result_folder", - "text": "ansys.dpf.composites.data_sources.get_composite_files_from_workbench_result_folder(result_folder, ensure_composite_definitions_found=True)\n\nGet a ContinuousFiberCompositesFiles object from a result folder.\n\nThis function assumes a typical Workbench folder structure for a composite\nsimulation. If this method is not able to build the ContinuousFiberCompositesFiles\nobject, you can follow these steps:\n\nIn the main Workbench window, activate the files panel by selecting\nView > Files. This shows the location of all files used in the\nworkbench project. You can determine the different attributes of the\nContinuousFiberCompositesFiles object:\n\nrst: A list of files containing either the single file.rst\nfile that belongs to the cell ID of the solution, or the distributed\nfile0.rst to fileN.rst files.\n\nengineering_data: The MatML.xml file in the same folder as the RST file.\n\ncomposite: There can be multiple composite definitions,\none definition for each ACP system if shell data is transferred\nand one definition for each solid model if solid data is transferred.\nAll the ACPCompositeDefinitions.h5 and ACPSolidModel*.h5\nfiles that are used in the solution must be added to the\nContinuousFiberCompositesFiles.composite dictionary.\nThe key can be chosen freely. Next to the ACPCompositeDefinitions.h5\nand ACPSolidModel\\*.h5 files, corresponding ACPCompositeDefinitions.mapping\nand ACPSolidModel*.mapping files can be found (optional).\nIf they exist, they must be added as well.\n\nThe following example shows how a\nContinuousFiberCompositesFiles object can be built.\nThe project in this example has two ACP Pre systems, one that exports\nshell information and one that exports solid information.\n\nThe files are located in these locations:\n\nResult file:\n\nproject_root_folder/dp0/SYS/MECH/file.rst\n\nEngineering data file:\n\nproject_root_folder/dp0/SYS/MECH/MatML.xml\n\nComposite definition and mapping files for the solid model:\n\nproject_root_folder/dp0/ACP-Pre-1/ACPSolidModel_SM.h5\n\nproject_root_folder/dp0/ACP-Pre-1/ACPSolidModel_SM.mapping\n\nComposite definition and mapping files for the shell model:\n\nproject_root_folder/dp0/ACP-Pre-2/ACPCompositeDefinitions.h5\n\nproject_root_folder/dp0/ACP-Pre-2/ACPCompositeDefinitions.mapping\n\nThe code creates the corresponding ContinuousFiberCompositesFiles object:\n\nContinuousFiberCompositesFiles(\n rst=[\"project_root_folder/dp0/SYS/MECH/file.rst\"],\n composite={\n \"solid\": CompositeDefinitionFiles(\n definition=\"project_root_folder/dp0/ACP-Pre-1/ACPSolidModel_SM.h5\",\n mapping=\"project_root_folder/dp0/ACP-Pre-1/ACPSolidModel_SM.mapping\"\n ),\n \"shell\": CompositeDefinitionFiles(\n definition=\"project_root_folder/dp0/ACP-Pre-2/ACPCompositeDefinitions.h5\",\n mapping=\"project_root_folder/dp0/ACP-Pre-2/ACPCompositeDefinitions.mapping\"\n )\n },\n engineering_data=\"project_root_folder/dp0/SYS/MECH/MatML.xml\"\n)\n\nParameters\n\nresult_folder (Union[str, PathLike[str]]) – Result folder of the solution. Right-click the solution item in the Ansys Mechanical tree\nand select Open Solver Files Directory to obtain the result folder.\n\nensure_composite_definitions_found (bool, default: True) – Whether to check if at least one composite definition (shell or solid) has been found.\n\nReturn type\n\nContinuousFiberCompositesFiles\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.result_info_provider", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.result_info_provider.html#result_info_provider", + "title": "result_info_provider", + "section": "result_info_provider", + "text": "Get result_info_provider.\nOperator\nresult_info_provider\nOperator" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_pos", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_pos.html#puck_constants_p_22_pos", - "title": "Puck_Constants_p_22_pos", - "section": "Puck_Constants_p_22_pos", - "text": "Puck_Constants_p_22_pos" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.result_info_provider", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.result_info_provider.html#ansys.dpf.composites.layup_info.material_operators.MaterialOperators.result_info_provider", + "title": "result_info_provider > result_info_provider > result_info_provider", + "section": "result_info_provider > result_info_provider", + "text": "property MaterialOperators.result_info_provider: Operator\n\nGet result_info_provider.\n\nReturn type\n\nOperator\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_pos", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_pos.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_pos", - "title": "Puck_Constants_p_22_pos > Puck_Constants_p_22_pos > Puck_Constants_p_22_pos", - "section": "Puck_Constants_p_22_pos > Puck_Constants_p_22_pos", - "text": "MaterialProperty.Puck_Constants_p_22_pos: str = 'tensile_inclination_yz_puck_constants'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.RST", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.RST.html#rst", + "title": "RST", + "section": "RST", + "text": "RST" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_json.html#to_json", - "title": "to_json", - "section": "to_json", - "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.RST", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.RST.html#ansys.dpf.composites.layup_info.LayupModelContextType.RST", + "title": "RST > RST > RST", + "section": "RST > RST", + "text": "LayupModelContextType.RST = 2\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_json.html#ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_json", - "title": "to_json > to_json > to_json", - "section": "to_json > to_json", - "text": "ShearCrimpingCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" + "objectID": "api/server_helpers", + "href": "api/server_helpers.html#server-helpers", + "title": "Server helpers", + "section": "Server helpers", + "text": "load_composites_plugin(server[, ansys_path])\nLoad composites plugins and its dependencies.\nconnect_to_or_start_server([port, ip, ...])\nConnect to or start a DPF server with the DPF Composites plugin loaded.\nupload_continuous_fiber_composite_files_to_server(...)\nUpload continuous fiber composites files to server.\nupload_short_fiber_composite_files_to_server(...)\nUpload short fiber composites files to server.\nServer helpers\nload_composites_plugin\nconnect_to_or_start_server\nupload_continuous_fiber_composite_files_to_server\nupload_short_fiber_composite_files_to_server" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.name.html#name", - "title": "name", - "section": "name", - "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" + "objectID": "api/ply_wise_data", + "href": "api/ply_wise_data.html#ply-wise-data", + "title": "Ply wise data", + "section": "Ply wise data", + "text": "SpotReductionStrategy(value[, names, ...])\nProvides the strategy for getting from spot values (BOT, MID, TOP) to a single value.\nget_ply_wise_data(field, ply_name, mesh[, ...])\nGet ply-wise data from a field.\nPly wise data\nSpotReductionStrategy\nget_ply_wise_data" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.name.html#ansys.dpf.composites.failure_criteria.HoffmanCriterion.name", - "title": "name > name > name", - "section": "name > name", - "text": "property HoffmanCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_m", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_m.html#puck_constants_m", + "title": "Puck_Constants_m", + "section": "Puck_Constants_m", + "text": "Puck_Constants_m" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vms", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vms.html#wf_vms", - "title": "wf_vms", - "section": "wf_vms", - "text": "Weighting factor of the stress criterion (vms).\nfloat\nwf_vms\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_m", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_m.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_m", + "title": "Puck_Constants_m > Puck_Constants_m > Puck_Constants_m", + "section": "Puck_Constants_m > Puck_Constants_m", + "text": "MaterialProperty.Puck_Constants_m: str = 'degradation_parameter_m_puck_constants'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vms", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vms.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vms", - "title": "wf_vms > wf_vms > wf_vms", - "section": "wf_vms > wf_vms", - "text": "property VonMisesCriterion.wf_vms: float\n\nWeighting factor of the stress criterion (vms).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.istitle", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.istitle.html#istitle", + "title": "istitle", + "section": "istitle", + "text": "Return True if the string is a title-cased string, False otherwise.\nIn a title-cased string, upper- and title-case characters may only\nfollow uncased characters and lowercase characters only cased ones.\nistitle" }, { - "objectID": "examples/gallery_examples/sg_execution_times", - "href": "examples/gallery_examples/sg_execution_times.html#computation-times", - "title": "Computation times", - "section": "Computation times", - "text": "01:20.085 total execution time for 15 files from examples/gallery_examples:\nExample\nTime\nMem (MB)\nsphx_glr_examples_gallery_examples_001_failure_operator_example.py (001_failure_operator_example.py)\n00:11.642\n0.0\nsphx_glr_examples_gallery_examples_010_harmonic_example.py (010_harmonic_example.py)\n00:10.117\n0.0\nsphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py (007_interlaminar_normal_stress_example.py)\n00:07.347\n0.0\nsphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py (009_short_fiber_orientation_tensor.py)\n00:05.877\n0.0\nsphx_glr_examples_gallery_examples_014_cyclic_symmetry_example.py (014_cyclic_symmetry_example.py)\n00:05.728\n0.0\nsphx_glr_examples_gallery_examples_011_rst_workflow.py (011_rst_workflow.py)\n00:05.110\n0.0\nsphx_glr_examples_gallery_examples_002_sampling_point_example.py (002_sampling_point_example.py)\n00:04.837\n0.0\nsphx_glr_examples_gallery_examples_006_filter_composite_data_example.py (006_filter_composite_data_example.py)\n00:04.682\n0.0\nsphx_glr_examples_gallery_examples_013_thermal_example.py (013_thermal_example.py)\n00:04.427\n0.0\nsphx_glr_examples_gallery_examples_099_dpf_composite_failure_workflow.py (099_dpf_composite_failure_workflow.py)\n00:04.414\n0.0\nsphx_glr_examples_gallery_examples_008_assembly_example.py (008_assembly_example.py)\n00:04.157\n0.0\nsphx_glr_examples_gallery_examples_012_fatigue_example.py (012_fatigue_example.py)\n00:03.564\n0.0\nsphx_glr_examples_gallery_examples_004_get_material_properties_example.py (004_get_material_properties_example.py)\n00:03.523\n0.0\nsphx_glr_examples_gallery_examples_003_short_fiber_example.py (003_short_fiber_example.py)\n00:03.262\n0.0\nsphx_glr_examples_gallery_examples_005_get_layup_properties_example.py (005_get_layup_properties_example.py)\n00:01.399\n0.0\nComputation times\n001_failure_operator_example.py\n010_harmonic_example.py\n007_interlaminar_normal_stress_example.py\n009_short_fiber_orientation_tensor.py\n014_cyclic_symmetry_example.py\n011_rst_workflow.py\n002_sampling_point_example.py\n006_filter_composite_data_example.py\n013_thermal_example.py\n099_dpf_composite_failure_workflow.py\n008_assembly_example.py\n012_fatigue_example.py\n004_get_material_properties_example.py\n003_short_fiber_example.py\n005_get_layup_properties_example.py" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.istitle", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.istitle.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.istitle", + "title": "istitle > istitle > istitle", + "section": "istitle > istitle", + "text": "FailureMeasureEnum.istitle(/)\n\nReturn True if the string is a title-cased string, False otherwise.\n\nIn a title-cased string, upper- and title-case characters may only\nfollow uncased characters and lowercase characters only cased ones.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.to_dict.html#to_dict", - "title": "to_dict", - "section": "to_dict", - "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.RESERVE_FACTOR", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.RESERVE_FACTOR.html#reserve_factor", + "title": "RESERVE_FACTOR", + "section": "RESERVE_FACTOR", + "text": "RESERVE_FACTOR" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.HashinCriterion.to_dict", - "title": "to_dict > to_dict > to_dict", - "section": "to_dict > to_dict", - "text": "HashinCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.RESERVE_FACTOR", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.RESERVE_FACTOR.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.RESERVE_FACTOR", + "title": "RESERVE_FACTOR > RESERVE_FACTOR > RESERVE_FACTOR", + "section": "RESERVE_FACTOR > RESERVE_FACTOR", + "text": "FailureMeasureEnum.RESERVE_FACTOR: str = 'safety_factor'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e12", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e12.html#e12", - "title": "e12", - "section": "e12", - "text": "In-plane shear strains e12 of each ply.\nndarray[Any, dtype[float64]]\ne12\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYt", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYt.html#strain_limits_eyt", + "title": "Strain_Limits_eYt", + "section": "Strain_Limits_eYt", + "text": "Strain_Limits_eYt" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e12", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e12.html#ansys.dpf.composites.sampling_point.SamplingPoint.e12", - "title": "e12 > e12 > e12", - "section": "e12 > e12", - "text": "property SamplingPoint.e12: ndarray[Any, dtype[float64]]\n\nIn-plane shear strains e12 of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYt", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYt.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eYt", + "title": "Strain_Limits_eYt > Strain_Limits_eYt > Strain_Limits_eYt", + "section": "Strain_Limits_eYt > Strain_Limits_eYt", + "text": "MaterialProperty.Strain_Limits_eYt: str = 'strain_tensile_y_direction'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_laminate_offset", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_laminate_offset.html#get_element_laminate_offset", - "title": "get_element_laminate_offset", - "section": "get_element_laminate_offset", - "text": "Get the laminate offset of an element.\nTHis method returns None if the element is not layered.\nelement_id (int) – Element ID or label.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nOptional[float64]\nget_element_laminate_offset\nNone\nint\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nOptional\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.core_model", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.core_model.html#core_model", + "title": "core_model", + "section": "core_model", + "text": "Underlying DPF core model.\nModel\ncore_model\nModel" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_laminate_offset", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_laminate_offset.html#ansys.dpf.composites.composite_model.CompositeModel.get_element_laminate_offset", - "title": "get_element_laminate_offset > get_element_laminate_offset > get_element_laminate_offset", - "section": "get_element_laminate_offset > get_element_laminate_offset", - "text": "CompositeModel.get_element_laminate_offset(element_id, composite_definition_label=None)\n\nGet the laminate offset of an element.\n\nTHis method returns None if the element is not layered.\n\nParameters\n\nelement_id (int) – Element ID or label.\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\n\nReturn type\n\nOptional[float64]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.core_model", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.core_model.html#ansys.dpf.composites.composite_model.CompositeModel.core_model", + "title": "core_model > core_model > core_model", + "section": "core_model > core_model", + "text": "property CompositeModel.core_model: Model\n\nUnderlying DPF core model.\n\nReturn type\n\nModel\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yt", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yt.html#stress_limits_yt", - "title": "Stress_Limits_Yt", - "section": "Stress_Limits_Yt", - "text": "Stress_Limits_Yt" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rindex", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rindex.html#rindex", + "title": "rindex", + "section": "rindex", + "text": "Return the highest index in S where substring sub is found, such that sub is contained within S[start:end].\nOptional arguments start and end are interpreted as in slice notation.\nRaises ValueError when the substring is not found.\nrindex" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yt", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yt.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yt", - "title": "Stress_Limits_Yt > Stress_Limits_Yt > Stress_Limits_Yt", - "section": "Stress_Limits_Yt > Stress_Limits_Yt", - "text": "MaterialProperty.Stress_Limits_Yt: str = 'stress_tensile_y_direction'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rindex", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rindex.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.rindex", + "title": "rindex > rindex > rindex", + "section": "rindex > rindex", + "text": "FailureMeasureEnum.rindex(sub, [start, [end]], /)\n\nReturn the highest index in S where substring sub is found, such that sub is contained within S[start:end].\n\nOptional arguments start and end are interpreted as in slice notation.\nRaises ValueError when the substring is not found.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.TOP", - "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.TOP.html#top", - "title": "TOP", - "section": "TOP", - "text": "TOP" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.dpf_material_ids", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.dpf_material_ids.html#dpf_material_ids", + "title": "dpf_material_ids", + "section": "dpf_material_ids", + "text": "dpf_material_ids" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.TOP", - "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.TOP.html#ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.TOP", - "title": "TOP > TOP > TOP", - "section": "TOP > TOP", - "text": "SpotReductionStrategy.TOP = 'TOP'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.dpf_material_ids", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.dpf_material_ids.html#ansys.dpf.composites.layup_info.ElementInfo.dpf_material_ids", + "title": "dpf_material_ids > dpf_material_ids > dpf_material_ids", + "section": "dpf_material_ids > dpf_material_ids", + "text": "ElementInfo.dpf_material_ids: ndarray[Any, dtype[int64]]\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.casefold", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.casefold.html#casefold", - "title": "casefold", - "section": "casefold", - "text": "Return a version of the string suitable for caseless comparisons.\ncasefold" + "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MID", + "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MID.html#mid", + "title": "MID", + "section": "MID", + "text": "MID" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.casefold", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.casefold.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.casefold", - "title": "casefold > casefold > casefold", - "section": "casefold > casefold", - "text": "FailureMeasureEnum.casefold(/)\n\nReturn a version of the string suitable for caseless comparisons.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MID", + "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MID.html#ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MID", + "title": "MID > MID > MID", + "section": "MID > MID", + "text": "SpotReductionStrategy.MID = 'MID'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmc.html#cmc", - "title": "cmc", - "section": "cmc", - "text": "Activates the failure evaluation of the matrix due to compression or shear.\nbool\ncmc\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.emax", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.emax.html#emax", + "title": "emax", + "section": "emax", + "text": "emax" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.emax", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.emax.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.emax", + "title": "emax > emax > emax", + "section": "emax > emax", + "text": "FailureModeEnum.emax = 101\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmc.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmc", - "title": "cmc > cmc > cmc", - "section": "cmc > cmc", - "text": "property CuntzeCriterion.cmc: bool\n\nActivates the failure evaluation of the matrix due to compression or shear.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.TOP", + "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.TOP.html#top", + "title": "TOP", + "section": "TOP", + "text": "TOP" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isalpha", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isalpha.html#isalpha", - "title": "isalpha", - "section": "isalpha", - "text": "Return True if the string is an alphabetic string, False otherwise.\nA string is alphabetic if all characters in the string are alphabetic and there\nis at least one character in the string.\nisalpha" + "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.TOP", + "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.TOP.html#ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.TOP", + "title": "TOP > TOP > TOP", + "section": "TOP > TOP", + "text": "SpotReductionStrategy.TOP = 'TOP'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isalpha", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isalpha.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isalpha", - "title": "isalpha > isalpha > isalpha", - "section": "isalpha > isalpha", - "text": "FailureMeasureEnum.isalpha(/)\n\nReturn True if the string is an alphabetic string, False otherwise.\n\nA string is alphabetic if all characters in the string are alphabetic and there\nis at least one character in the string.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.get_composite_files_from_workbench_result_folder", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.get_composite_files_from_workbench_result_folder.html#get_composite_files_from_workbench_result_folder", + "title": "get_composite_files_from_workbench_result_folder", + "section": "get_composite_files_from_workbench_result_folder", + "text": "Get a ContinuousFiberCompositesFiles object from a result folder.\nThis function assumes a typical Workbench folder structure for a composite\nsimulation. If this method is not able to build the ContinuousFiberCompositesFiles\nobject, you can follow these steps:\nIn the main Workbench window, activate the files panel by selecting\nView > Files. This shows the location of all files used in the\nworkbench project. You can determine the different attributes of the\nContinuousFiberCompositesFiles object:\nrst: A list of files containing either the single file.rst\nfile that belongs to the cell ID of the solution, or the distributed\nfile0.rst to fileN.rst files.\nengineering_data: The MatML.xml file in the same folder as the RST file.\ncomposite: There can be multiple composite definitions,\none definition for each ACP system if shell data is transferred\nand one definition for each solid model if solid data is transferred.\nAll the ACPCompositeDefinitions.h5 and ACPSolidModel*.h5\nfiles that are used in the solution must be added to the\nContinuousFiberCompositesFiles.composite dictionary.\nThe key can be chosen freely. Next to the ACPCompositeDefinitions.h5\nand ACPSolidModel\\*.h5 files, corresponding ACPCompositeDefinitions.mapping\nand ACPSolidModel*.mapping files can be found (optional).\nIf they exist, they must be added as well.\nThe following example shows how a\nContinuousFiberCompositesFiles object can be built.\nThe project in this example has two ACP Pre systems, one that exports\nshell information and one that exports solid information.\nThe files are located in these locations:\nResult file:\nproject_root_folder/dp0/SYS/MECH/file.rst\nEngineering data file:\nproject_root_folder/dp0/SYS/MECH/MatML.xml\nComposite definition and mapping files for the solid model:\nproject_root_folder/dp0/ACP-Pre-1/ACPSolidModel_SM.h5\nproject_root_folder/dp0/ACP-Pre-1/ACPSolidModel_SM.mapping\nComposite definition and mapping files for the shell model:\nproject_root_folder/dp0/ACP-Pre-2/ACPCompositeDefinitions.h5\nproject_root_folder/dp0/ACP-Pre-2/ACPCompositeDefinitions.mapping\nThe code creates the corresponding ContinuousFiberCompositesFiles object:\nresult_folder (Union[str, PathLike[str]]) – Result folder of the solution. Right-click the solution item in the Ansys Mechanical tree\nand select Open Solver Files Directory to obtain the result folder.\nensure_composite_definitions_found (bool, default: True) – Whether to check if at least one composite definition (shell or solid) has been found.\nContinuousFiberCompositesFiles\nget_composite_files_from_workbench_result_folder\nContinuousFiberCompositesFiles\nContinuousFiberCompositesFiles\nContinuousFiberCompositesFiles\nrst\nfile.rst\nfile0.rst\nfileN.rst\nengineering_data\nMatML.xml\ncomposite\nACPCompositeDefinitions.h5\nACPSolidModel*.h5\nContinuousFiberCompositesFiles.composite\nACPCompositeDefinitions.h5\nACPSolidModel\\*.h5\nACPCompositeDefinitions.mapping\nACPSolidModel*.mapping\nContinuousFiberCompositesFiles\nproject_root_folder/dp0/SYS/MECH/file.rst\nproject_root_folder/dp0/SYS/MECH/MatML.xml\nproject_root_folder/dp0/ACP-Pre-1/ACPSolidModel_SM.h5\nproject_root_folder/dp0/ACP-Pre-1/ACPSolidModel_SM.mapping\nproject_root_folder/dp0/ACP-Pre-2/ACPCompositeDefinitions.h5\nproject_root_folder/dp0/ACP-Pre-2/ACPCompositeDefinitions.mapping\nContinuousFiberCompositesFiles\nUnion\nstr\nPathLike\nstr\nbool\nTrue\nContinuousFiberCompositesFiles" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isdecimal", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isdecimal.html#isdecimal", - "title": "isdecimal", - "section": "isdecimal", - "text": "Return True if the string is a decimal string, False otherwise.\nA string is a decimal string if all characters in the string are decimal and\nthere is at least one character in the string.\nisdecimal" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.get_composite_files_from_workbench_result_folder", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.get_composite_files_from_workbench_result_folder.html#ansys.dpf.composites.data_sources.get_composite_files_from_workbench_result_folder", + "title": "get_composite_files_from_workbench_result_folder > get_composite_files_from_workbench_result_folder > get_composite_files_from_workbench_result_folder", + "section": "get_composite_files_from_workbench_result_folder > get_composite_files_from_workbench_result_folder", + "text": "ansys.dpf.composites.data_sources.get_composite_files_from_workbench_result_folder(result_folder, ensure_composite_definitions_found=True)\n\nGet a ContinuousFiberCompositesFiles object from a result folder.\n\nThis function assumes a typical Workbench folder structure for a composite\nsimulation. If this method is not able to build the ContinuousFiberCompositesFiles\nobject, you can follow these steps:\n\nIn the main Workbench window, activate the files panel by selecting\nView > Files. This shows the location of all files used in the\nworkbench project. You can determine the different attributes of the\nContinuousFiberCompositesFiles object:\n\nrst: A list of files containing either the single file.rst\nfile that belongs to the cell ID of the solution, or the distributed\nfile0.rst to fileN.rst files.\n\nengineering_data: The MatML.xml file in the same folder as the RST file.\n\ncomposite: There can be multiple composite definitions,\none definition for each ACP system if shell data is transferred\nand one definition for each solid model if solid data is transferred.\nAll the ACPCompositeDefinitions.h5 and ACPSolidModel*.h5\nfiles that are used in the solution must be added to the\nContinuousFiberCompositesFiles.composite dictionary.\nThe key can be chosen freely. Next to the ACPCompositeDefinitions.h5\nand ACPSolidModel\\*.h5 files, corresponding ACPCompositeDefinitions.mapping\nand ACPSolidModel*.mapping files can be found (optional).\nIf they exist, they must be added as well.\n\nThe following example shows how a\nContinuousFiberCompositesFiles object can be built.\nThe project in this example has two ACP Pre systems, one that exports\nshell information and one that exports solid information.\n\nThe files are located in these locations:\n\nResult file:\n\nproject_root_folder/dp0/SYS/MECH/file.rst\n\nEngineering data file:\n\nproject_root_folder/dp0/SYS/MECH/MatML.xml\n\nComposite definition and mapping files for the solid model:\n\nproject_root_folder/dp0/ACP-Pre-1/ACPSolidModel_SM.h5\n\nproject_root_folder/dp0/ACP-Pre-1/ACPSolidModel_SM.mapping\n\nComposite definition and mapping files for the shell model:\n\nproject_root_folder/dp0/ACP-Pre-2/ACPCompositeDefinitions.h5\n\nproject_root_folder/dp0/ACP-Pre-2/ACPCompositeDefinitions.mapping\n\nThe code creates the corresponding ContinuousFiberCompositesFiles object:\n\nContinuousFiberCompositesFiles(\n rst=[\"project_root_folder/dp0/SYS/MECH/file.rst\"],\n composite={\n \"solid\": CompositeDefinitionFiles(\n definition=\"project_root_folder/dp0/ACP-Pre-1/ACPSolidModel_SM.h5\",\n mapping=\"project_root_folder/dp0/ACP-Pre-1/ACPSolidModel_SM.mapping\"\n ),\n \"shell\": CompositeDefinitionFiles(\n definition=\"project_root_folder/dp0/ACP-Pre-2/ACPCompositeDefinitions.h5\",\n mapping=\"project_root_folder/dp0/ACP-Pre-2/ACPCompositeDefinitions.mapping\"\n )\n },\n engineering_data=\"project_root_folder/dp0/SYS/MECH/MatML.xml\"\n)\n\nParameters\n\nresult_folder (Union[str, PathLike[str]]) – Result folder of the solution. Right-click the solution item in the Ansys Mechanical tree\nand select Open Solver Files Directory to obtain the result folder.\n\nensure_composite_definitions_found (bool, default: True) – Whether to check if at least one composite definition (shell or solid) has been found.\n\nReturn type\n\nContinuousFiberCompositesFiles\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isdecimal", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isdecimal.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isdecimal", - "title": "isdecimal > isdecimal > isdecimal", - "section": "isdecimal > isdecimal", - "text": "FailureMeasureEnum.isdecimal(/)\n\nReturn True if the string is a decimal string, False otherwise.\n\nA string is a decimal string if all characters in the string are decimal and\nthere is at least one character in the string.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.inverse_reserve_factor", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.inverse_reserve_factor.html#inverse_reserve_factor", + "title": "inverse_reserve_factor", + "section": "inverse_reserve_factor", + "text": "inverse_reserve_factor" }, { - "objectID": "intro", - "href": "intro.html#getting-started", - "title": "Getting started", - "section": "Getting started", - "text": "Getting started" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.inverse_reserve_factor", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.inverse_reserve_factor.html#ansys.dpf.composites.sampling_point.FailureResult.inverse_reserve_factor", + "title": "inverse_reserve_factor > inverse_reserve_factor > inverse_reserve_factor", + "section": "inverse_reserve_factor > inverse_reserve_factor", + "text": "FailureResult.inverse_reserve_factor: float\n\n" }, { - "objectID": "intro", - "href": "intro.html#installation", - "title": "Getting started > Installation", - "section": "Installation", - "text": "PyDPF - Composites supports Ansys version 2023 R1 and later. Make sure you have a licensed copy of Ansys installed. See\nCompatibility to understand which ansys-dpf-composites version corresponds to which Ansys version.\nInstall the ansys-dpf-composites package with pip:\nTo install the optional dependencies used in the examples, add the [examples] suffix when installing the package:\nSpecific versions can be installed by specifying the version in the pip command. For example, Ansys 2023 R1 requires ansys-dpf-composites version 0.1.0:\nYou should use a virtual environment,\nbecause it keeps Python packages isolated from your system Python.\nInstallation\nansys-dpf-composites\nansys-dpf-composites\npip\n[examples]" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yc", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yc.html#stress_limits_yc", + "title": "Stress_Limits_Yc", + "section": "Stress_Limits_Yc", + "text": "Stress_Limits_Yc" }, { - "objectID": "intro", - "href": "intro.html#examples", - "title": "Getting started > Examples", - "section": "Examples", - "text": "The examples/index section provides these basic examples for getting started:\nsphx_glr_examples_gallery_examples_001_failure_operator_example.py\nsphx_glr_examples_gallery_examples_002_sampling_point_example.py\nAt the end of each example, there is a button for downloading the example’s Python source code.\nInput files, such as the results file and composite definition, are downloaded from a Git\nrepository when running the example.\nFor larger models, initializing the CompositeModel class can be slow because it\nautomatically creates many different providers that are not needed in all workflows.\nConsider using the Lay-up information classes directly.\nExamples\nCompositeModel" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yc", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yc.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Yc", + "title": "Stress_Limits_Yc > Stress_Limits_Yc > Stress_Limits_Yc", + "section": "Stress_Limits_Yc > Stress_Limits_Yc", + "text": "MaterialProperty.Stress_Limits_Yc: str = 'stress_compressive_y_direction'\n\n" }, { - "objectID": "intro", - "href": "intro.html#start-from-a-local-ansys-workbench-project", - "title": "Getting started > Start from a local Ansys Workbench project", - "section": "Start from a local Ansys Workbench project", - "text": "To get started on a local Ansys Workbench project, first determine the result folder by\nright-clicking the solution object in Ansys Mechanical and selecting Open Solver Files Directory.\nThen call the get_composite_files_from_workbench_result_folder() function with this folder.\nThis code shows how to set up a project from Workbench, create a basic failure plot, and display\ndetailed output for a sampling point:\nStart from a local Ansys Workbench project\nget_composite_files_from_workbench_result_folder()" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.na", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.na.html#na", + "title": "na", + "section": "na", + "text": "na" }, { - "objectID": "intro", - "href": "intro.html#compatibility", - "title": "Getting started > Compatibility", - "section": "Compatibility", - "text": "The following table shows which ansys-dpf-composites version is compatible with which server version (Ansys version). See Get DPF Docker image to get the pre-releases.\nBy default the DPF server is started from the latest Ansys installer. To choose a specific Ansys version or connect to an existing server, use the appropriate arguments for connect_to_or_start_server()\nServer version\nansys.dpf.composites Python module version\n9.0 (Ansys 2025 R1 pre0)\n0.3.0 and later\n8.1 (Ansys 2024 R2 pre1)\n0.3.0 and later\n8.0 (Ansys 2024 R2 pre0)\n0.3.0 and later\n7.0 (Ansys 2024 R1)\n0.3.0 and later\n7.0 (Ansys 2024 R1 pre0)\n0.3.0 and later\n6.2 (Ansys 2023 R2)\n0.2.0 and 0.3\n6.1 (Ansys 2023 R2 pre1)\n0.2.0 and 0.3\n6.0 (Ansys 2023 R2 pre0)\nNot available. The composites plugin is not part of the Ansys 2023 R2 pre0 release.\n5.0 (Ansys 2023 R1)\n0.1.0\nCompatibility\nansys-dpf-composites\nconnect_to_or_start_server()" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.na", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.na.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.na", + "title": "na > na > na", + "section": "na > na", + "text": "FailureModeEnum.na = 9999\n\n" }, { - "objectID": "intro", - "href": "intro.html#getting-the-dpf-server-docker-image", - "title": "Getting started > Getting the DPF server Docker image", - "section": "Getting the DPF server Docker image", - "text": "Follow the steps described in the DPF documentation in the section Run DPF Server in A Docker Container.\nMake sure you also download the composites plugin (e.g ansys_dpf_composites_lin_v2024.1.pre0.zip).\nAfter following the preceding steps, you should have a running DPF Docker container that listens to port 50052.\nGetting the DPF server Docker image\nansys_dpf_composites_lin_v2024.1.pre0.zip" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.name", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.name.html#name", + "title": "name", + "section": "name", + "text": "Custom name.\nstr\nname\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices", - "href": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices.html#get_selected_indices", - "title": "get_selected_indices", - "section": "get_selected_indices", - "text": "Get elementary indices based on element information, layers, nodes, and spots.\nelement_info (ElementInfo) – Lay-up information for the element.\nlayers (Optional[Collection[int]], default: None) – List of selected layers.\nnodes (Optional[Collection[int]], default: None) – List of selected corner nodes.\nspots (Optional[Collection[Spot]], default: None) – List of selected spots.\ndisable_checks (bool, default: False) – Whether to disable checks. Set to True to disable checks.\nDisabling checks results in better performance but potentially\ncryptic error messages or invalid indices.\nArray of selected indices.\nNDArray\nReturns an empty selection if any of the collections is empty.\nThe indices (nodes, layers, and spots) are 0-based. Pay attention to this\nwhen using the “composite::minmax_per_element_operator” or\nevaluate_failure_criteria\nwhere the min/max layer indices\nare 1-based starting with Workbench 2024 R1 (DPF server 7.1).\nget_selected_indices\nElementInfo\nOptional\nCollection\nint\nNone\nOptional\nCollection\nint\nNone\nOptional\nCollection\nSpot\nNone\nbool\nFalse\nTrue\nevaluate_failure_criteria" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.name", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.name.html#ansys.dpf.composites.result_definition.ResultDefinition.name", + "title": "name > name > name", + "section": "name > name", + "text": "property ResultDefinition.name: str\n\nCustom name.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices", - "href": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices.html#ansys.dpf.composites.select_indices.get_selected_indices", - "title": "get_selected_indices > get_selected_indices > get_selected_indices", - "section": "get_selected_indices > get_selected_indices", - "text": "ansys.dpf.composites.select_indices.get_selected_indices(element_info, layers=None, nodes=None, spots=None, disable_checks=False)\n\nGet elementary indices based on element information, layers, nodes, and spots.\n\nParameters\n\nelement_info (ElementInfo) – Lay-up information for the element.\n\nlayers (Optional[Collection[int]], default: None) – List of selected layers.\n\nnodes (Optional[Collection[int]], default: None) – List of selected corner nodes.\n\nspots (Optional[Collection[Spot]], default: None) – List of selected spots.\n\ndisable_checks (bool, default: False) – Whether to disable checks. Set to True to disable checks.\nDisabling checks results in better performance but potentially\ncryptic error messages or invalid indices.\n\nReturns\n\nArray of selected indices.\n\nReturn type\n\nNDArray\n\nNotes\n\nReturns an empty selection if any of the collections is empty.\n\nThe indices (nodes, layers, and spots) are 0-based. Pay attention to this\nwhen using the “composite::minmax_per_element_operator” or\nevaluate_failure_criteria\nwhere the min/max layer indices\nare 1-based starting with Workbench 2024 R1 (DPF server 7.1).\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e3", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e3.html#e3", + "title": "e3", + "section": "e3", + "text": "Activates the failure evaluation regarding the strain in the material 3 direction (out-of-plane).\nbool\ne3\nbool" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e3", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e3.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e3", + "title": "e3 > e3 > e3", + "section": "e3 > e3", + "text": "property MaxStrainCriterion.e3: bool\n\nActivates the failure evaluation regarding the strain in the material 3 direction (out-of-plane).\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.ljust", @@ -4235,1201 +4200,1257 @@ "text": "FailureMeasureEnum.ljust(width, fillchar=' ', /)\n\nReturn a left-justified string of length width.\n\nPadding is done using the specified fill character (default is a space).\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmc.html#wf_pmc", - "title": "wf_pmc", - "section": "wf_pmc", - "text": "Weighting factor of the matrix failure (pmc) mode.\nfloat\nwf_pmc\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.splitlines", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.splitlines.html#splitlines", + "title": "splitlines", + "section": "splitlines", + "text": "Return a list of the lines in the string, breaking at line boundaries.\nLine breaks are not included in the resulting list unless keepends is given and\ntrue.\nsplitlines" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmc.html#ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmc", - "title": "wf_pmc > wf_pmc > wf_pmc", - "section": "wf_pmc > wf_pmc", - "text": "property PuckCriterion.wf_pmc: float\n\nWeighting factor of the matrix failure (pmc) mode.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.splitlines", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.splitlines.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.splitlines", + "title": "splitlines > splitlines > splitlines", + "section": "splitlines > splitlines", + "text": "FailureMeasureEnum.splitlines(/, keepends=False)\n\nReturn a list of the lines in the string, breaking at line boundaries.\n\nLine breaks are not included in the resulting list unless keepends is given and\ntrue.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.ANGLE", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.ANGLE.html#angle", - "title": "ANGLE", - "section": "ANGLE", - "text": "ANGLE" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.p", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.p.html#p", + "title": "p", + "section": "p", + "text": "p" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.ANGLE", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.ANGLE.html#ansys.dpf.composites.layup_info.LayupProperty.ANGLE", - "title": "ANGLE > ANGLE > ANGLE", - "section": "ANGLE > ANGLE", - "text": "LayupProperty.ANGLE = 0\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.p", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.p.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.p", + "title": "p > p > p", + "section": "p > p", + "text": "FailureModeEnum.p = 800\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.named_selection_scope", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.named_selection_scope.html#named_selection_scope", - "title": "named_selection_scope", - "section": "named_selection_scope", - "text": "Assembly files that define the mapping of the labels.\nThis attribute is needed if multiple parts are assembled in Workbench or\nMechanical to map the local element and node labels to the global labels.\nnamed_selection_scope" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s23", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s23.html#s23", + "title": "s23", + "section": "s23", + "text": "Whether to activate the failure evaluation regarding the interlaminar shear stress s23.\nbool\ns23\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.named_selection_scope", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.named_selection_scope.html#ansys.dpf.composites.result_definition.ResultDefinitionScope.named_selection_scope", - "title": "named_selection_scope > named_selection_scope > named_selection_scope", - "section": "named_selection_scope > named_selection_scope", - "text": "ResultDefinitionScope.named_selection_scope: Sequence[str]\n\nAssembly files that define the mapping of the labels.\n\nThis attribute is needed if multiple parts are assembled in Workbench or\nMechanical to map the local element and node labels to the global labels.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s23", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s23.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.s23", + "title": "s23 > s23 > s23", + "section": "s23 > s23", + "text": "property MaxStressCriterion.s23: bool\n\nWhether to activate the failure evaluation regarding the interlaminar shear stress s23.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lft3", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lft3.html#lft3", - "title": "lft3", - "section": "lft3", - "text": "lft3" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_property_for_all_layers", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_property_for_all_layers.html#get_property_for_all_layers", + "title": "get_property_for_all_layers", + "section": "get_property_for_all_layers", + "text": "Get a layer property for an element ID.\nReturns a numpy array with the values of the property for all the layers.\nValues are ordered from bottom to top.\nThis method returns None if the element is not layered.\nlayup_property (LayerProperty) – Lay-up property.\nelement_id (int) – Element ID or label.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nOptional[ndarray[Any, dtype[float64]]]\nget_property_for_all_layers\nNone\nLayerProperty\nint\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nOptional\nndarray\nAny\ndtype\nfloat64" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_property_for_all_layers", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_property_for_all_layers.html#ansys.dpf.composites.composite_model.CompositeModel.get_property_for_all_layers", + "title": "get_property_for_all_layers > get_property_for_all_layers > get_property_for_all_layers", + "section": "get_property_for_all_layers > get_property_for_all_layers", + "text": "CompositeModel.get_property_for_all_layers(layup_property, element_id, composite_definition_label=None)\n\nGet a layer property for an element ID.\n\nReturns a numpy array with the values of the property for all the layers.\nValues are ordered from bottom to top.\n\nThis method returns None if the element is not layered.\n\nParameters\n\nlayup_property (LayerProperty) – Lay-up property.\n\nelement_id (int) – Element ID or label.\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\n\nReturn type\n\nOptional[ndarray[Any, dtype[float64]]]\n\n!! processed by numpydoc !!" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K.html#thermal_conductivity_k", + "title": "Thermal_Conductivity_K", + "section": "Thermal_Conductivity_K", + "text": "Thermal_Conductivity_K" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K", + "title": "Thermal_Conductivity_K > Thermal_Conductivity_K > Thermal_Conductivity_K", + "section": "Thermal_Conductivity_K > Thermal_Conductivity_K", + "text": "MaterialProperty.Thermal_Conductivity_K: str = 'thermal_conductivity_isotropic'\n\n" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cft", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cft.html#cft", + "title": "cft", + "section": "cft", + "text": "cft" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cft", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cft.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.cft", + "title": "cft > cft > cft", + "section": "cft > cft", + "text": "FailureModeEnum.cft = 1001\n\n" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.material_support", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.material_support.html#material_support", + "title": "material_support", + "section": "material_support", + "text": "material_support" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.material_support", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.material_support.html#ansys.dpf.composites.data_sources.CompositeDataSources.material_support", + "title": "material_support > material_support > material_support", + "section": "material_support > material_support", + "text": "CompositeDataSources.material_support: DataSources\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lft3", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lft3.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.lft3", - "title": "lft3 > lft3 > lft3", - "section": "lft3 > lft3", - "text": "FailureModeEnum.lft3 = 901\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc5", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc5.html#lmc5", + "title": "lmc5", + "section": "lmc5", + "text": "lmc5" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR21", - "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR21.html#tensor21", - "title": "TENSOR21", - "section": "TENSOR21", - "text": "TENSOR21" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc5", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc5.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc5", + "title": "lmc5 > lmc5 > lmc5", + "section": "lmc5 > lmc5", + "text": "FailureModeEnum.lmc5 = 906\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR21", - "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR21.html#ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR21", - "title": "TENSOR21 > TENSOR21 > TENSOR21", - "section": "TENSOR21 > TENSOR21", - "text": "Sym3x3TensorComponent.TENSOR21 = 3\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSyz", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSyz.html#esyz", + "title": "eSyz", + "section": "eSyz", + "text": "Global strain limit in material direction 23.\nfloat\neSyz\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_json.html#to_json", - "title": "to_json", - "section": "to_json", - "text": "Return the combined failure criterion as a JSON dictionary.\nstr\nString representation (json.dumps file) that can be used for the result definition\nof the DPF Composites Failure evaluator operator.\nto_json\nstr\njson.dumps" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSyz", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSyz.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSyz", + "title": "eSyz > eSyz > eSyz", + "section": "eSyz > eSyz", + "text": "property MaxStrainCriterion.eSyz: float\n\nGlobal strain limit in material direction 23.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_json.html#ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_json", - "title": "to_json > to_json > to_json", - "section": "to_json > to_json", - "text": "CombinedFailureCriterion.to_json()\n\nReturn the combined failure criterion as a JSON dictionary.\n\nReturn type\n\nstr\n\nReturns\n\nString representation (json.dumps file) that can be used for the result definition\nof the DPF Composites Failure evaluator operator.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cft", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cft.html#cft", + "title": "cft", + "section": "cft", + "text": "Activates the failure evaluation regarding tension in fiber direction.\nbool\ncft\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.mode_interaction_coeff", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.mode_interaction_coeff.html#mode_interaction_coeff", - "title": "mode_interaction_coeff", - "section": "mode_interaction_coeff", - "text": "Mode interaction coefficient. The default is 2.6.\nfloat\nmode_interaction_coeff\n2.6\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cft", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cft.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.cft", + "title": "cft > cft > cft", + "section": "cft > cft", + "text": "property CuntzeCriterion.cft: bool\n\nActivates the failure evaluation regarding tension in fiber direction.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.mode_interaction_coeff", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.mode_interaction_coeff.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.mode_interaction_coeff", - "title": "mode_interaction_coeff > mode_interaction_coeff > mode_interaction_coeff", - "section": "mode_interaction_coeff > mode_interaction_coeff", - "text": "property CuntzeCriterion.mode_interaction_coeff: float\n\nMode interaction coefficient. The default is 2.6.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rfind", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rfind.html#rfind", + "title": "rfind", + "section": "rfind", + "text": "Return the highest index in S where substring sub is found, such that sub is contained within S[start:end].\nOptional arguments start and end are interpreted as in slice notation.\nReturn -1 on failure.\nrfind" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.name", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.name.html#name", - "title": "name", - "section": "name", - "text": "Name of the object.\nstr\nname\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rfind", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rfind.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.rfind", + "title": "rfind > rfind > rfind", + "section": "rfind > rfind", + "text": "FailureMeasureEnum.rfind(sub, [start, [end]], /)\n\nReturn the highest index in S where substring sub is found, such that sub is contained within S[start:end].\n\nOptional arguments start and end are interpreted as in slice notation.\nReturn -1 on failure.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.name", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.name.html#ansys.dpf.composites.sampling_point.SamplingPoint.name", - "title": "name > name > name", - "section": "name > name", - "text": "property SamplingPoint.name: str\n\nName of the object.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Specific_Heat_cp", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Specific_Heat_cp.html#specific_heat_cp", + "title": "Specific_Heat_cp", + "section": "Specific_Heat_cp", + "text": "Specific_Heat_cp" }, { - "objectID": "examples/gallery_examples/006_filter_composite_data_example", - "href": "examples/gallery_examples/006_filter_composite_data_example.html#filter-result-data-by-different-criteria", - "title": "Filter result data by different criteria", - "section": "Filter result data by different criteria", - "text": "This example shows how data filtering can be used for custom postprocessing of\nlayered composites. You can filter strains and stresses by material, layer, or\nanalysis ply. Filtering by analysis ply is implemented on the server side and\nexposed with the get_ply_wise_data() function. In this case, the data is\nfiltered (and reduced) on the server side and only the resulting field is returned\nto the client. This is the recommended way to filter data if possible.\nFor more complex filtering, the data is transferred to the client side and filtered\nusing numpy functionality.\nThe examples show filtering data by layer, spot, and node, as well as material\nor analysis ply ID. To learn more about how layered result data is organized,\nsee select_indices.\nWhen using a Workbench project,\nuse the composite_files_from_workbench_harmonic_analysis()\nmethod to obtain the input files.\nFilter result data by different criteria\nget_ply_wise_data()\ncomposite_files_from_workbench_harmonic_analysis()" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Specific_Heat_cp", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Specific_Heat_cp.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Specific_Heat_cp", + "title": "Specific_Heat_cp > Specific_Heat_cp > Specific_Heat_cp", + "section": "Specific_Heat_cp > Specific_Heat_cp", + "text": "MaterialProperty.Specific_Heat_cp: str = 'specific_heat'\n\n" }, { - "objectID": "examples/gallery_examples/006_filter_composite_data_example", - "href": "examples/gallery_examples/006_filter_composite_data_example.html#set-up-analysis", - "title": "Filter result data by different criteria > Set up analysis", - "section": "Set up analysis", - "text": "Setting up the analysis consists of importing dependencies, connecting to the\nDPF server, and retrieving the example files.\nImport dependencies.\nStart a DPF server and copy the example files into the current working directory.\nSet up analysis" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXt", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXt.html#ext", + "title": "eXt", + "section": "eXt", + "text": "Global tensile strain limit in material direction 1.\nfloat\neXt\nfloat" }, { - "objectID": "examples/gallery_examples/006_filter_composite_data_example", - "href": "examples/gallery_examples/006_filter_composite_data_example.html#set-up-model", - "title": "Filter result data by different criteria > Set up model", - "section": "Set up model", - "text": "Set up the composite model.\nSet up model" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXt", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXt.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXt", + "title": "eXt > eXt > eXt", + "section": "eXt > eXt", + "text": "property MaxStrainCriterion.eXt: float\n\nGlobal tensile strain limit in material direction 1.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/006_filter_composite_data_example", - "href": "examples/gallery_examples/006_filter_composite_data_example.html#get-result-data", - "title": "Filter result data by different criteria > Get result data", - "section": "Get result data", - "text": "Get the stress field. By default, the stress operator returns the stresses in global coordinates.\nTo get the stresses in the material coordinate system, the bool_rotate_to_global\ninput is set to False.\nGet result data\nbool_rotate_to_global\nFalse" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Spot", + "href": "api/_autosummary/ansys.dpf.composites.constants.Spot.html#spot", + "title": "Spot", + "section": "Spot", + "text": "Implements an interface to access the spots of the results of layered elements.\nSpot.BOTTOM\n\nSpot.MIDDLE\n\nSpot.TOP\n\nSpot\nSpot.BOTTOM\nSpot.MIDDLE\nSpot.TOP" }, { - "objectID": "examples/gallery_examples/006_filter_composite_data_example", - "href": "examples/gallery_examples/006_filter_composite_data_example.html#filter-data-by-analysis-ply", - "title": "Filter result data by different criteria > Filter data by analysis ply", - "section": "Filter data by analysis ply", - "text": "List all available analysis plies.\nThe easiest way to filter data by analysis ply is to use the get_ply_wise_data() function.\nThis function supports different reduction strategies such as computing the average,\nmaximum, or minimum over the spot locations.\nIt also supports selecting a specific spot (TOP, MID, BOT) directly.\nThis example selects the maximum value over all spots for each node and then requests\nthe elemental location, which implies averaging over all nodes in an element.\nUsing the get_ply_wise_data() function has the advantage that all the averaging\nand filtering is done on the server side.\nThe results can also be requested in global coordinates. This example gets the stress values in\nthe global coordinate system, selects the top spot of a selected ply, and averages the values\nover neighbouring nodes to get nodal results.\nFilter data by analysis ply\nget_ply_wise_data()\nget_ply_wise_data()" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Spot", + "href": "api/_autosummary/ansys.dpf.composites.constants.Spot.html#ansys.dpf.composites.constants.Spot", + "title": "Spot > Spot > Spot", + "section": "Spot > Spot", + "text": "class ansys.dpf.composites.constants.Spot(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nImplements an interface to access the spots of the results of layered elements.\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nSpot.BOTTOM\n\n\n\nSpot.MIDDLE\n\n\n\nSpot.TOP\n\n\n\n" }, { - "objectID": "examples/gallery_examples/006_filter_composite_data_example", - "href": "examples/gallery_examples/006_filter_composite_data_example.html#generic-client-side-filtering", - "title": "Filter result data by different criteria > Generic client-side filtering", - "section": "Generic client-side filtering", - "text": "This example shows how to filter data by layer, spot, and node using the generic filtering on\nthe client side.\nThis code plots stress values in the material direction for the first node and top spot.\nGet element information for all elements and show the first one as an example.\nGet filtered data\nGeneric client-side filtering" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_json.html#to_json", + "title": "to_json", + "section": "to_json", + "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" }, { - "objectID": "examples/gallery_examples/006_filter_composite_data_example", - "href": "examples/gallery_examples/006_filter_composite_data_example.html#filter-by-material", - "title": "Filter result data by different criteria > Filter by material", - "section": "Filter by material", - "text": "Loop over all elements and get the maximum stress in the material direction\nfor all plies that have a specific UD material.\nFilter by material" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_json.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_json", + "title": "to_json > to_json > to_json", + "section": "to_json > to_json", + "text": "CuntzeCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/006_filter_composite_data_example", - "href": "examples/gallery_examples/006_filter_composite_data_example.html#filter-by-analysis-ply-on-the-client-side", - "title": "Filter result data by different criteria > Filter by analysis ply on the client side", - "section": "Filter by analysis ply on the client side", - "text": "Loop over all elements that contain a given ply and plot the maximum stress value\nin the material direction in this ply.\nTotal running time of the script: (0 minutes 4.682 seconds)\nDownload Jupyter notebook: 006_filter_composite_data_example.ipynb\nDownload Python source code: 006_filter_composite_data_example.py\nDownload zipped: 006_filter_composite_data_example.zip\nGallery generated by Sphinx-Gallery\nFilter by analysis ply on the client side\nDownload Jupyter notebook: 006_filter_composite_data_example.ipynb\nDownload Python source code: 006_filter_composite_data_example.py\nDownload zipped: 006_filter_composite_data_example.zip" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxz", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxz.html#strain_limits_esxz", + "title": "Strain_Limits_eSxz", + "section": "Strain_Limits_eSxz", + "text": "Strain_Limits_eSxz" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.number_of_nodes_per_spot_plane", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.number_of_nodes_per_spot_plane.html#number_of_nodes_per_spot_plane", - "title": "number_of_nodes_per_spot_plane", - "section": "number_of_nodes_per_spot_plane", - "text": "number_of_nodes_per_spot_plane" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxz", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxz.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxz", + "title": "Strain_Limits_eSxz > Strain_Limits_eSxz > Strain_Limits_eSxz", + "section": "Strain_Limits_eSxz > Strain_Limits_eSxz", + "text": "MaterialProperty.Strain_Limits_eSxz: str = 'strain_shear_xz'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.number_of_nodes_per_spot_plane", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.number_of_nodes_per_spot_plane.html#ansys.dpf.composites.layup_info.ElementInfo.number_of_nodes_per_spot_plane", - "title": "number_of_nodes_per_spot_plane > number_of_nodes_per_spot_plane > number_of_nodes_per_spot_plane", - "section": "number_of_nodes_per_spot_plane > number_of_nodes_per_spot_plane", - "text": "ElementInfo.number_of_nodes_per_spot_plane: int\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isidentifier", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isidentifier.html#isidentifier", + "title": "isidentifier", + "section": "isidentifier", + "text": "Return True if the string is a valid Python identifier, False otherwise.\nCall keyword.iskeyword(s) to test whether string s is a reserved identifier,\nsuch as “def” or “class”.\nisidentifier" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.include_ins", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.include_ins.html#include_ins", - "title": "include_ins", - "section": "include_ins", - "text": "Whether to activate the formulation that considers interlaminar normal stresses.\nbool\ninclude_ins\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isidentifier", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isidentifier.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isidentifier", + "title": "isidentifier > isidentifier > isidentifier", + "section": "isidentifier > isidentifier", + "text": "FailureMeasureEnum.isidentifier(/)\n\nReturn True if the string is a valid Python identifier, False otherwise.\n\nCall keyword.iskeyword(s) to test whether string s is a reserved identifier,\nsuch as “def” or “class”.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.include_ins", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.include_ins.html#ansys.dpf.composites.failure_criteria.CoreFailureCriterion.include_ins", - "title": "include_ins > include_ins > include_ins", - "section": "include_ins > include_ins", - "text": "property CoreFailureCriterion.include_ins: bool\n\nWhether to activate the formulation that considers interlaminar normal stresses.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.html#layupmodelcontexttype", + "title": "LayupModelContextType", + "section": "LayupModelContextType", + "text": "Type of the lay-up information.\nLayupModelContextType.NOT_AVAILABLE\n\nLayupModelContextType.ACP\n\nLayupModelContextType.RST\n\nLayupModelContextType.MIXED\n\nLayupModelContextType\nLayupModelContextType.NOT_AVAILABLE\nLayupModelContextType.ACP\nLayupModelContextType.RST\nLayupModelContextType.MIXED" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_2", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_2.html#larc_constants_fracture_toughness_mode_2", - "title": "Larc_Constants_fracture_toughness_mode_2", - "section": "Larc_Constants_fracture_toughness_mode_2", - "text": "Larc_Constants_fracture_toughness_mode_2" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.html#ansys.dpf.composites.layup_info.LayupModelContextType", + "title": "LayupModelContextType > LayupModelContextType > LayupModelContextType", + "section": "LayupModelContextType > LayupModelContextType", + "text": "class ansys.dpf.composites.layup_info.LayupModelContextType(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nType of the lay-up information.\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nLayupModelContextType.NOT_AVAILABLE\n\n\n\nLayupModelContextType.ACP\n\n\n\nLayupModelContextType.RST\n\n\n\nLayupModelContextType.MIXED\n\n\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_2", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_2.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_2", - "title": "Larc_Constants_fracture_toughness_mode_2 > Larc_Constants_fracture_toughness_mode_2 > Larc_Constants_fracture_toughness_mode_2", - "section": "Larc_Constants_fracture_toughness_mode_2 > Larc_Constants_fracture_toughness_mode_2", - "text": "MaterialProperty.Larc_Constants_fracture_toughness_mode_2: str = 'transverse_friction_coefficient_larc_constants'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.M", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.M.html#m", + "title": "M", + "section": "M", + "text": "Specifies the effect of fiber parallel stresses regarding inter-fiber failure. M = [0, 1). The default is 0.5.\nfloat\nM\n0.5\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.engineering_data", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.engineering_data.html#engineering_data", - "title": "engineering_data", - "section": "engineering_data", - "text": "engineering_data" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.M", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.M.html#ansys.dpf.composites.failure_criteria.PuckCriterion.M", + "title": "M > M > M", + "section": "M > M", + "text": "property PuckCriterion.M: float\n\nSpecifies the effect of fiber parallel stresses regarding inter-fiber failure. M = [0, 1). The default is 0.5.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.engineering_data", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.engineering_data.html#ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.engineering_data", - "title": "engineering_data > engineering_data > engineering_data", - "section": "engineering_data > engineering_data", - "text": "ShortFiberCompositesFiles.engineering_data: str | PathLike[str]\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.name.html#name", + "title": "name", + "section": "name", + "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.name.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.name", + "title": "name > name > name", + "section": "name > name", + "text": "property LaRCCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.join", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.join.html#join", - "title": "join", - "section": "join", - "text": "Concatenate any number of strings.\nThe string whose method is called is inserted in between each given string.\nThe result is returned as a new string.\nExample: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’\njoin" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_json.html#to_json", + "title": "to_json", + "section": "to_json", + "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.join", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.join.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.join", - "title": "join > join > join", - "section": "join > join", - "text": "FailureMeasureEnum.join(iterable, /)\n\nConcatenate any number of strings.\n\nThe string whose method is called is inserted in between each given string.\nThe result is returned as a new string.\n\nExample: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_json.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_json", + "title": "to_json > to_json > to_json", + "section": "to_json > to_json", + "text": "MaxStrainCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.axes", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.axes.html#axes", - "title": "axes", - "section": "axes", - "text": "axes" + "objectID": "api/_autosummary/ansys.dpf.composites.server_helpers.connect_to_or_start_server", + "href": "api/_autosummary/ansys.dpf.composites.server_helpers.connect_to_or_start_server.html#connect_to_or_start_server", + "title": "connect_to_or_start_server", + "section": "connect_to_or_start_server", + "text": "Connect to or start a DPF server with the DPF Composites plugin loaded.\nIf a port or IP address is set, this method tries to connect to the server specified\nand the ansys_path parameter is ignored. If no parameters are set, a local server\nfrom the latest available Ansys installation is started.\nport (Optional[int], default: None) – Port that the DPF server is listening on.\nip (Optional[str], default: None) – IP address for the DPF server.\nansys_path (Optional[str], default: None) – Root path for the Ansys installation. For example, C:\\\\Program Files\\\\ANSYS Inc\\\\v232.\nThis parameter is ignored if either the port or IP address is set.\nAny\nDPF server.\nconnect_to_or_start_server\nansys_path\nOptional\nint\nNone\nOptional\nstr\nNone\nOptional\nstr\nNone\nC:\\\\Program Files\\\\ANSYS Inc\\\\v232\nAny" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.axes", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.axes.html#ansys.dpf.composites.sampling_point.SamplingPointFigure.axes", - "title": "axes > axes > axes", - "section": "axes > axes", - "text": "SamplingPointFigure.axes: Any\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.server_helpers.connect_to_or_start_server", + "href": "api/_autosummary/ansys.dpf.composites.server_helpers.connect_to_or_start_server.html#ansys.dpf.composites.server_helpers.connect_to_or_start_server", + "title": "connect_to_or_start_server > connect_to_or_start_server > connect_to_or_start_server", + "section": "connect_to_or_start_server > connect_to_or_start_server", + "text": "ansys.dpf.composites.server_helpers.connect_to_or_start_server(port=None, ip=None, ansys_path=None)\n\nConnect to or start a DPF server with the DPF Composites plugin loaded.\n\nIf a port or IP address is set, this method tries to connect to the server specified\nand the ansys_path parameter is ignored. If no parameters are set, a local server\nfrom the latest available Ansys installation is started.\n\nParameters\n\nport (Optional[int], default: None) – Port that the DPF server is listening on.\n\nip (Optional[str], default: None) – IP address for the DPF server.\n\nansys_path (Optional[str], default: None) – Root path for the Ansys installation. For example, C:\\\\Program Files\\\\ANSYS Inc\\\\v232.\nThis parameter is ignored if either the port or IP address is set.\n\nReturn type\n\nAny\n\nReturns\n\nDPF server.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope", - "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.html#compositescope", - "title": "CompositeScope", - "section": "CompositeScope", - "text": "Provides the composite scope.\nThis class defines which part of the model and solution step are selected.\nelements (collections.abc.Sequence[int] | None) – List of elements.\nplies (collections.abc.Sequence[str] | None) – List of plies.\ntime (float | None) – Time or frequency. You can use the\nCompositeModel.get_result_times_or_frequencies() method\nto list the solution steps.\nnamed_selections (collections.abc.Sequence[str] | None) – List of element sets.\nUse composite_model.get_mesh().available_named_selections to list\nall named selections.\nIf more than one scope (elements, named_selections and plies)\nis set, then the final element scope is the intersection\nof the defined parameters. All elements are selected if no parameter is set.\nCompositeScope.elements\n\nCompositeScope.named_selections\n\nCompositeScope.plies\n\nCompositeScope.time\n\nCompositeScope\nCompositeModel.get_result_times_or_frequencies()\nelements\nnamed_selections\nplies\nCompositeScope.elements\nCompositeScope.named_selections\nCompositeScope.plies\nCompositeScope.time" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.l", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.l.html#l", + "title": "l", + "section": "l", + "text": "l" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope", - "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.html#ansys.dpf.composites.composite_scope.CompositeScope", - "title": "CompositeScope > CompositeScope > CompositeScope", - "section": "CompositeScope > CompositeScope", - "text": "class ansys.dpf.composites.composite_scope.CompositeScope(elements=None, plies=None, time=None, named_selections=None)\n\nProvides the composite scope.\n\nThis class defines which part of the model and solution step are selected.\n\nParameters\n\nelements (collections.abc.Sequence[int] | None) – List of elements.\n\nplies (collections.abc.Sequence[str] | None) – List of plies.\n\ntime (float | None) – Time or frequency. You can use the\nCompositeModel.get_result_times_or_frequencies() method\nto list the solution steps.\n\nnamed_selections (collections.abc.Sequence[str] | None) – List of element sets.\nUse composite_model.get_mesh().available_named_selections to list\nall named selections.\n\nNotes\n\nIf more than one scope (elements, named_selections and plies)\nis set, then the final element scope is the intersection\nof the defined parameters. All elements are selected if no parameter is set.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nCompositeScope.elements\n\n\n\nCompositeScope.named_selections\n\n\n\nCompositeScope.plies\n\n\n\nCompositeScope.time\n\n\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.l", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.l.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.l", + "title": "l > l > l", + "section": "l > l", + "text": "FailureModeEnum.l = 900\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.ANGLES", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.ANGLES.html#angles", - "title": "ANGLES", - "section": "ANGLES", - "text": "ANGLES" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_spots", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_spots.html#n_spots", + "title": "n_spots", + "section": "n_spots", + "text": "n_spots" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.ANGLES", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.ANGLES.html#ansys.dpf.composites.layup_info.LayerProperty.ANGLES", - "title": "ANGLES > ANGLES > ANGLES", - "section": "ANGLES > ANGLES", - "text": "LayerProperty.ANGLES = 1\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_spots", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_spots.html#ansys.dpf.composites.layup_info.ElementInfo.n_spots", + "title": "n_spots > n_spots > n_spots", + "section": "n_spots > n_spots", + "text": "ElementInfo.n_spots: int\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.interface_weakening_factor", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.interface_weakening_factor.html#interface_weakening_factor", - "title": "interface_weakening_factor", - "section": "interface_weakening_factor", - "text": "Multiplicator for the interlaminar strength if failure mode pd is active. The default is 0.8.\nfloat\ninterface_weakening_factor\npd\n0.8\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_effective_strain", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_effective_strain.html#strain_limits_effective_strain", + "title": "Strain_Limits_effective_strain", + "section": "Strain_Limits_effective_strain", + "text": "Strain_Limits_effective_strain" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.interface_weakening_factor", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.interface_weakening_factor.html#ansys.dpf.composites.failure_criteria.PuckCriterion.interface_weakening_factor", - "title": "interface_weakening_factor > interface_weakening_factor > interface_weakening_factor", - "section": "interface_weakening_factor > interface_weakening_factor", - "text": "property PuckCriterion.interface_weakening_factor: float\n\nMultiplicator for the interlaminar strength if failure mode pd is active. The default is 0.8.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_effective_strain", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_effective_strain.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_effective_strain", + "title": "Strain_Limits_effective_strain > Strain_Limits_effective_strain > Strain_Limits_effective_strain", + "section": "Strain_Limits_effective_strain > Strain_Limits_effective_strain", + "text": "MaterialProperty.Strain_Limits_effective_strain: str = 'von_mises'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_property_for_all_layers", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_property_for_all_layers.html#get_property_for_all_layers", - "title": "get_property_for_all_layers", - "section": "get_property_for_all_layers", - "text": "Get a layer property for an element ID.\nReturns a numpy array with the values of the property for all the layers.\nValues are ordered from bottom to top.\nThis method returns None if the element is not layered.\nlayup_property (LayerProperty) – Lay-up property.\nelement_id (int) – Element ID or label.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nOptional[ndarray[Any, dtype[float64]]]\nget_property_for_all_layers\nNone\nLayerProperty\nint\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nOptional\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s23", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s23.html#wf_s23", + "title": "wf_s23", + "section": "wf_s23", + "text": "Weighting factor of the failure mode s23.\nfloat\nwf_s23\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_property_for_all_layers", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_property_for_all_layers.html#ansys.dpf.composites.composite_model.CompositeModel.get_property_for_all_layers", - "title": "get_property_for_all_layers > get_property_for_all_layers > get_property_for_all_layers", - "section": "get_property_for_all_layers > get_property_for_all_layers", - "text": "CompositeModel.get_property_for_all_layers(layup_property, element_id, composite_definition_label=None)\n\nGet a layer property for an element ID.\n\nReturns a numpy array with the values of the property for all the layers.\nValues are ordered from bottom to top.\n\nThis method returns None if the element is not layered.\n\nParameters\n\nlayup_property (LayerProperty) – Lay-up property.\n\nelement_id (int) – Element ID or label.\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\n\nReturn type\n\nOptional[ndarray[Any, dtype[float64]]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s23", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s23.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s23", + "title": "wf_s23 > wf_s23 > wf_s23", + "section": "wf_s23 > wf_s23", + "text": "property MaxStressCriterion.wf_s23: float\n\nWeighting factor of the failure mode s23.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/003_short_fiber_example", - "href": "examples/gallery_examples/003_short_fiber_example.html#failure-analysis-for-short-fiber-composites", - "title": "Failure analysis for short fiber composites", - "section": "Failure analysis for short fiber composites", - "text": "This example shows how to evaluate failures of a short fiber reinforced\npart.\nAs part of the short fiber workflows, you can evaluate and plot Tsai-Hill\ntype orientation tensor-dependent failure criteria. This example shows\nhow to configure the DPF operator short_fiber_failure_criterion_evaluator\nto compute such failure criteria.\nThe model shown in this example consists of a tensile specimen made of\na short glass fiber reinforced thermoplastic injection molded from both sides.\nThe evaluation of failure criteria in short fiber workflows is a\nbeta feature, introduced in Ansys 2021 R2.\nFailure analysis for short fiber composites\nshort_fiber_failure_criterion_evaluator" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_analysis_plies", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_analysis_plies.html#get_analysis_plies", + "title": "get_analysis_plies", + "section": "get_analysis_plies", + "text": "Get analysis ply names.\nThis method returns None if the element is not layered.\nelement_id (int) – Element ID or label.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nThe dictionary only contains the analysis plies in the specified composite\ndefinition.\nOptional[Sequence[str]]\nget_analysis_plies\nNone\nint\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nOptional\nSequence\nstr" }, { - "objectID": "examples/gallery_examples/003_short_fiber_example", - "href": "examples/gallery_examples/003_short_fiber_example.html#set-up-analysis", - "title": "Failure analysis for short fiber composites > Set up analysis", - "section": "Set up analysis", - "text": "Setting up the analysis consists of loading Ansys libraries, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries.\nStart a DPF server and copy the example files into the current working directory.\nThese files are needed:\nMechanical APDL result (RST) file containing the simulation results\nEngineering Data (MATML) file containing the material properties of the composite\nMechanical APDL input file (DS.DAT) containing the fiber orientation tensor data\nSet up analysis" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_analysis_plies", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_analysis_plies.html#ansys.dpf.composites.composite_model.CompositeModel.get_analysis_plies", + "title": "get_analysis_plies > get_analysis_plies > get_analysis_plies", + "section": "get_analysis_plies > get_analysis_plies", + "text": "CompositeModel.get_analysis_plies(element_id, composite_definition_label=None)\n\nGet analysis ply names.\n\nThis method returns None if the element is not layered.\n\nParameters\n\nelement_id (int) – Element ID or label.\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nThe dictionary only contains the analysis plies in the specified composite\ndefinition.\n\nReturn type\n\nOptional[Sequence[str]]\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/003_short_fiber_example", - "href": "examples/gallery_examples/003_short_fiber_example.html#set-up-data-sources", - "title": "Failure analysis for short fiber composites > Set up data sources", - "section": "Set up data sources", - "text": "Set up the data sources.\nSet up data sources" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_thicknesses", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_thicknesses.html#get_layer_thicknesses", + "title": "get_layer_thicknesses", + "section": "get_layer_thicknesses", + "text": "Get thicknesses for all layers. Returns None if element is not layered.\nelement_id (int) – Element Id/Label\nOptional[ndarray[Any, dtype[float64]]]\nget_layer_thicknesses\nint\nOptional\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "examples/gallery_examples/003_short_fiber_example", - "href": "examples/gallery_examples/003_short_fiber_example.html#initialize-dpf-model", - "title": "Failure analysis for short fiber composites > Initialize DPF model", - "section": "Initialize DPF model", - "text": "Initialize the DPF model.\nInitialize DPF model" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_thicknesses", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_thicknesses.html#ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_thicknesses", + "title": "get_layer_thicknesses > get_layer_thicknesses > get_layer_thicknesses", + "section": "get_layer_thicknesses > get_layer_thicknesses", + "text": "LayupPropertiesProvider.get_layer_thicknesses(element_id)\n\nGet thicknesses for all layers. Returns None if element is not layered.\n\nParameters\n\nelement_id (int) – Element Id/Label\n\nReturn type\n\nOptional[ndarray[Any, dtype[float64]]]\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/003_short_fiber_example", - "href": "examples/gallery_examples/003_short_fiber_example.html#plot-results", - "title": "Failure analysis for short fiber composites > Plot results", - "section": "Plot results", - "text": "Plot the two largest eigenvalues (a11 and a22) of the fiber orientation tensor.\nNote that the plots reveal the presence of a weld line in the middle of the specimen.\nPlot results" + "objectID": "examples/gallery_examples/sg_execution_times", + "href": "examples/gallery_examples/sg_execution_times.html#computation-times", + "title": "Computation times", + "section": "Computation times", + "text": "01:22.317 total execution time for 15 files from examples/gallery_examples:\nExample\nTime\nMem (MB)\nsphx_glr_examples_gallery_examples_001_failure_operator_example.py (001_failure_operator_example.py)\n00:12.061\n0.0\nsphx_glr_examples_gallery_examples_010_harmonic_example.py (010_harmonic_example.py)\n00:09.928\n0.0\nsphx_glr_examples_gallery_examples_014_cyclic_symmetry_example.py (014_cyclic_symmetry_example.py)\n00:07.394\n0.0\nsphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py (007_interlaminar_normal_stress_example.py)\n00:07.360\n0.0\nsphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py (009_short_fiber_orientation_tensor.py)\n00:05.827\n0.0\nsphx_glr_examples_gallery_examples_011_rst_workflow.py (011_rst_workflow.py)\n00:05.043\n0.0\nsphx_glr_examples_gallery_examples_002_sampling_point_example.py (002_sampling_point_example.py)\n00:04.888\n0.0\nsphx_glr_examples_gallery_examples_099_dpf_composite_failure_workflow.py (099_dpf_composite_failure_workflow.py)\n00:04.671\n0.0\nsphx_glr_examples_gallery_examples_006_filter_composite_data_example.py (006_filter_composite_data_example.py)\n00:04.636\n0.0\nsphx_glr_examples_gallery_examples_013_thermal_example.py (013_thermal_example.py)\n00:04.181\n0.0\nsphx_glr_examples_gallery_examples_008_assembly_example.py (008_assembly_example.py)\n00:04.148\n0.0\nsphx_glr_examples_gallery_examples_012_fatigue_example.py (012_fatigue_example.py)\n00:03.799\n0.0\nsphx_glr_examples_gallery_examples_004_get_material_properties_example.py (004_get_material_properties_example.py)\n00:03.610\n0.0\nsphx_glr_examples_gallery_examples_003_short_fiber_example.py (003_short_fiber_example.py)\n00:03.287\n0.0\nsphx_glr_examples_gallery_examples_005_get_layup_properties_example.py (005_get_layup_properties_example.py)\n00:01.484\n0.0\nComputation times\n001_failure_operator_example.py\n010_harmonic_example.py\n014_cyclic_symmetry_example.py\n007_interlaminar_normal_stress_example.py\n009_short_fiber_orientation_tensor.py\n011_rst_workflow.py\n002_sampling_point_example.py\n099_dpf_composite_failure_workflow.py\n006_filter_composite_data_example.py\n013_thermal_example.py\n008_assembly_example.py\n012_fatigue_example.py\n004_get_material_properties_example.py\n003_short_fiber_example.py\n005_get_layup_properties_example.py" }, { - "objectID": "examples/gallery_examples/003_short_fiber_example", - "href": "examples/gallery_examples/003_short_fiber_example.html#configure-and-evaluate", - "title": "Failure analysis for short fiber composites > Configure and evaluate", - "section": "Configure and evaluate", - "text": "Configure the short fiber failure criterion evaluator and evaluate.\nNote that you can specify optional time and mesh scoping inputs.\nConfigure and evaluate" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.stress_strain_eval_mode", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.stress_strain_eval_mode.html#stress_strain_eval_mode", + "title": "stress_strain_eval_mode", + "section": "stress_strain_eval_mode", + "text": "Results loaded from a result (RST) file by default.\nYou can set this property to \"mapdl_live\" to activate on-the-fly\nstrain and stress evaluation. This property can be used if the result\nfile contains only the primary results (deformations).\nstr\nstress_strain_eval_mode\n\"mapdl_live\"\nstr" }, { - "objectID": "examples/gallery_examples/003_short_fiber_example", - "href": "examples/gallery_examples/003_short_fiber_example.html#compute-and-plot-results", - "title": "Failure analysis for short fiber composites > Compute and plot results", - "section": "Compute and plot results", - "text": "Compute and plot the maximum failure value per element.\nTotal running time of the script: (0 minutes 3.262 seconds)\nDownload Jupyter notebook: 003_short_fiber_example.ipynb\nDownload Python source code: 003_short_fiber_example.py\nDownload zipped: 003_short_fiber_example.zip\nGallery generated by Sphinx-Gallery\nCompute and plot results\nDownload Jupyter notebook: 003_short_fiber_example.ipynb\nDownload Python source code: 003_short_fiber_example.py\nDownload zipped: 003_short_fiber_example.zip" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.stress_strain_eval_mode", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.stress_strain_eval_mode.html#ansys.dpf.composites.result_definition.ResultDefinition.stress_strain_eval_mode", + "title": "stress_strain_eval_mode > stress_strain_eval_mode > stress_strain_eval_mode", + "section": "stress_strain_eval_mode > stress_strain_eval_mode", + "text": "property ResultDefinition.stress_strain_eval_mode: str\n\nResults loaded from a result (RST) file by default.\n\nYou can set this property to \"mapdl_live\" to activate on-the-fly\nstrain and stress evaluation. This property can be used if the result\nfile contains only the primary results (deformations).\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_json.html#to_json", - "title": "to_json", - "section": "to_json", - "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.composite", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.composite.html#composite", + "title": "composite", + "section": "composite", + "text": "composite" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_json.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_json", - "title": "to_json > to_json > to_json", - "section": "to_json > to_json", - "text": "VonMisesCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.composite", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.composite.html#ansys.dpf.composites.data_sources.CompositeDataSources.composite", + "title": "composite > composite > composite", + "section": "composite > composite", + "text": "CompositeDataSources.composite: DataSources | None\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.dpf_material_ids", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.dpf_material_ids.html#dpf_material_ids", - "title": "dpf_material_ids", - "section": "dpf_material_ids", - "text": "dpf_material_ids" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hd", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hd.html#hd", + "title": "hd", + "section": "hd", + "text": "hd" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.dpf_material_ids", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.dpf_material_ids.html#ansys.dpf.composites.layup_info.ElementInfo.dpf_material_ids", - "title": "dpf_material_ids > dpf_material_ids > dpf_material_ids", - "section": "dpf_material_ids > dpf_material_ids", - "text": "ElementInfo.dpf_material_ids: ndarray[Any, dtype[int64]]\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hd", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hd.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.hd", + "title": "hd > hd > hd", + "section": "hd > hd", + "text": "FailureModeEnum.hd = 603\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1.html#s1", - "title": "s1", - "section": "s1", - "text": "s1" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE", + "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE.html#failure_mode", + "title": "FAILURE_MODE", + "section": "FAILURE_MODE", + "text": "FAILURE_MODE" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s1", - "title": "s1 > s1 > s1", - "section": "s1 > s1", - "text": "FailureModeEnum.s1 = 210\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE", + "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE.html#ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE", + "title": "FAILURE_MODE > FAILURE_MODE > FAILURE_MODE", + "section": "FAILURE_MODE > FAILURE_MODE", + "text": "FailureOutput.FAILURE_MODE = 0\n\n" }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s3", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s3.html#s3", - "title": "s3", - "section": "s3", - "text": "Whether to activate the failure evaluation regarding the stress in the material 3 direction (out-of-plane).\nbool\ns3\nbool" + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pf.html#wf_pf", + "title": "wf_pf", + "section": "wf_pf", + "text": "Weighting factor of the fiber failure (pf) mode.\nfloat\nwf_pf\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s3", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s3.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.s3", - "title": "s3 > s3 > s3", - "section": "s3 > s3", - "text": "property MaxStressCriterion.s3: bool\n\nWhether to activate the failure evaluation regarding the stress in the material 3 direction (out-of-plane).\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pf.html#ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pf", + "title": "wf_pf > wf_pf > wf_pf", + "section": "wf_pf > wf_pf", + "text": "property PuckCriterion.wf_pf: float\n\nWeighting factor of the fiber failure (pf) mode.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.failure_modes", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.failure_modes.html#failure_modes", - "title": "failure_modes", - "section": "failure_modes", - "text": "Critical failure mode of each ply.\nSequence[str]\nfailure_modes\nSequence\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.get_composites_data_sources", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.get_composites_data_sources.html#get_composites_data_sources", + "title": "get_composites_data_sources", + "section": "get_composites_data_sources", + "text": "Create DPF data sources from a ContinuousFiberCompositeFiles object.\ncontinuous_composite_files (ContinuousFiberCompositesFiles)\nCompositeDataSources\nget_composites_data_sources\nContinuousFiberCompositeFiles\nContinuousFiberCompositesFiles\nCompositeDataSources" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.failure_modes", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.failure_modes.html#ansys.dpf.composites.sampling_point.SamplingPoint.failure_modes", - "title": "failure_modes > failure_modes > failure_modes", - "section": "failure_modes > failure_modes", - "text": "property SamplingPoint.failure_modes: Sequence[str]\n\nCritical failure mode of each ply.\n\nReturn type\n\nSequence[str]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.get_composites_data_sources", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.get_composites_data_sources.html#ansys.dpf.composites.data_sources.get_composites_data_sources", + "title": "get_composites_data_sources > get_composites_data_sources > get_composites_data_sources", + "section": "get_composites_data_sources > get_composites_data_sources", + "text": "ansys.dpf.composites.data_sources.get_composites_data_sources(continuous_composite_files)\n\nCreate DPF data sources from a ContinuousFiberCompositeFiles object.\n\nParameters\n\ncontinuous_composite_files (ContinuousFiberCompositesFiles)\n\nReturn type\n\nCompositeDataSources\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.expandtabs", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.expandtabs.html#expandtabs", - "title": "expandtabs", - "section": "expandtabs", - "text": "Return a copy where all tab characters are expanded using spaces.\nIf tabsize is not given, a tab size of 8 characters is assumed.\nexpandtabs" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.html#vonmisescriterion", + "title": "VonMisesCriterion", + "section": "VonMisesCriterion", + "text": "Defines the von Mises criterion for isotropic materials.\nvme (bool, default: True) – Whether to activate the von Mises strain criterion.\nvms (bool, default: True) – Whether to activate the von Mises stress criterion.\nwf_vme (float, default: 1.0) – Weighting factor of the strain criterion (vme).\nwf_vms (float, default: 1.0) – Weighting factor of the stress criterion (vms).\neval_ins (bool, default: False) – Whether to consider interlaminar normal stresses (s3) and compute them for layered shells.\nVonMisesCriterion.to_dict()\n\nVonMisesCriterion.to_json()\n\nVonMisesCriterion.active\nThe failure criterion is suppressed if active is False.\nVonMisesCriterion.eval_ins\nWhether to consider interlaminar normal stresses (s3) and compute them for layered shells.\nVonMisesCriterion.name\nName of the failure criterion.\nVonMisesCriterion.vme\nWhether to activate the von Mises strain criterion.\nVonMisesCriterion.vms\nWhether to activate the von Mises stress criterion.\nVonMisesCriterion.wf_vme\nWeighting factor of the strain criterion (vme).\nVonMisesCriterion.wf_vms\nWeighting factor of the stress criterion (vms).\nVonMisesCriterion\nbool\nTrue\nbool\nTrue\nfloat\n1.0\nfloat\n1.0\nbool\nFalse\nVonMisesCriterion.to_dict\nVonMisesCriterion.to_json\nVonMisesCriterion.active\nVonMisesCriterion.eval_ins\nVonMisesCriterion.name\nVonMisesCriterion.vme\nVonMisesCriterion.vms\nVonMisesCriterion.wf_vme\nVonMisesCriterion.wf_vms" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.expandtabs", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.expandtabs.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.expandtabs", - "title": "expandtabs > expandtabs > expandtabs", - "section": "expandtabs > expandtabs", - "text": "FailureMeasureEnum.expandtabs(/, tabsize=8)\n\nReturn a copy where all tab characters are expanded using spaces.\n\nIf tabsize is not given, a tab size of 8 characters is assumed.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion", + "title": "VonMisesCriterion > VonMisesCriterion > VonMisesCriterion", + "section": "VonMisesCriterion > VonMisesCriterion", + "text": "class ansys.dpf.composites.failure_criteria.VonMisesCriterion(*, vme=True, vms=True, wf_vme=1.0, wf_vms=1.0, eval_ins=False)\n\nDefines the von Mises criterion for isotropic materials.\n\nParameters\n\nvme (bool, default: True) – Whether to activate the von Mises strain criterion.\n\nvms (bool, default: True) – Whether to activate the von Mises stress criterion.\n\nwf_vme (float, default: 1.0) – Weighting factor of the strain criterion (vme).\n\nwf_vms (float, default: 1.0) – Weighting factor of the stress criterion (vms).\n\neval_ins (bool, default: False) – Whether to consider interlaminar normal stresses (s3) and compute them for layered shells.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nVonMisesCriterion.to_dict()\n\n\n\nVonMisesCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nVonMisesCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nVonMisesCriterion.eval_ins\n\nWhether to consider interlaminar normal stresses (s3) and compute them for layered shells.\n\nVonMisesCriterion.name\n\nName of the failure criterion.\n\nVonMisesCriterion.vme\n\nWhether to activate the von Mises strain criterion.\n\nVonMisesCriterion.vms\n\nWhether to activate the von Mises stress criterion.\n\nVonMisesCriterion.wf_vme\n\nWeighting factor of the strain criterion (vme).\n\nVonMisesCriterion.wf_vms\n\nWeighting factor of the stress criterion (vms).\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.is_layered", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.is_layered.html#is_layered", - "title": "is_layered", - "section": "is_layered", - "text": "is_layered" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.material_name", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.material_name.html#material_name", + "title": "material_name", + "section": "material_name", + "text": "material_name" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.is_layered", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.is_layered.html#ansys.dpf.composites.layup_info.ElementInfo.is_layered", - "title": "is_layered > is_layered > is_layered", - "section": "is_layered > is_layered", - "text": "ElementInfo.is_layered: bool\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.material_name", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.material_name.html#ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.material_name", + "title": "material_name > material_name > material_name", + "section": "material_name > material_name", + "text": "MaterialMetadata.material_name: str = ''\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.split", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.split.html#split", - "title": "split", - "section": "split", - "text": "Return a list of the substrings in the string, using sep as the separator string.\nThe separator used to split the string.\nWhen set to None (the default value), will split on any whitespace\ncharacter (including n r t f and spaces) and will discard\nempty strings from the result.\nMaximum number of splits.\n-1 (the default value) means no limit.\nSplitting starts at the front of the string and works to the end.\nNote, str.split() is mainly useful for data that has been intentionally\ndelimited. With natural text that includes punctuation, consider using\nthe regular expression module.\nsplit" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.THICKNESS", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.THICKNESS.html#thickness", + "title": "THICKNESS", + "section": "THICKNESS", + "text": "THICKNESS" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.split", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.split.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.split", - "title": "split > split > split", - "section": "split > split", - "text": "FailureMeasureEnum.split(/, sep=None, maxsplit=-1)\n\nReturn a list of the substrings in the string, using sep as the separator string.\n\nsep\n\nThe separator used to split the string.\n\nWhen set to None (the default value), will split on any whitespace\ncharacter (including n r t f and spaces) and will discard\nempty strings from the result.\n\nmaxsplit\n\nMaximum number of splits.\n-1 (the default value) means no limit.\n\nSplitting starts at the front of the string and works to the end.\n\nNote, str.split() is mainly useful for data that has been intentionally\ndelimited. With natural text that includes punctuation, consider using\nthe regular expression module.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.THICKNESS", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.THICKNESS.html#ansys.dpf.composites.layup_info.LayupProperty.THICKNESS", + "title": "THICKNESS > THICKNESS > THICKNESS", + "section": "THICKNESS > THICKNESS", + "text": "LayupProperty.THICKNESS = 2\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isupper", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isupper.html#isupper", - "title": "isupper", - "section": "isupper", - "text": "Return True if the string is an uppercase string, False otherwise.\nA string is uppercase if all cased characters in the string are uppercase and\nthere is at least one cased character in the string.\nisupper" + "objectID": "api/sampling_point", + "href": "api/sampling_point.html#sampling-point", + "title": "Sampling point", + "section": "Sampling point", + "text": "SamplingPoint(*args, **kwargs)\nImplements the Sampling Point object that wraps the DPF sampling point operator.\nSamplingPointFigure(figure, axes)\nProvides the sampling point figure and axes.\nFailureResult(mode, inverse_reserve_factor, ...)\nProvides the components of a failure result.\nSampling point\nSamplingPoint\nSampling Point\nSamplingPointFigure\nFailureResult" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isupper", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isupper.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isupper", - "title": "isupper > isupper > isupper", - "section": "isupper > isupper", - "text": "FailureMeasureEnum.isupper(/)\n\nReturn True if the string is an uppercase string, False otherwise.\n\nA string is uppercase if all cased characters in the string are uppercase and\nthere is at least one cased character in the string.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu.html#engineering_constants_nu", + "title": "Engineering_Constants_nu", + "section": "Engineering_Constants_nu", + "text": "Engineering_Constants_nu" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lfc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lfc.html#wf_lfc", - "title": "wf_lfc", - "section": "wf_lfc", - "text": "Weighting factor of fiber failure due to compression (lfc).\nfloat\nwf_lfc\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu", + "title": "Engineering_Constants_nu > Engineering_Constants_nu > Engineering_Constants_nu", + "section": "Engineering_Constants_nu > Engineering_Constants_nu", + "text": "MaterialProperty.Engineering_Constants_nu: str = 'poisson_ratio'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lfc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lfc.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lfc", - "title": "wf_lfc > wf_lfc > wf_lfc", - "section": "wf_lfc > wf_lfc", - "text": "property LaRCCriterion.wf_lfc: float\n\nWeighting factor of fiber failure due to compression (lfc).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_result_plots", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_result_plots.html#get_result_plots", + "title": "get_result_plots", + "section": "get_result_plots", + "text": "Generate a figure with a grid of axes (plot) for each selected result entity.\nstrain_components (Sequence[str], default: ('e1', 'e2', 'e3', 'e12', 'e13', 'e23')) – Strain entities of interest. Supported values are \"e1\", \"e2\",\n\"e3\", \"e12\", \"e13\", and \"e23\". The plot is skipped\nif the list is empty.\nstress_components (Sequence[str], default: ('s1', 's2', 's3', 's12', 's13', 's23')) – Stress entities of interest. Supported values are \"s1\", \"s2\",\n\"s3\", \"s12\", \"s13\", and \"s23\". The plot is skipped\nif the list is empty.\nfailure_components (Sequence[FailureMeasureEnum], default: (, , )) – Failure values of interest. Values supported are \"irf\", \"rf\",\nand \"mos\". The plot is skipped if the list is empty.\nshow_failure_modes (bool, default: False) – WHether to add the critical failure mode to the failure plot.\ncreate_laminate_plot (bool, default: True) – Whether to plot the stacking sequence of the laminate, including text information\nsuch as material, thickness, and angle.\ncore_scale_factor (float, default: 1.0) – Factor for scaling the thickness of core plies.\nspots (Collection[Spot], default: (, , )) – Spots (interfaces) to show results at.\nSamplingPointFigure\nget_result_plots\nSequence\nstr\n('e1', 'e2', 'e3', 'e12', 'e13', 'e23')\n\"e1\"\n\"e2\"\n\"e3\"\n\"e12\"\n\"e13\"\n\"e23\"\nSequence\nstr\n('s1', 's2', 's3', 's12', 's13', 's23')\n\"s1\"\n\"s2\"\n\"s3\"\n\"s12\"\n\"s13\"\n\"s23\"\nSequence\nFailureMeasureEnum\n(, , )\n\"irf\"\n\"rf\"\n\"mos\"\nbool\nFalse\nbool\nTrue\nfloat\n1.0\nCollection\nSpot\n(, , )\nSamplingPointFigure" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_dict.html#to_dict", - "title": "to_dict", - "section": "to_dict", - "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_result_plots", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_result_plots.html#ansys.dpf.composites.sampling_point.SamplingPoint.get_result_plots", + "title": "get_result_plots > get_result_plots > get_result_plots", + "section": "get_result_plots > get_result_plots", + "text": "SamplingPoint.get_result_plots(strain_components=('e1', 'e2', 'e3', 'e12', 'e13', 'e23'), stress_components=('s1', 's2', 's3', 's12', 's13', 's23'), failure_components=(FailureMeasureEnum.INVERSE_RESERVE_FACTOR, FailureMeasureEnum.RESERVE_FACTOR, FailureMeasureEnum.MARGIN_OF_SAFETY), show_failure_modes=False, create_laminate_plot=True, core_scale_factor=1.0, spots=(Spot.BOTTOM, Spot.MIDDLE, Spot.TOP))\n\nGenerate a figure with a grid of axes (plot) for each selected result entity.\n\nParameters\n\nstrain_components (Sequence[str], default: ('e1', 'e2', 'e3', 'e12', 'e13', 'e23')) – Strain entities of interest. Supported values are \"e1\", \"e2\",\n\"e3\", \"e12\", \"e13\", and \"e23\". The plot is skipped\nif the list is empty.\n\nstress_components (Sequence[str], default: ('s1', 's2', 's3', 's12', 's13', 's23')) – Stress entities of interest. Supported values are \"s1\", \"s2\",\n\"s3\", \"s12\", \"s13\", and \"s23\". The plot is skipped\nif the list is empty.\n\nfailure_components (Sequence[FailureMeasureEnum], default: (, , )) – Failure values of interest. Values supported are \"irf\", \"rf\",\nand \"mos\". The plot is skipped if the list is empty.\n\nshow_failure_modes (bool, default: False) – WHether to add the critical failure mode to the failure plot.\n\ncreate_laminate_plot (bool, default: True) – Whether to plot the stacking sequence of the laminate, including text information\nsuch as material, thickness, and angle.\n\ncore_scale_factor (float, default: 1.0) – Factor for scaling the thickness of core plies.\n\nspots (Collection[Spot], default: (, , )) – Spots (interfaces) to show results at.\n\nExamples\n\n>>> figure, axes = sampling_point.get_result_plots()\n\nReturn type\n\nSamplingPointFigure\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_dict", - "title": "to_dict > to_dict > to_dict", - "section": "to_dict > to_dict", - "text": "CuntzeCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxy", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxy.html#stress_limits_sxy", + "title": "Stress_Limits_Sxy", + "section": "Stress_Limits_Sxy", + "text": "Stress_Limits_Sxy" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e23", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e23.html#e23", - "title": "e23", - "section": "e23", - "text": "Whether to activate the failure evaluation regarding the interlaminar shear strain e23.\nbool\ne23\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxy", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxy.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxy", + "title": "Stress_Limits_Sxy > Stress_Limits_Sxy > Stress_Limits_Sxy", + "section": "Stress_Limits_Sxy > Stress_Limits_Sxy", + "text": "MaterialProperty.Stress_Limits_Sxy: str = 'stress_shear_xy'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e23", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e23.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e23", - "title": "e23 > e23 > e23", - "section": "e23 > e23", - "text": "property MaxStrainCriterion.e23: bool\n\nWhether to activate the failure evaluation regarding the interlaminar shear strain e23.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.html#compositemodel", + "title": "CompositeModel", + "section": "CompositeModel", + "text": "Provides access to the basic composite postprocessing functionality.\nOn initialization, the CompositeModel class automatically adds composite lay-up\ninformation to the meshed regions. It prepares the providers for different lay-up properties\nso that they can be efficiently evaluated. The composite_files provided are automatically\nuploaded to the server if needed.\nWhen creating a CompositeModel instance, several providers are created and\nlay-up information is added to the DPF meshed regions. Depending on the use\ncase, it can be more efficient to create the providers separately.\nThe handling of models with multiple composite definition files (assemblies)\ndiffer depending on the version of the DPF server. The handling is simplified\nwith DPF Server 7.0 (2024 R1) or later and the full assembly can be post-processed\nin the same way as a model with a single ACP model.\nBefore DPF Server 7.0 (2024 R1):\nFor assemblies with multiple composite definition files, separate meshes and\nlay-up operators are generated (wrapped by the CompositeInfo class). This\nis needed because the lay-up provider can only add the data of a single\ncomposite definitions file to a mesh. All functions that depend on composite\ndefinitions mut be called with the correct composite_definition_label\nparameter. The layered elements that get information from a given\ncomposite definition label can be determined by calling\nCompositeModel.get_all_layered_element_ids_for_composite_definition_label().\nAll the elements that are not part of a composite definition are either homogeneous\nsolids or layered models defined outside of an ACP model. The\nCompositeModel.composite_definition_labels() command returns all available composite\ndefinition labels. For more information, see\nsphx_glr_examples_gallery_examples_008_assembly_example.py.\ncomposite_files (ContinuousFiberCompositesFiles) – Use the get_composite_files_from_workbench_result_folder() function to obtain\nthe ContinuousFiberCompositesFiles object.\nserver (BaseServer) – DPF Server on which the model is created\ndefault_unit_system (Optional[UnitSystem], default: None) – Unit system that is used if the result file\ndoes not specify the unit system. This happens\nfor pure MAPDL projects.\nCompositeModel.add_interlaminar_normal_stresses(...)\nAdd interlaminar normal stresses to the stresses fields container.\nCompositeModel.evaluate_failure_criteria(...)\nGet a fields container with the evaluated failure criteria.\nCompositeModel.get_all_layered_element_ids()\nGet all element IDs with lay-up data.\nCompositeModel.get_all_layered_element_ids_for_composite_definition_label([...])\nGet all layered element IDs that belong to a composite definition label.\nCompositeModel.get_analysis_plies(element_id)\nGet analysis ply names.\nCompositeModel.get_constant_property_dict(...)\nGet a dictionary with constant properties.\nCompositeModel.get_element_info(element_id)\nGet element information for an element ID.\nCompositeModel.get_element_laminate_offset(...)\nGet the laminate offset of an element.\nCompositeModel.get_layup_operator([...])\nGet the lay-up operator.\nCompositeModel.get_mesh([...])\nGet the underlying DPF meshed region.\nCompositeModel.get_property_for_all_layers(...)\nGet a layer property for an element ID.\nCompositeModel.get_result_times_or_frequencies()\nGet the times or frequencies in the result file.\nCompositeModel.get_rst_streams_provider()\nGet the streams provider of the loaded result file.\nCompositeModel.get_sampling_point(...[, ...])\nGet a sampling point for an element ID and failure criteria.\nCompositeModel.composite_definition_labels\nAll composite definition labels in the model.\nCompositeModel.composite_files\nGet the composite file paths on the server.\nCompositeModel.core_model\nUnderlying DPF core model.\nCompositeModel.data_sources\nComposite data sources.\nCompositeModel.layup_model_type\nGet the context type of the lay-up model.\nCompositeModel.material_metadata\nDPF material ID to metadata map of the materials.\nCompositeModel.material_names\nMaterial name to DPF material ID map.\nCompositeModel.material_operators\nMaterial operators.\nCompositeModel\nCompositeModel\nCompositeModel\nCompositeInfo\ncomposite_definition_label\nCompositeModel.get_all_layered_element_ids_for_composite_definition_label()\nCompositeModel.composite_definition_labels()\nContinuousFiberCompositesFiles\nget_composite_files_from_workbench_result_folder()\nContinuousFiberCompositesFiles\nBaseServer\nOptional\nUnitSystem\nNone\nCompositeModel.add_interlaminar_normal_stresses\nCompositeModel.evaluate_failure_criteria\nCompositeModel.get_all_layered_element_ids\nCompositeModel.get_all_layered_element_ids_for_composite_definition_label\nCompositeModel.get_analysis_plies\nCompositeModel.get_constant_property_dict\nCompositeModel.get_element_info\nCompositeModel.get_element_laminate_offset\nCompositeModel.get_layup_operator\nCompositeModel.get_mesh\nCompositeModel.get_property_for_all_layers\nCompositeModel.get_result_times_or_frequencies\nCompositeModel.get_rst_streams_provider\nCompositeModel.get_sampling_point\nCompositeModel.composite_definition_labels\nCompositeModel.composite_files\nCompositeModel.core_model\nCompositeModel.data_sources\nCompositeModel.layup_model_type\nCompositeModel.material_metadata\nCompositeModel.material_names\nCompositeModel.material_operators" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xy", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xy.html#tsai_wu_constant_xy", - "title": "Tsai_Wu_Constant_xy", - "section": "Tsai_Wu_Constant_xy", - "text": "Tsai_Wu_Constant_xy" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.html#ansys.dpf.composites.composite_model.CompositeModel", + "title": "CompositeModel > CompositeModel > CompositeModel", + "section": "CompositeModel > CompositeModel", + "text": "class ansys.dpf.composites.composite_model.CompositeModel(composite_files, server, default_unit_system=None)\n\nProvides access to the basic composite postprocessing functionality.\n\nOn initialization, the CompositeModel class automatically adds composite lay-up\ninformation to the meshed regions. It prepares the providers for different lay-up properties\nso that they can be efficiently evaluated. The composite_files provided are automatically\nuploaded to the server if needed.\n\nWhen creating a CompositeModel instance, several providers are created and\nlay-up information is added to the DPF meshed regions. Depending on the use\ncase, it can be more efficient to create the providers separately.\n\nThe handling of models with multiple composite definition files (assemblies)\ndiffer depending on the version of the DPF server. The handling is simplified\nwith DPF Server 7.0 (2024 R1) or later and the full assembly can be post-processed\nin the same way as a model with a single ACP model.\n\nBefore DPF Server 7.0 (2024 R1):\n\nFor assemblies with multiple composite definition files, separate meshes and\nlay-up operators are generated (wrapped by the CompositeInfo class). This\nis needed because the lay-up provider can only add the data of a single\ncomposite definitions file to a mesh. All functions that depend on composite\ndefinitions mut be called with the correct composite_definition_label\nparameter. The layered elements that get information from a given\ncomposite definition label can be determined by calling\nCompositeModel.get_all_layered_element_ids_for_composite_definition_label().\nAll the elements that are not part of a composite definition are either homogeneous\nsolids or layered models defined outside of an ACP model. The\nCompositeModel.composite_definition_labels() command returns all available composite\ndefinition labels. For more information, see\nsphx_glr_examples_gallery_examples_008_assembly_example.py.\n\nParameters\n\ncomposite_files (ContinuousFiberCompositesFiles) – Use the get_composite_files_from_workbench_result_folder() function to obtain\nthe ContinuousFiberCompositesFiles object.\n\nserver (BaseServer) – DPF Server on which the model is created\n\ndefault_unit_system (Optional[UnitSystem], default: None) – Unit system that is used if the result file\ndoes not specify the unit system. This happens\nfor pure MAPDL projects.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nCompositeModel.add_interlaminar_normal_stresses(...)\n\nAdd interlaminar normal stresses to the stresses fields container.\n\nCompositeModel.evaluate_failure_criteria(...)\n\nGet a fields container with the evaluated failure criteria.\n\nCompositeModel.get_all_layered_element_ids()\n\nGet all element IDs with lay-up data.\n\nCompositeModel.get_all_layered_element_ids_for_composite_definition_label([...])\n\nGet all layered element IDs that belong to a composite definition label.\n\nCompositeModel.get_analysis_plies(element_id)\n\nGet analysis ply names.\n\nCompositeModel.get_constant_property_dict(...)\n\nGet a dictionary with constant properties.\n\nCompositeModel.get_element_info(element_id)\n\nGet element information for an element ID.\n\nCompositeModel.get_element_laminate_offset(...)\n\nGet the laminate offset of an element.\n\nCompositeModel.get_layup_operator([...])\n\nGet the lay-up operator.\n\nCompositeModel.get_mesh([...])\n\nGet the underlying DPF meshed region.\n\nCompositeModel.get_property_for_all_layers(...)\n\nGet a layer property for an element ID.\n\nCompositeModel.get_result_times_or_frequencies()\n\nGet the times or frequencies in the result file.\n\nCompositeModel.get_rst_streams_provider()\n\nGet the streams provider of the loaded result file.\n\nCompositeModel.get_sampling_point(...[, ...])\n\nGet a sampling point for an element ID and failure criteria.\n\n\n\nAttributes\n\n\n\n\n\n\n\nCompositeModel.composite_definition_labels\n\nAll composite definition labels in the model.\n\nCompositeModel.composite_files\n\nGet the composite file paths on the server.\n\nCompositeModel.core_model\n\nUnderlying DPF core model.\n\nCompositeModel.data_sources\n\nComposite data sources.\n\nCompositeModel.layup_model_type\n\nGet the context type of the lay-up model.\n\nCompositeModel.material_metadata\n\nDPF material ID to metadata map of the materials.\n\nCompositeModel.material_names\n\nMaterial name to DPF material ID map.\n\nCompositeModel.material_operators\n\nMaterial operators.\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xy", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xy.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xy", - "title": "Tsai_Wu_Constant_xy > Tsai_Wu_Constant_xy > Tsai_Wu_Constant_xy", - "section": "Tsai_Wu_Constant_xy > Tsai_Wu_Constant_xy", - "text": "MaterialProperty.Tsai_Wu_Constant_xy: str = 'coupling_coef_xy_tsai_wu'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s12", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s12.html#wf_s12", + "title": "wf_s12", + "section": "wf_s12", + "text": "Weighting factor of the failure mode s12.\nfloat\nwf_s12\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E1", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E1.html#polar_properties_e1", - "title": "polar_properties_E1", - "section": "polar_properties_E1", - "text": "Polar property E1 of the laminate.\nndarray[Any, dtype[float64]]\npolar_properties_E1\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s12", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s12.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s12", + "title": "wf_s12 > wf_s12 > wf_s12", + "section": "wf_s12 > wf_s12", + "text": "property MaxStressCriterion.wf_s12: float\n\nWeighting factor of the failure mode s12.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E1", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E1.html#ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E1", - "title": "polar_properties_E1 > polar_properties_E1 > polar_properties_E1", - "section": "polar_properties_E1 > polar_properties_E1", - "text": "property SamplingPoint.polar_properties_E1: ndarray[Any, dtype[float64]]\n\nPolar property E1 of the laminate.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pmc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pmc.html#pmc", + "title": "pmc", + "section": "pmc", + "text": "Whether to activate the failure evaluation regarding matrix failure due to shear failure.\nbool\npmc\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.element_scope", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.element_scope.html#element_scope", - "title": "element_scope", - "section": "element_scope", - "text": "element_scope" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pmc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pmc.html#ansys.dpf.composites.failure_criteria.PuckCriterion.pmc", + "title": "pmc > pmc > pmc", + "section": "pmc > pmc", + "text": "property PuckCriterion.pmc: bool\n\nWhether to activate the failure evaluation regarding matrix failure due to shear failure.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.element_scope", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.element_scope.html#ansys.dpf.composites.result_definition.ResultDefinitionScope.element_scope", - "title": "element_scope > element_scope > element_scope", - "section": "element_scope > element_scope", - "text": "ResultDefinitionScope.element_scope: Sequence[int]\n\n" + "objectID": "examples/gallery_examples/010_harmonic_example", + "href": "examples/gallery_examples/010_harmonic_example.html#postprocess-a-harmonic-analysis", + "title": "Postprocess a harmonic analysis", + "section": "Postprocess a harmonic analysis", + "text": "This example shows how to evaluate failure criteria for a harmonic simulation.\nIt shows how to create a phase sweep to compute the maximum IRF in the frequency-phase\nspace and shows how to identify the critical failure mode and the critical layer.\nWhen using a Workbench project,\nuse the composite_files_from_workbench_harmonic_analysis()\nmethod to obtain the input files.\nPostprocess a harmonic analysis\ncomposite_files_from_workbench_harmonic_analysis()" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.to_dict.html#to_dict", - "title": "to_dict", - "section": "to_dict", - "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" + "objectID": "examples/gallery_examples/010_harmonic_example", + "href": "examples/gallery_examples/010_harmonic_example.html#set-up-analysis", + "title": "Postprocess a harmonic analysis > Set up analysis", + "section": "Set up analysis", + "text": "Setting up the analysis consists of loading the required modules, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries and matplotlib\nStart a DPF server and copy the example files into the current working directory.\nCreate a composite model\nDefine a failure criterion\nSet up analysis" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.to_dict", - "title": "to_dict > to_dict > to_dict", - "section": "to_dict > to_dict", - "text": "LaRCCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/010_harmonic_example", + "href": "examples/gallery_examples/010_harmonic_example.html#obtain-stresses-and-strains-and-compute-max-irf-over-all-phases-and-frequencies", + "title": "Postprocess a harmonic analysis > Obtain stresses and strains and compute max IRF over all phases and frequencies", + "section": "Obtain stresses and strains and compute max IRF over all phases and frequencies", + "text": "Get complex stresses and strains at all frequencies\nGet operators that provide material data\nDefine the frequency sweep. This is relatively coarse so the example does not take\ntoo much time.\nInitialize result containers. We create a result container for the failure value,\nthe failure mode and the layer index in which the failure occurs.\nLoop over all the phases and evaluate the failure criterion.\nThe result is added to the field containers declared in the previous cell.\nIn the end each container contains a field for each combination of frequency\nand phase\nCompute maximum over all the phases and frequencies for each element and plot the resulting\nIRF values\nObtain stresses and strains and compute max IRF over all phases and frequencies" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSyz", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSyz.html#esyz", - "title": "eSyz", - "section": "eSyz", - "text": "Global strain limit in material direction 23.\nfloat\neSyz\nfloat" + "objectID": "examples/gallery_examples/010_harmonic_example", + "href": "examples/gallery_examples/010_harmonic_example.html#detailed-analysis-of-the-critical-element", + "title": "Postprocess a harmonic analysis > Detailed analysis of the critical element", + "section": "Detailed analysis of the critical element", + "text": "Identify the element with the maximum IRF\nScope container with all frequencies and phases to critical element so we can plot\nthe critical IRF over all the frequencies\nCompute the maximum IRF over all the phases for each frequency and plot the result for\nthe critical element. Note: this can be different from maximum overall IRF\nat each frequency, because we look only at the element that has the highest IRF overall.\nCompute the critical phase\nCompute critical layer and critical failure mode.\nTotal running time of the script: (0 minutes 9.928 seconds)\nDownload Jupyter notebook: 010_harmonic_example.ipynb\nDownload Python source code: 010_harmonic_example.py\nDownload zipped: 010_harmonic_example.zip\nGallery generated by Sphinx-Gallery\nDetailed analysis of the critical element\nDownload Jupyter notebook: 010_harmonic_example.ipynb\nDownload Python source code: 010_harmonic_example.py\nDownload zipped: 010_harmonic_example.zip" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSyz", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSyz.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSyz", - "title": "eSyz > eSyz > eSyz", - "section": "eSyz > eSyz", - "text": "property MaxStrainCriterion.eSyz: float\n\nGlobal strain limit in material direction 23.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.html#resultdefinition", + "title": "ResultDefinition", + "section": "ResultDefinition", + "text": "Represents the result definition of DPF Composites.\nThis class is used to configure the DPF operators composite::failure_evaluator\nand composite::sampling_point_evaluator.\nResultDefinition.check_has_single_scope(msg)\nCheck that the result definition has one scope.\nResultDefinition.to_dict()\nGet the result definition in a dictionary representation.\nResultDefinition.to_json()\nConvert the dictionary representation of the result definition to a JSON dictionary.\nResultDefinition.combined_failure_criterion\nConfiguration of the failure criteria such as maximum stress, puck, and wrinkling.\nResultDefinition.expression\nType of the result.\nResultDefinition.material_file\nPath of the material files that store the material properties.\nResultDefinition.max_chunk_size\nMaximum chunk size (number of elements) for the result evaluation.\nResultDefinition.measure\nReturn type of the failure values.\nResultDefinition.name\nCustom name.\nResultDefinition.rst_files\nPath of the result (RST) files.\nResultDefinition.scopes\nScopes of the result definition.\nResultDefinition.stress_strain_eval_mode\nResults loaded from a result (RST) file by default.\nResultDefinition.time\nTime or solution step.\nResultDefinition\ncomposite::failure_evaluator\ncomposite::sampling_point_evaluator\nResultDefinition.check_has_single_scope\nResultDefinition.to_dict\nResultDefinition.to_json\nResultDefinition.combined_failure_criterion\nResultDefinition.expression\nResultDefinition.material_file\nResultDefinition.max_chunk_size\nResultDefinition.measure\nResultDefinition.name\nResultDefinition.rst_files\nResultDefinition.scopes\nResultDefinition.stress_strain_eval_mode\nResultDefinition.time" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.dim", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.dim.html#dim", - "title": "dim", - "section": "dim", - "text": "Whether the 2D or 3D formulation of the criterion is used. The latter one also supports the failure mode delamination.\nint\ndim\nint" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.html#ansys.dpf.composites.result_definition.ResultDefinition", + "title": "ResultDefinition > ResultDefinition > ResultDefinition", + "section": "ResultDefinition > ResultDefinition", + "text": "class ansys.dpf.composites.result_definition.ResultDefinition(name, combined_failure_criterion, composite_scopes, rst_files, material_file, measure='inverse_reserve_factor', stress_strain_eval_mode='rst_file', time=None, expression='composite_failure', max_chunk_size=50000)\n\nRepresents the result definition of DPF Composites.\n\nThis class is used to configure the DPF operators composite::failure_evaluator\nand composite::sampling_point_evaluator.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nResultDefinition.check_has_single_scope(msg)\n\nCheck that the result definition has one scope.\n\nResultDefinition.to_dict()\n\nGet the result definition in a dictionary representation.\n\nResultDefinition.to_json()\n\nConvert the dictionary representation of the result definition to a JSON dictionary.\n\n\n\nAttributes\n\n\n\n\n\n\n\nResultDefinition.combined_failure_criterion\n\nConfiguration of the failure criteria such as maximum stress, puck, and wrinkling.\n\nResultDefinition.expression\n\nType of the result.\n\nResultDefinition.material_file\n\nPath of the material files that store the material properties.\n\nResultDefinition.max_chunk_size\n\nMaximum chunk size (number of elements) for the result evaluation.\n\nResultDefinition.measure\n\nReturn type of the failure values.\n\nResultDefinition.name\n\nCustom name.\n\nResultDefinition.rst_files\n\nPath of the result (RST) files.\n\nResultDefinition.scopes\n\nScopes of the result definition.\n\nResultDefinition.stress_strain_eval_mode\n\nResults loaded from a result (RST) file by default.\n\nResultDefinition.time\n\nTime or solution step.\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.dim", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.dim.html#ansys.dpf.composites.failure_criteria.HashinCriterion.dim", - "title": "dim > dim > dim", - "section": "dim > dim", - "text": "property HashinCriterion.dim: int\n\nWhether the 2D or 3D formulation of the criterion is used. The latter one also supports the failure mode delamination.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s1", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s1.html#s1", + "title": "s1", + "section": "s1", + "text": "Whether to activate the failure evaluation regarding the stress in the material 1 direction.\nbool\ns1\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s2", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s2.html#wf_s2", - "title": "wf_s2", - "section": "wf_s2", - "text": "Weighting factor of the failure mode s2.\nfloat\nwf_s2\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s1", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s1.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.s1", + "title": "s1 > s1 > s1", + "section": "s1 > s1", + "text": "property MaxStressCriterion.s1: bool\n\nWhether to activate the failure evaluation regarding the stress in the material 1 direction.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s2", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s2.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s2", - "title": "wf_s2 > wf_s2 > wf_s2", - "section": "wf_s2 > wf_s2", - "text": "property MaxStressCriterion.wf_s2: float\n\nWeighting factor of the failure mode s2.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isnumeric", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isnumeric.html#isnumeric", + "title": "isnumeric", + "section": "isnumeric", + "text": "Return True if the string is a numeric string, False otherwise.\nA string is numeric if all characters in the string are numeric and there is at\nleast one character in the string.\nisnumeric" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu13", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu13.html#engineering_constants_nu13", - "title": "Engineering_Constants_nu13", - "section": "Engineering_Constants_nu13", - "text": "Engineering_Constants_nu13" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isnumeric", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isnumeric.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isnumeric", + "title": "isnumeric > isnumeric > isnumeric", + "section": "isnumeric > isnumeric", + "text": "FailureMeasureEnum.isnumeric(/)\n\nReturn True if the string is a numeric string, False otherwise.\n\nA string is numeric if all characters in the string are numeric and there is at\nleast one character in the string.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu13", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu13.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu13", - "title": "Engineering_Constants_nu13 > Engineering_Constants_nu13 > Engineering_Constants_nu13", - "section": "Engineering_Constants_nu13 > Engineering_Constants_nu13", - "text": "MaterialProperty.Engineering_Constants_nu13: str = 'poisson_ratio_xz'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.max_chunk_size", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.max_chunk_size.html#max_chunk_size", + "title": "max_chunk_size", + "section": "max_chunk_size", + "text": "Maximum chunk size (number of elements) for the result evaluation.\nSmall chunks reduce the maximum peak of memory, but too many chunks causes\nsome overhead. The default is 50,000. Use -1 to disable chunking.\nint\nmax_chunk_size\n-1\nint" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.removeprefix", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.removeprefix.html#removeprefix", - "title": "removeprefix", - "section": "removeprefix", - "text": "Return a str with the given prefix string removed if present.\nIf the string starts with the prefix string, return string[len(prefix):].\nOtherwise, return a copy of the original string.\nremoveprefix" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.max_chunk_size", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.max_chunk_size.html#ansys.dpf.composites.result_definition.ResultDefinition.max_chunk_size", + "title": "max_chunk_size > max_chunk_size > max_chunk_size", + "section": "max_chunk_size > max_chunk_size", + "text": "property ResultDefinition.max_chunk_size: int\n\nMaximum chunk size (number of elements) for the result evaluation.\n\nSmall chunks reduce the maximum peak of memory, but too many chunks causes\nsome overhead. The default is 50,000. Use -1 to disable chunking.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.removeprefix", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.removeprefix.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.removeprefix", - "title": "removeprefix > removeprefix > removeprefix", - "section": "removeprefix > removeprefix", - "text": "FailureMeasureEnum.removeprefix(prefix, /)\n\nReturn a str with the given prefix string removed if present.\n\nIf the string starts with the prefix string, return string[len(prefix):].\nOtherwise, return a copy of the original string.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_dict.html#to_dict", + "title": "to_dict", + "section": "to_dict", + "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" }, { - "objectID": "examples/gallery_examples/011_rst_workflow", - "href": "examples/gallery_examples/011_rst_workflow.html#failure-analysis-of-an-mapdl-rst-model", - "title": "Failure analysis of an MAPDL (RST) model", - "section": "Failure analysis of an MAPDL (RST) model", - "text": "This example shows the postprocessing of an MAPDL (RST) model with layered elements that was not\npreprocessed by ACP. The difference between the RST-only and ACP-based workflow is that\nthe section data are loaded from the RST file instead of the ACP layup file.\nThis happens automatically if the parameter composite of the\nContinuousFiberCompositesFiles class is not set.\nThe engineering data file (XML or ENGD) with the material properties is needed anyway.\nOtherwise, the material properties cannot be mapped.\nAt the end of this example, two workflows are shown on how to create\nthe engineering data file based on a MAPDL model and how to set the\nmaterial UUIDs in MAPDL.\nThe material UUIDs in the engineering data file must be identical\nto the UUIDs in Mechanical APDL (RST file).\nThe postprocessing of MAPDL models is supported in 2024 R2 (DPF Server version 8.0)\nand later. A few advanced features are not supported with the RST only workflow.\nFor more information, see limitations.\nWhen using a Workbench project,\nuse the composite_files_from_workbench_harmonic_analysis()\nmethod to obtain the input files.\nFailure analysis of an MAPDL (RST) model\nContinuousFiberCompositesFiles\ncomposite_files_from_workbench_harmonic_analysis()" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_dict", + "title": "to_dict > to_dict > to_dict", + "section": "to_dict > to_dict", + "text": "HoffmanCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/011_rst_workflow", - "href": "examples/gallery_examples/011_rst_workflow.html#set-up-analysis", - "title": "Failure analysis of an MAPDL (RST) model > Set up analysis", - "section": "Set up analysis", - "text": "Setting up the analysis consists of loading Ansys libraries, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries.\nStart a DPF server and copy the example files into the current working directory.\nGet input files (RST and material.engd but skip the ACP layup file).\nSet up analysis" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isdecimal", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isdecimal.html#isdecimal", + "title": "isdecimal", + "section": "isdecimal", + "text": "Return True if the string is a decimal string, False otherwise.\nA string is a decimal string if all characters in the string are decimal and\nthere is at least one character in the string.\nisdecimal" }, { - "objectID": "examples/gallery_examples/011_rst_workflow", - "href": "examples/gallery_examples/011_rst_workflow.html#configure-combined-failure-criterion", - "title": "Failure analysis of an MAPDL (RST) model > Configure combined failure criterion", - "section": "Configure combined failure criterion", - "text": "Configure the combined failure criterion.\nConfigure combined failure criterion" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isdecimal", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isdecimal.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isdecimal", + "title": "isdecimal > isdecimal > isdecimal", + "section": "isdecimal > isdecimal", + "text": "FailureMeasureEnum.isdecimal(/)\n\nReturn True if the string is a decimal string, False otherwise.\n\nA string is a decimal string if all characters in the string are decimal and\nthere is at least one character in the string.\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/011_rst_workflow", - "href": "examples/gallery_examples/011_rst_workflow.html#set-up-model-and-evaluate-failures", - "title": "Failure analysis of an MAPDL (RST) model > Set up model and evaluate failures", - "section": "Set up model and evaluate failures", - "text": "Set up the composite model.\nEvaluate failures for the entire model\nSet up model and evaluate failures" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR31", + "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR31.html#tensor31", + "title": "TENSOR31", + "section": "TENSOR31", + "text": "TENSOR31" }, { - "objectID": "examples/gallery_examples/011_rst_workflow", - "href": "examples/gallery_examples/011_rst_workflow.html#create-and-plot-a-sampling-point", - "title": "Failure analysis of an MAPDL (RST) model > Create and plot a sampling point", - "section": "Create and plot a sampling point", - "text": "Create and plot a sampling point" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR31", + "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR31.html#ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR31", + "title": "TENSOR31 > TENSOR31 > TENSOR31", + "section": "TENSOR31 > TENSOR31", + "text": "Sym3x3TensorComponent.TENSOR31 = 5\n\n" }, { - "objectID": "examples/gallery_examples/011_rst_workflow", - "href": "examples/gallery_examples/011_rst_workflow.html#create-engineering-data-file-and-set-material-uuids-in-mapdl", - "title": "Failure analysis of an MAPDL (RST) model > Create Engineering Data file and set material UUIDs in MAPDL", - "section": "Create Engineering Data file and set material UUIDs in MAPDL", - "text": "Here are two workflows for setting up the engineering data file\nand the material UUIDs in MAPDL. The material UUIDs must be set\nin MAPDL before the model is solved.\nCreate an External Model system in WB and load the solver input file\nLink the External Model with an Engineering Data system and update it\nSave the project and copy the generated engineering data file (EngineeringData.xml)\nFor each material, look for the DataTransferID, go to MAPDL and set the material\nUUIDs with the MP,UVID,, command\nStart ACP, go to File - Import Model and load the solver input file (CDB)\nGo to the Materials folder and export the engineering data file (Ansys Workbench XML)\nFor each material, look for the DataTransferID, go to MAPDL and set the material\nUUID with the MP,UVID,, command.\nTotal running time of the script: (0 minutes 5.110 seconds)\nDownload Jupyter notebook: 011_rst_workflow.ipynb\nDownload Python source code: 011_rst_workflow.py\nDownload zipped: 011_rst_workflow.zip\nGallery generated by Sphinx-Gallery\nCreate Engineering Data file and set material UUIDs in MAPDL\nDataTransferID\nMP,UVID,,\nDataTransferID\nMP,UVID,,\nDownload Jupyter notebook: 011_rst_workflow.ipynb\nDownload Python source code: 011_rst_workflow.py\nDownload zipped: 011_rst_workflow.zip" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.SHEAR_ANGLE", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.SHEAR_ANGLE.html#shear_angle", + "title": "SHEAR_ANGLE", + "section": "SHEAR_ANGLE", + "text": "SHEAR_ANGLE" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.name.html#name", - "title": "name", - "section": "name", - "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.SHEAR_ANGLE", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.SHEAR_ANGLE.html#ansys.dpf.composites.layup_info.LayupProperty.SHEAR_ANGLE", + "title": "SHEAR_ANGLE > SHEAR_ANGLE > SHEAR_ANGLE", + "section": "SHEAR_ANGLE > SHEAR_ANGLE", + "text": "LayupProperty.SHEAR_ANGLE = 1\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.name.html#ansys.dpf.composites.failure_criteria.TsaiHillCriterion.name", - "title": "name > name > name", - "section": "name > name", - "text": "property TsaiHillCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_polar_plot", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_polar_plot.html#get_polar_plot", + "title": "get_polar_plot", + "section": "get_polar_plot", + "text": "Create a standard polar plot to visualize the polar properties of the laminate.\ncomponents (Sequence[str], default: ('E1', 'E2', 'G12')) – Stiffness quantities to plot.\nSamplingPointFigure\nget_polar_plot\nSequence\nstr\n('E1', 'E2', 'G12')\nSamplingPointFigure" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.check_has_single_scope", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.check_has_single_scope.html#check_has_single_scope", - "title": "check_has_single_scope", - "section": "check_has_single_scope", - "text": "Check that the result definition has one scope.\nNone\ncheck_has_single_scope\nNone" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_polar_plot", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_polar_plot.html#ansys.dpf.composites.sampling_point.SamplingPoint.get_polar_plot", + "title": "get_polar_plot > get_polar_plot > get_polar_plot", + "section": "get_polar_plot > get_polar_plot", + "text": "SamplingPoint.get_polar_plot(components=('E1', 'E2', 'G12'))\n\nCreate a standard polar plot to visualize the polar properties of the laminate.\n\nParameters\n\ncomponents (Sequence[str], default: ('E1', 'E2', 'G12')) – Stiffness quantities to plot.\n\nExamples\n\n>>> figure, axes = sampling_point.get_polar_plot(components=[\"E1\", \"G12\"])\n\nReturn type\n\nSamplingPointFigure\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.check_has_single_scope", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.check_has_single_scope.html#ansys.dpf.composites.result_definition.ResultDefinition.check_has_single_scope", - "title": "check_has_single_scope > check_has_single_scope > check_has_single_scope", - "section": "check_has_single_scope > check_has_single_scope", - "text": "ResultDefinition.check_has_single_scope(msg)\n\nCheck that the result definition has one scope.\n\nReturn type\n\nNone\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Spot.MIDDLE", + "href": "api/_autosummary/ansys.dpf.composites.constants.Spot.MIDDLE.html#middle", + "title": "MIDDLE", + "section": "MIDDLE", + "text": "MIDDLE" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xz", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xz.html#tsai_wu_constant_xz", - "title": "Tsai_Wu_Constant_xz", - "section": "Tsai_Wu_Constant_xz", - "text": "Tsai_Wu_Constant_xz" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Spot.MIDDLE", + "href": "api/_autosummary/ansys.dpf.composites.constants.Spot.MIDDLE.html#ansys.dpf.composites.constants.Spot.MIDDLE", + "title": "MIDDLE > MIDDLE > MIDDLE", + "section": "MIDDLE > MIDDLE", + "text": "Spot.MIDDLE = 2\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xz", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xz.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_xz", - "title": "Tsai_Wu_Constant_xz > Tsai_Wu_Constant_xz > Tsai_Wu_Constant_xz", - "section": "Tsai_Wu_Constant_xz > Tsai_Wu_Constant_xz", - "text": "MaterialProperty.Tsai_Wu_Constant_xz: str = 'coupling_coef_xz_tsai_wu'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids.html#get_all_layered_element_ids", + "title": "get_all_layered_element_ids", + "section": "get_all_layered_element_ids", + "text": "Get all element IDs with lay-up data.\nSequence[int]\nget_all_layered_element_ids\nSequence\nint" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.INVERSE_RESERVE_FACTOR", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.INVERSE_RESERVE_FACTOR.html#inverse_reserve_factor", - "title": "INVERSE_RESERVE_FACTOR", - "section": "INVERSE_RESERVE_FACTOR", - "text": "INVERSE_RESERVE_FACTOR" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids.html#ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids", + "title": "get_all_layered_element_ids > get_all_layered_element_ids > get_all_layered_element_ids", + "section": "get_all_layered_element_ids > get_all_layered_element_ids", + "text": "CompositeModel.get_all_layered_element_ids()\n\nGet all element IDs with lay-up data.\n\nReturn type\n\nSequence[int]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.INVERSE_RESERVE_FACTOR", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.INVERSE_RESERVE_FACTOR.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.INVERSE_RESERVE_FACTOR", - "title": "INVERSE_RESERVE_FACTOR > INVERSE_RESERVE_FACTOR > INVERSE_RESERVE_FACTOR", - "section": "INVERSE_RESERVE_FACTOR > INVERSE_RESERVE_FACTOR", - "text": "FailureMeasureEnum.INVERSE_RESERVE_FACTOR: str = 'inverse_reserve_factor'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rpartition", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rpartition.html#rpartition", + "title": "rpartition", + "section": "rpartition", + "text": "Partition the string into three parts using the given separator.\nThis will search for the separator in the string, starting at the end. If\nthe separator is found, returns a 3-tuple containing the part before the\nseparator, the separator itself, and the part after it.\nIf the separator is not found, returns a 3-tuple containing two empty strings\nand the original string.\nrpartition" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ap", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ap.html#ap", - "title": "ap", - "section": "ap", - "text": "ap" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rpartition", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rpartition.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.rpartition", + "title": "rpartition > rpartition > rpartition", + "section": "rpartition > rpartition", + "text": "FailureMeasureEnum.rpartition(sep, /)\n\nPartition the string into three parts using the given separator.\n\nThis will search for the separator in the string, starting at the end. If\nthe separator is found, returns a 3-tuple containing the part before the\nseparator, the separator itself, and the part after it.\n\nIf the separator is not found, returns a 3-tuple containing two empty strings\nand the original string.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ap", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ap.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.ap", - "title": "ap > ap > ap", - "section": "ap > ap", - "text": "FailureModeEnum.ap = 1202\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.write_data_for_full_element_scope", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.write_data_for_full_element_scope.html#write_data_for_full_element_scope", + "title": "write_data_for_full_element_scope", + "section": "write_data_for_full_element_scope", + "text": "Whether to write the data for all element labels in the element scope.\nThis makes sense if an element scope is explicitly requested\nbut the actual scope where postprocessing has happened is smaller,\nperhaps due to ply scoping.\nwrite_data_for_full_element_scope" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_layers", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_layers.html#n_layers", - "title": "n_layers", - "section": "n_layers", - "text": "n_layers" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.write_data_for_full_element_scope", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.write_data_for_full_element_scope.html#ansys.dpf.composites.result_definition.ResultDefinitionScope.write_data_for_full_element_scope", + "title": "write_data_for_full_element_scope > write_data_for_full_element_scope > write_data_for_full_element_scope", + "section": "write_data_for_full_element_scope > write_data_for_full_element_scope", + "text": "ResultDefinitionScope.write_data_for_full_element_scope: bool = True\n\nWhether to write the data for all element labels in the element scope.\n\nThis makes sense if an element scope is explicitly requested\nbut the actual scope where postprocessing has happened is smaller,\nperhaps due to ply scoping.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_layers", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_layers.html#ansys.dpf.composites.layup_info.ElementInfo.n_layers", - "title": "n_layers > n_layers > n_layers", - "section": "n_layers > n_layers", - "text": "ElementInfo.n_layers: int\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.is_shell", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.is_shell.html#is_shell", + "title": "is_shell", + "section": "is_shell", + "text": "is_shell" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.vMe", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.vMe.html#vme", - "title": "vMe", - "section": "vMe", - "text": "vMe" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.is_shell", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.is_shell.html#ansys.dpf.composites.layup_info.ElementInfo.is_shell", + "title": "is_shell > is_shell > is_shell", + "section": "is_shell > is_shell", + "text": "ElementInfo.is_shell: bool\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.vMe", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.vMe.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.vMe", - "title": "vMe > vMe > vMe", - "section": "vMe > vMe", - "text": "FailureModeEnum.vMe = 1101\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_interface_weakening_factor", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_interface_weakening_factor.html#puck_constants_interface_weakening_factor", + "title": "Puck_Constants_interface_weakening_factor", + "section": "Puck_Constants_interface_weakening_factor", + "text": "Puck_Constants_interface_weakening_factor" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZc", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZc.html#strain_limits_ezc", - "title": "Strain_Limits_eZc", - "section": "Strain_Limits_eZc", - "text": "Strain_Limits_eZc" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_interface_weakening_factor", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_interface_weakening_factor.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_interface_weakening_factor", + "title": "Puck_Constants_interface_weakening_factor > Puck_Constants_interface_weakening_factor > Puck_Constants_interface_weakening_factor", + "section": "Puck_Constants_interface_weakening_factor > Puck_Constants_interface_weakening_factor", + "text": "MaterialProperty.Puck_Constants_interface_weakening_factor: str = 'interface_weakening_factor_puck_constants'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZc", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZc.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZc", - "title": "Strain_Limits_eZc > Strain_Limits_eZc > Strain_Limits_eZc", - "section": "Strain_Limits_eZc > Strain_Limits_eZc", - "text": "MaterialProperty.Strain_Limits_eZc: str = 'strain_compressive_z_direction'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.html#cuntzecriterion", + "title": "CuntzeCriterion", + "section": "CuntzeCriterion", + "text": "Defines the Cuntze criterion for uni-directional orthotropic reinforced materials.\ncfc (bool, default: True) – Activates the failure evaluation regarding compression in fiber direction.\ncft (bool, default: True) – Activates the failure evaluation regarding tension in fiber direction.\ncma (bool, default: True) – Activates the failure evaluation of the matrix due to tension.\ncmb (bool, default: True) – Activates the failure evaluation of the matrix due to compression.\ncmc (bool, default: True) – Activates the failure evaluation of the matrix due to compression or shear.\ndim (int, default: 2) – Whether the 2D or 3D formulation of the criterion is used.\nwf_cfc (float, default: 1.0) – Weighting factor of fiber failure due to compression (cfc).\nwf_cft (float, default: 1.0) – Weighting factor of fiber failure due to tension (cft).\nwf_cma (float, default: 1.0) – Weighting factor of matrix failure due to tension (cma).\nwf_cmb (float, default: 1.0) – Weighting factor of matrix failure due to compression (cmb).\nwf_cmc (float, default: 1.0) – Weighting factor of matrix failure due to compression or shear (cmc).\nb21 (float, default: 0.2) – In-plane shear friction coefficient. The default is 0.2.\nb32 (float, default: 1.3805) – Out-of-plane shear friction coefficient. The default is 1.3805. The value depends on the fracture plane angle.\nfracture_plane_angle (float, default: 53.0) – Fracture plane angle in degrees. The default is 53. The value must be greater than 45. The value depends on the out-of-plane shear friction coefficient.\nmode_interaction_coeff (float, default: 2.6) – Mode interaction coefficient. The default is 2.6.\nCuntzeCriterion.to_dict()\n\nCuntzeCriterion.to_json()\n\nCuntzeCriterion.active\nThe failure criterion is suppressed if active is False.\nCuntzeCriterion.b21\nIn-plane shear friction coefficient.\nCuntzeCriterion.b32\nOut-of-plane shear friction coefficient.\nCuntzeCriterion.cfc\nActivates the failure evaluation regarding compression in fiber direction.\nCuntzeCriterion.cft\nActivates the failure evaluation regarding tension in fiber direction.\nCuntzeCriterion.cma\nActivates the failure evaluation of the matrix due to tension.\nCuntzeCriterion.cmb\nActivates the failure evaluation of the matrix due to compression.\nCuntzeCriterion.cmc\nActivates the failure evaluation of the matrix due to compression or shear.\nCuntzeCriterion.dim\nWhether the 2D or 3D formulation of the criterion is used.\nCuntzeCriterion.fracture_plane_angle\nFracture plane angle in degrees.\nCuntzeCriterion.mode_interaction_coeff\nMode interaction coefficient.\nCuntzeCriterion.name\nName of the failure criterion.\nCuntzeCriterion.wf_cfc\nWeighting factor of fiber failure due to compression (cfc).\nCuntzeCriterion.wf_cft\nWeighting factor of fiber failure due to tension (cft).\nCuntzeCriterion.wf_cma\nWeighting factor of matrix failure due to tension (cma).\nCuntzeCriterion.wf_cmb\nWeighting factor of matrix failure due to compression (cmb).\nCuntzeCriterion.wf_cmc\nWeighting factor of matrix failure due to compression or shear (cmc).\nCuntzeCriterion\nbool\nTrue\nbool\nTrue\nbool\nTrue\nbool\nTrue\nbool\nTrue\nint\n2\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n0.2\n0.2\nfloat\n1.3805\n1.3805\nfloat\n53.0\n53\nfloat\n2.6\n2.6\nCuntzeCriterion.to_dict\nCuntzeCriterion.to_json\nCuntzeCriterion.active\nCuntzeCriterion.b21\nCuntzeCriterion.b32\nCuntzeCriterion.cfc\nCuntzeCriterion.cft\nCuntzeCriterion.cma\nCuntzeCriterion.cmb\nCuntzeCriterion.cmc\nCuntzeCriterion.dim\nCuntzeCriterion.fracture_plane_angle\nCuntzeCriterion.mode_interaction_coeff\nCuntzeCriterion.name\nCuntzeCriterion.wf_cfc\nCuntzeCriterion.wf_cft\nCuntzeCriterion.wf_cma\nCuntzeCriterion.wf_cmb\nCuntzeCriterion.wf_cmc" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.startswith", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.startswith.html#startswith", - "title": "startswith", - "section": "startswith", - "text": "Return True if the string starts with the specified prefix, False otherwise.\nA string or a tuple of strings to try.\nOptional start position. Default: start of the string.\nOptional stop position. Default: end of the string.\nstartswith" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion", + "title": "CuntzeCriterion > CuntzeCriterion > CuntzeCriterion", + "section": "CuntzeCriterion > CuntzeCriterion", + "text": "class ansys.dpf.composites.failure_criteria.CuntzeCriterion(*, cfc=True, cft=True, cma=True, cmb=True, cmc=True, dim=2, wf_cfc=1.0, wf_cft=1.0, wf_cma=1.0, wf_cmb=1.0, wf_cmc=1.0, b21=0.2, b32=1.3805, fracture_plane_angle=53.0, mode_interaction_coeff=2.6)\n\nDefines the Cuntze criterion for uni-directional orthotropic reinforced materials.\n\nParameters\n\ncfc (bool, default: True) – Activates the failure evaluation regarding compression in fiber direction.\n\ncft (bool, default: True) – Activates the failure evaluation regarding tension in fiber direction.\n\ncma (bool, default: True) – Activates the failure evaluation of the matrix due to tension.\n\ncmb (bool, default: True) – Activates the failure evaluation of the matrix due to compression.\n\ncmc (bool, default: True) – Activates the failure evaluation of the matrix due to compression or shear.\n\ndim (int, default: 2) – Whether the 2D or 3D formulation of the criterion is used.\n\nwf_cfc (float, default: 1.0) – Weighting factor of fiber failure due to compression (cfc).\n\nwf_cft (float, default: 1.0) – Weighting factor of fiber failure due to tension (cft).\n\nwf_cma (float, default: 1.0) – Weighting factor of matrix failure due to tension (cma).\n\nwf_cmb (float, default: 1.0) – Weighting factor of matrix failure due to compression (cmb).\n\nwf_cmc (float, default: 1.0) – Weighting factor of matrix failure due to compression or shear (cmc).\n\nb21 (float, default: 0.2) – In-plane shear friction coefficient. The default is 0.2.\n\nb32 (float, default: 1.3805) – Out-of-plane shear friction coefficient. The default is 1.3805. The value depends on the fracture plane angle.\n\nfracture_plane_angle (float, default: 53.0) – Fracture plane angle in degrees. The default is 53. The value must be greater than 45. The value depends on the out-of-plane shear friction coefficient.\n\nmode_interaction_coeff (float, default: 2.6) – Mode interaction coefficient. The default is 2.6.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nCuntzeCriterion.to_dict()\n\n\n\nCuntzeCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nCuntzeCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nCuntzeCriterion.b21\n\nIn-plane shear friction coefficient.\n\nCuntzeCriterion.b32\n\nOut-of-plane shear friction coefficient.\n\nCuntzeCriterion.cfc\n\nActivates the failure evaluation regarding compression in fiber direction.\n\nCuntzeCriterion.cft\n\nActivates the failure evaluation regarding tension in fiber direction.\n\nCuntzeCriterion.cma\n\nActivates the failure evaluation of the matrix due to tension.\n\nCuntzeCriterion.cmb\n\nActivates the failure evaluation of the matrix due to compression.\n\nCuntzeCriterion.cmc\n\nActivates the failure evaluation of the matrix due to compression or shear.\n\nCuntzeCriterion.dim\n\nWhether the 2D or 3D formulation of the criterion is used.\n\nCuntzeCriterion.fracture_plane_angle\n\nFracture plane angle in degrees.\n\nCuntzeCriterion.mode_interaction_coeff\n\nMode interaction coefficient.\n\nCuntzeCriterion.name\n\nName of the failure criterion.\n\nCuntzeCriterion.wf_cfc\n\nWeighting factor of fiber failure due to compression (cfc).\n\nCuntzeCriterion.wf_cft\n\nWeighting factor of fiber failure due to tension (cft).\n\nCuntzeCriterion.wf_cma\n\nWeighting factor of matrix failure due to tension (cma).\n\nCuntzeCriterion.wf_cmb\n\nWeighting factor of matrix failure due to compression (cmb).\n\nCuntzeCriterion.wf_cmc\n\nWeighting factor of matrix failure due to compression or shear (cmc).\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.startswith", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.startswith.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.startswith", - "title": "startswith > startswith > startswith", - "section": "startswith > startswith", - "text": "FailureMeasureEnum.startswith(prefix, [start, [end]], /)\n\nReturn True if the string starts with the specified prefix, False otherwise.\n\nprefix\n\nA string or a tuple of strings to try.\n\nstart\n\nOptional start position. Default: start of the string.\n\nend\n\nOptional stop position. Default: end of the string.\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/003_short_fiber_example", + "href": "examples/gallery_examples/003_short_fiber_example.html#failure-analysis-for-short-fiber-composites", + "title": "Failure analysis for short fiber composites", + "section": "Failure analysis for short fiber composites", + "text": "This example shows how to evaluate failures of a short fiber reinforced\npart.\nAs part of the short fiber workflows, you can evaluate and plot Tsai-Hill\ntype orientation tensor-dependent failure criteria. This example shows\nhow to configure the DPF operator short_fiber_failure_criterion_evaluator\nto compute such failure criteria.\nThe model shown in this example consists of a tensile specimen made of\na short glass fiber reinforced thermoplastic injection molded from both sides.\nThe evaluation of failure criteria in short fiber workflows is a\nbeta feature, introduced in Ansys 2021 R2.\nFailure analysis for short fiber composites\nshort_fiber_failure_criterion_evaluator" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.w", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.w.html#w", - "title": "w", - "section": "w", - "text": "w" + "objectID": "examples/gallery_examples/003_short_fiber_example", + "href": "examples/gallery_examples/003_short_fiber_example.html#set-up-analysis", + "title": "Failure analysis for short fiber composites > Set up analysis", + "section": "Set up analysis", + "text": "Setting up the analysis consists of loading Ansys libraries, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries.\nStart a DPF server and copy the example files into the current working directory.\nThese files are needed:\nMechanical APDL result (RST) file containing the simulation results\nEngineering Data (MATML) file containing the material properties of the composite\nMechanical APDL input file (DS.DAT) containing the fiber orientation tensor data\nSet up analysis" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.w", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.w.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.w", - "title": "w > w > w", - "section": "w > w", - "text": "FailureModeEnum.w = 320\n\n" + "objectID": "examples/gallery_examples/003_short_fiber_example", + "href": "examples/gallery_examples/003_short_fiber_example.html#set-up-data-sources", + "title": "Failure analysis for short fiber composites > Set up data sources", + "section": "Set up data sources", + "text": "Set up the data sources.\nSet up data sources" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cfc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cfc.html#cfc", - "title": "cfc", - "section": "cfc", - "text": "cfc" + "objectID": "examples/gallery_examples/003_short_fiber_example", + "href": "examples/gallery_examples/003_short_fiber_example.html#initialize-dpf-model", + "title": "Failure analysis for short fiber composites > Initialize DPF model", + "section": "Initialize DPF model", + "text": "Initialize the DPF model.\nInitialize DPF model" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cfc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cfc.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.cfc", - "title": "cfc > cfc > cfc", - "section": "cfc > cfc", - "text": "FailureModeEnum.cfc = 1002\n\n" + "objectID": "examples/gallery_examples/003_short_fiber_example", + "href": "examples/gallery_examples/003_short_fiber_example.html#plot-results", + "title": "Failure analysis for short fiber composites > Plot results", + "section": "Plot results", + "text": "Plot the two largest eigenvalues (a11 and a22) of the fiber orientation tensor.\nNote that the plots reveal the presence of a weld line in the middle of the specimen.\nPlot results" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.honeycomb_core_coeff", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.honeycomb_core_coeff.html#honeycomb_core_coeff", - "title": "honeycomb_core_coeff", - "section": "honeycomb_core_coeff", - "text": "Wrinkling coefficient (reduction factor) for honeycombs. The default is 0.33.\nfloat\nhoneycomb_core_coeff\n0.33\nfloat" + "objectID": "examples/gallery_examples/003_short_fiber_example", + "href": "examples/gallery_examples/003_short_fiber_example.html#configure-and-evaluate", + "title": "Failure analysis for short fiber composites > Configure and evaluate", + "section": "Configure and evaluate", + "text": "Configure the short fiber failure criterion evaluator and evaluate.\nNote that you can specify optional time and mesh scoping inputs.\nConfigure and evaluate" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.honeycomb_core_coeff", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.honeycomb_core_coeff.html#ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.honeycomb_core_coeff", - "title": "honeycomb_core_coeff > honeycomb_core_coeff > honeycomb_core_coeff", - "section": "honeycomb_core_coeff > honeycomb_core_coeff", - "text": "property FaceSheetWrinklingCriterion.honeycomb_core_coeff: float\n\nWrinkling coefficient (reduction factor) for honeycombs. The default is 0.33.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/003_short_fiber_example", + "href": "examples/gallery_examples/003_short_fiber_example.html#compute-and-plot-results", + "title": "Failure analysis for short fiber composites > Compute and plot results", + "section": "Compute and plot results", + "text": "Compute and plot the maximum failure value per element.\nTotal running time of the script: (0 minutes 3.287 seconds)\nDownload Jupyter notebook: 003_short_fiber_example.ipynb\nDownload Python source code: 003_short_fiber_example.py\nDownload zipped: 003_short_fiber_example.zip\nGallery generated by Sphinx-Gallery\nCompute and plot results\nDownload Jupyter notebook: 003_short_fiber_example.ipynb\nDownload Python source code: 003_short_fiber_example.py\nDownload zipped: 003_short_fiber_example.zip" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_ply_wise_critical_failures", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_ply_wise_critical_failures.html#get_ply_wise_critical_failures", - "title": "get_ply_wise_critical_failures", - "section": "get_ply_wise_critical_failures", - "text": "Get the critical failure value and modes per ply.\nlist[FailureResult]\nget_ply_wise_critical_failures\nlist\nFailureResult" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_json.html#to_json", + "title": "to_json", + "section": "to_json", + "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_ply_wise_critical_failures", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_ply_wise_critical_failures.html#ansys.dpf.composites.sampling_point.SamplingPoint.get_ply_wise_critical_failures", - "title": "get_ply_wise_critical_failures > get_ply_wise_critical_failures > get_ply_wise_critical_failures", - "section": "get_ply_wise_critical_failures > get_ply_wise_critical_failures", - "text": "SamplingPoint.get_ply_wise_critical_failures()\n\nGet the critical failure value and modes per ply.\n\nReturn type\n\nlist[FailureResult]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_json.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_json", + "title": "to_json > to_json > to_json", + "section": "to_json > to_json", + "text": "VonMisesCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent", - "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.html#sym3x3tensorcomponent", - "title": "Sym3x3TensorComponent", - "section": "Sym3x3TensorComponent", - "text": "Provides tensor indices for symmetrical 3x3 tensors.\nSym3x3TensorComponent.TENSOR11\n\nSym3x3TensorComponent.TENSOR22\n\nSym3x3TensorComponent.TENSOR33\n\nSym3x3TensorComponent.TENSOR21\n\nSym3x3TensorComponent.TENSOR31\n\nSym3x3TensorComponent.TENSOR32\n\nSym3x3TensorComponent\nSym3x3TensorComponent.TENSOR11\nSym3x3TensorComponent.TENSOR22\nSym3x3TensorComponent.TENSOR33\nSym3x3TensorComponent.TENSOR21\nSym3x3TensorComponent.TENSOR31\nSym3x3TensorComponent.TENSOR32" + "objectID": "examples/gallery_examples/009_short_fiber_orientation_tensor", + "href": "examples/gallery_examples/009_short_fiber_orientation_tensor.html#plot-of-the-orientation-tensor-for-short-fiber-composites", + "title": "Plot of the orientation tensor for short fiber composites", + "section": "Plot of the orientation tensor for short fiber composites", + "text": "This example shows how to reconstruct and plot the components\nof the fiber orientation tensor in the global coordinate system.\nFor more details about the fiber orientation tensor,\nrefer to the Short Fiber Composites help.\nTo run this example you first need to install the SciPy package.\nPlot of the orientation tensor for short fiber composites" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent", - "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.html#ansys.dpf.composites.constants.Sym3x3TensorComponent", - "title": "Sym3x3TensorComponent > Sym3x3TensorComponent > Sym3x3TensorComponent", - "section": "Sym3x3TensorComponent > Sym3x3TensorComponent", - "text": "class ansys.dpf.composites.constants.Sym3x3TensorComponent(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nProvides tensor indices for symmetrical 3x3 tensors.\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nSym3x3TensorComponent.TENSOR11\n\n\n\nSym3x3TensorComponent.TENSOR22\n\n\n\nSym3x3TensorComponent.TENSOR33\n\n\n\nSym3x3TensorComponent.TENSOR21\n\n\n\nSym3x3TensorComponent.TENSOR31\n\n\n\nSym3x3TensorComponent.TENSOR32\n\n\n\n" + "objectID": "examples/gallery_examples/009_short_fiber_orientation_tensor", + "href": "examples/gallery_examples/009_short_fiber_orientation_tensor.html#set-up-analysis", + "title": "Plot of the orientation tensor for short fiber composites > Set up analysis", + "section": "Set up analysis", + "text": "Setting up the analysis consists of loading Ansys libraries, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries.\nStart a DPF server and copy the example files into the current working directory.\nThese files are needed:\nMechanical APDL result (RST) file containing the simulation results\nMechanical APDL input file (DS.DAT) containing the fiber orientation tensor data\nSet up analysis" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3c", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3c.html#s3c", - "title": "s3c", - "section": "s3c", - "text": "s3c" + "objectID": "examples/gallery_examples/009_short_fiber_orientation_tensor", + "href": "examples/gallery_examples/009_short_fiber_orientation_tensor.html#set-up-data-sources", + "title": "Plot of the orientation tensor for short fiber composites > Set up data sources", + "section": "Set up data sources", + "text": "Set up the data sources.\nSet up data sources" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3c", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3c.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s3c", - "title": "s3c > s3c > s3c", - "section": "s3c > s3c", - "text": "FailureModeEnum.s3c = 232\n\n" + "objectID": "examples/gallery_examples/009_short_fiber_orientation_tensor", + "href": "examples/gallery_examples/009_short_fiber_orientation_tensor.html#initialize-dpf-model", + "title": "Plot of the orientation tensor for short fiber composites > Initialize DPF model", + "section": "Initialize DPF model", + "text": "Initialize the DPF model.\nShould your mesh contain both solid and shell elements, for visualization purposes\nit can be useful to scope the mesh to the solid ones.\nInitialize DPF model" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E.html#engineering_constants_e", - "title": "Engineering_Constants_E", - "section": "Engineering_Constants_E", - "text": "Engineering_Constants_E" + "objectID": "examples/gallery_examples/009_short_fiber_orientation_tensor", + "href": "examples/gallery_examples/009_short_fiber_orientation_tensor.html#plot-input-data", + "title": "Plot of the orientation tensor for short fiber composites > Plot input data", + "section": "Plot input data", + "text": "Plot the two largest eigenvalues (a11 and a22) of the fiber orientation tensor.\nNote that the plots reveal the presence of a weld line in the middle of the specimen.\nPlot input data" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E", - "title": "Engineering_Constants_E > Engineering_Constants_E > Engineering_Constants_E", - "section": "Engineering_Constants_E > Engineering_Constants_E", - "text": "MaterialProperty.Engineering_Constants_E: str = 'young_modulus'\n\n" + "objectID": "examples/gallery_examples/009_short_fiber_orientation_tensor", + "href": "examples/gallery_examples/009_short_fiber_orientation_tensor.html#compute-results", + "title": "Plot of the orientation tensor for short fiber composites > Compute results", + "section": "Compute results", + "text": "Reconstruct the fiber orientation tensor in the global coordinate system.\nCompute results" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.html#combinedfailurecriterion", - "title": "CombinedFailureCriterion", - "section": "CombinedFailureCriterion", - "text": "Defines the combined failure criterion.\nThis class can be used in combination with the failure evaluator operator in\nDPF Composites.\nCombinedFailureCriterion.insert(fc)\nAdd a failure criterion to a list of selected criteria.\nCombinedFailureCriterion.remove(key)\nRemove a failure criterion.\nCombinedFailureCriterion.to_dict()\nReturn the combined failure criterion as a dictionary.\nCombinedFailureCriterion.to_json()\nReturn the combined failure criterion as a JSON dictionary.\nCombinedFailureCriterion.JSON_DICT_KEY\n\nCombinedFailureCriterion.failure_criteria\nList of failure criteria.\nCombinedFailureCriterion.name\nName of the combined failure criterion.\nCombinedFailureCriterion\nCombinedFailureCriterion.insert\nCombinedFailureCriterion.remove\nCombinedFailureCriterion.to_dict\nCombinedFailureCriterion.to_json\nCombinedFailureCriterion.JSON_DICT_KEY\nCombinedFailureCriterion.failure_criteria\nCombinedFailureCriterion.name" + "objectID": "examples/gallery_examples/009_short_fiber_orientation_tensor", + "href": "examples/gallery_examples/009_short_fiber_orientation_tensor.html#plot-results", + "title": "Plot of the orientation tensor for short fiber composites > Plot results", + "section": "Plot results", + "text": "Plot some components of the fiber orientation tensor.\nTotal running time of the script: (0 minutes 5.827 seconds)\nDownload Jupyter notebook: 009_short_fiber_orientation_tensor.ipynb\nDownload Python source code: 009_short_fiber_orientation_tensor.py\nDownload zipped: 009_short_fiber_orientation_tensor.zip\nGallery generated by Sphinx-Gallery\nPlot results\nDownload Jupyter notebook: 009_short_fiber_orientation_tensor.ipynb\nDownload Python source code: 009_short_fiber_orientation_tensor.py\nDownload zipped: 009_short_fiber_orientation_tensor.zip" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.html#ansys.dpf.composites.failure_criteria.CombinedFailureCriterion", - "title": "CombinedFailureCriterion > CombinedFailureCriterion > CombinedFailureCriterion", - "section": "CombinedFailureCriterion > CombinedFailureCriterion", - "text": "class ansys.dpf.composites.failure_criteria.CombinedFailureCriterion(name='CombinedFailureCriterion', failure_criteria=())\n\nDefines the combined failure criterion.\n\nThis class can be used in combination with the failure evaluator operator in\nDPF Composites.\n\nExamples\n\n>>> combined_failure = CombinedFailureCriterion(\"max_stress 3D\")\n>>> max_stress = MaxStressCriterion(s1=True, s2=True, s3=True, s12=True, s13=True, s23=True)\n>>> combined_failure.insert(max_stress)\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nCombinedFailureCriterion.insert(fc)\n\nAdd a failure criterion to a list of selected criteria.\n\nCombinedFailureCriterion.remove(key)\n\nRemove a failure criterion.\n\nCombinedFailureCriterion.to_dict()\n\nReturn the combined failure criterion as a dictionary.\n\nCombinedFailureCriterion.to_json()\n\nReturn the combined failure criterion as a JSON dictionary.\n\n\n\nAttributes\n\n\n\n\n\n\n\nCombinedFailureCriterion.JSON_DICT_KEY\n\n\n\nCombinedFailureCriterion.failure_criteria\n\nList of failure criteria.\n\nCombinedFailureCriterion.name\n\nName of the combined failure criterion.\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.find", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.find.html#find", + "title": "find", + "section": "find", + "text": "Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end].\nOptional arguments start and end are interpreted as in slice notation.\nReturn -1 on failure.\nfind" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.insert", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.insert.html#insert", - "title": "insert", - "section": "insert", - "text": "Add a failure criterion to a list of selected criteria.\nfc (FailureCriterionBase) – Failure criterion to add. If a failure criterion of the same type\nalready exists, it is overwritten.\nNone\ninsert\nFailureCriterionBase\nNone" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.find", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.find.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.find", + "title": "find > find > find", + "section": "find > find", + "text": "FailureMeasureEnum.find(sub, [start, [end]], /)\n\nReturn the lowest index in S where substring sub is found, such that sub is contained within S[start:end].\n\nOptional arguments start and end are interpreted as in slice notation.\nReturn -1 on failure.\n\n!! processed by numpydoc !!" }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.insert", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.insert.html#ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.insert", - "title": "insert > insert > insert", - "section": "insert > insert", - "text": "CombinedFailureCriterion.insert(fc)\n\nAdd a failure criterion to a list of selected criteria.\n\nParameters\n\nfc (FailureCriterionBase) – Failure criterion to add. If a failure criterion of the same type\nalready exists, it is overwritten.\n\nExamples\n\n>>> combined_failure = CombinedFailureCriterion(\"max_stress 3D\")\n>>> max_stress = MaxStressCriterion(s1=True, s2=True, s3=True,\n s12=True, s13=True, s23=True)\n>>> combined_failure.insert(max_stress)\n\nReturn type\n\nNone\n\n!! processed by numpydoc !!" + { + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.ANGLES", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.ANGLES.html#angles", + "title": "ANGLES", + "section": "ANGLES", + "text": "ANGLES" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hf.html#hf", - "title": "hf", - "section": "hf", - "text": "hf" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.ANGLES", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.ANGLES.html#ansys.dpf.composites.layup_info.LayerProperty.ANGLES", + "title": "ANGLES > ANGLES > ANGLES", + "section": "ANGLES > ANGLES", + "text": "LayerProperty.ANGLES = 1\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hf.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.hf", - "title": "hf > hf > hf", - "section": "hf > hf", - "text": "FailureModeEnum.hf = 601\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.to_json.html#to_json", + "title": "to_json", + "section": "to_json", + "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.composite_definition", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.composite_definition.html#composite_definition", - "title": "composite_definition", - "section": "composite_definition", - "text": "composite_definition" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.to_json.html#ansys.dpf.composites.failure_criteria.PuckCriterion.to_json", + "title": "to_json > to_json > to_json", + "section": "to_json > to_json", + "text": "PuckCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.composite_definition", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.composite_definition.html#ansys.dpf.composites.result_definition.ResultDefinitionScope.composite_definition", - "title": "composite_definition > composite_definition > composite_definition", - "section": "composite_definition > composite_definition", - "text": "ResultDefinitionScope.composite_definition: str | PathLike[str]\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmc.html#wf_lmc", + "title": "wf_lmc", + "section": "wf_lmc", + "text": "Weighting factor of matrix failure due to compression (lmc).\nfloat\nwf_lmc\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1.html#e1", - "title": "e1", - "section": "e1", - "text": "e1" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmc.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lmc", + "title": "wf_lmc > wf_lmc > wf_lmc", + "section": "wf_lmc > wf_lmc", + "text": "property LaRCCriterion.wf_lmc: float\n\nWeighting factor of matrix failure due to compression (lmc).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e1", - "title": "e1 > e1 > e1", - "section": "e1 > e1", - "text": "FailureModeEnum.e1 = 110\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G13", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G13.html#engineering_constants_g13", + "title": "Engineering_Constants_G13", + "section": "Engineering_Constants_G13", + "text": "Engineering_Constants_G13" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s2", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s2.html#s2", - "title": "s2", - "section": "s2", - "text": "Whether to activate the failure evaluation regarding the stress in the material 2 direction.\nbool\ns2\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G13", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G13.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G13", + "title": "Engineering_Constants_G13 > Engineering_Constants_G13 > Engineering_Constants_G13", + "section": "Engineering_Constants_G13 > Engineering_Constants_G13", + "text": "MaterialProperty.Engineering_Constants_G13: str = 'shear_modulus_xz'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s2", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s2.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.s2", - "title": "s2 > s2 > s2", - "section": "s2 > s2", - "text": "property MaxStressCriterion.s2: bool\n\nWhether to activate the failure evaluation regarding the stress in the material 2 direction.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.cfps", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.cfps.html#cfps", + "title": "cfps", + "section": "cfps", + "text": "Whether to consider inter-fiber strength reduction due to fiber parallel stresses.\nbool\ncfps\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.wf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.wf.html#wf", - "title": "wf", - "section": "wf", - "text": "Weighting factor of the failure mode (cs).\nfloat\nwf\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.cfps", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.cfps.html#ansys.dpf.composites.failure_criteria.PuckCriterion.cfps", + "title": "cfps > cfps > cfps", + "section": "cfps > cfps", + "text": "property PuckCriterion.cfps: bool\n\nWhether to consider inter-fiber strength reduction due to fiber parallel stresses.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.wf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.wf.html#ansys.dpf.composites.failure_criteria.CoreFailureCriterion.wf", - "title": "wf > wf > wf", - "section": "wf > wf", - "text": "property CoreFailureCriterion.wf: float\n\nWeighting factor of the failure mode (cs).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_pos", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_pos.html#puck_constants_p_21_pos", + "title": "Puck_Constants_p_21_pos", + "section": "Puck_Constants_p_21_pos", + "text": "Puck_Constants_p_21_pos" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.evm", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.evm.html#evm", - "title": "evm", - "section": "evm", - "text": "evm" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_pos", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_pos.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_pos", + "title": "Puck_Constants_p_21_pos > Puck_Constants_p_21_pos > Puck_Constants_p_21_pos", + "section": "Puck_Constants_p_21_pos > Puck_Constants_p_21_pos", + "text": "MaterialProperty.Puck_Constants_p_21_pos: str = 'tensile_inclination_xz_puck_constants'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.evm", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.evm.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.evm", - "title": "evm > evm > evm", - "section": "evm > evm", - "text": "FailureModeEnum.evm = 102\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices_by_analysis_ply", + "href": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices_by_analysis_ply.html#get_selected_indices_by_analysis_ply", + "title": "get_selected_indices_by_analysis_ply", + "section": "get_selected_indices_by_analysis_ply", + "text": "Get selected indices by analysis ply.\nSelects all indices that are in a layer with the given analysis ply\nanalysis_ply_info_provider (AnalysisPlyInfoProvider) – Provider for the analysis ply information.\nelement_info (ElementInfo) – Lay-up information for the element.\nSelected elementary indices.\nNDArray[int64]\nget_selected_indices_by_analysis_ply" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_json.html#to_json", - "title": "to_json", - "section": "to_json", - "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices_by_analysis_ply", + "href": "api/_autosummary/ansys.dpf.composites.select_indices.get_selected_indices_by_analysis_ply.html#ansys.dpf.composites.select_indices.get_selected_indices_by_analysis_ply", + "title": "get_selected_indices_by_analysis_ply > get_selected_indices_by_analysis_ply > get_selected_indices_by_analysis_ply", + "section": "get_selected_indices_by_analysis_ply > get_selected_indices_by_analysis_ply", + "text": "ansys.dpf.composites.select_indices.get_selected_indices_by_analysis_ply(analysis_ply_info_provider, element_info)\n\nGet selected indices by analysis ply.\n\nSelects all indices that are in a layer with the given analysis ply\n\nParameters\n\nanalysis_ply_info_provider (AnalysisPlyInfoProvider) – Provider for the analysis ply information.\n\nelement_info (ElementInfo) – Lay-up information for the element.\n\nReturns\n\nSelected elementary indices.\n\nReturn type\n\nNDArray[int64]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_json.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_json", - "title": "to_json > to_json > to_json", - "section": "to_json > to_json", - "text": "CuntzeCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.get_ply_wise_data", + "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.get_ply_wise_data.html#get_ply_wise_data", + "title": "get_ply_wise_data", + "section": "get_ply_wise_data", + "text": "Get ply-wise data from a field.\nfield (Field) – Field to extract data from.\nply_name (str) – Name of the ply to extract data from.\nmesh (MeshedRegion) – Meshed region that needs to be enriched with composite information.\nUse the CompositeModel.get_mesh() method to get the meshed region.\nspot_reduction_strategy (SpotReductionStrategy, default: ) – Reduction strategy for getting from spot values (BOT, MID, TOP) to a single value\nper corner node and layer. The default is AVG.\nrequested_location (str, default: 'ElementalNodal') – Location of the output field. Important: The function always averages nodal values\nfor \"elemental\" or \"nodal\" locations,\nirrespective of \"spot_reduction_strategy\".\nOptions are \"elemental\", \"elemental_nodal\", and \"nodal\".\nThe default is \"elemental_nodal\".\ncomponent (IntEnum | int, default: 0) – Component to extract data from. The default is 0.\nField\nget_ply_wise_data\nField\nstr\nMeshedRegion\nCompositeModel.get_mesh()\nSpotReductionStrategy\n\nAVG\nstr\n'ElementalNodal'\n\"elemental\"\n\"nodal\"\n\"spot_reduction_strategy\"\n\"elemental\"\n\"elemental_nodal\"\n\"nodal\"\n\"elemental_nodal\"\nIntEnum\nint\n0\n0\nField" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxy", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxy.html#strain_limits_esxy", - "title": "Strain_Limits_eSxy", - "section": "Strain_Limits_eSxy", - "text": "Strain_Limits_eSxy" + "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.get_ply_wise_data", + "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.get_ply_wise_data.html#ansys.dpf.composites.ply_wise_data.get_ply_wise_data", + "title": "get_ply_wise_data > get_ply_wise_data > get_ply_wise_data", + "section": "get_ply_wise_data > get_ply_wise_data", + "text": "ansys.dpf.composites.ply_wise_data.get_ply_wise_data(field, ply_name, mesh, spot_reduction_strategy=SpotReductionStrategy.AVG, requested_location='ElementalNodal', component=0)\n\nGet ply-wise data from a field.\n\nParameters\n\nfield (Field) – Field to extract data from.\n\nply_name (str) – Name of the ply to extract data from.\n\nmesh (MeshedRegion) – Meshed region that needs to be enriched with composite information.\nUse the CompositeModel.get_mesh() method to get the meshed region.\n\nspot_reduction_strategy (SpotReductionStrategy, default: ) – Reduction strategy for getting from spot values (BOT, MID, TOP) to a single value\nper corner node and layer. The default is AVG.\n\nrequested_location (str, default: 'ElementalNodal') – Location of the output field. Important: The function always averages nodal values\nfor \"elemental\" or \"nodal\" locations,\nirrespective of \"spot_reduction_strategy\".\nOptions are \"elemental\", \"elemental_nodal\", and \"nodal\".\nThe default is \"elemental_nodal\".\n\ncomponent (IntEnum | int, default: 0) – Component to extract data from. The default is 0.\n\nReturn type\n\nField\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxy", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxy.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxy", - "title": "Strain_Limits_eSxy > Strain_Limits_eSxy > Strain_Limits_eSxy", - "section": "Strain_Limits_eSxy > Strain_Limits_eSxy", - "text": "MaterialProperty.Strain_Limits_eSxy: str = 'strain_shear_xy'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.add_interlaminar_normal_stresses", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.add_interlaminar_normal_stresses.html#add_interlaminar_normal_stresses", + "title": "add_interlaminar_normal_stresses", + "section": "add_interlaminar_normal_stresses", + "text": "Add interlaminar normal stresses to the stresses fields container.\nInterlaminar normal stresses (s3) are not available for layered shells.\nThis function performs a post-processing step which computes s3 and adds\nit to the stress field. s3 is automatically computed if a formulation\nof a failure criterion depends on this stress component, for instance\nPuck 3D .\nFor a usage example, see\nsphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py.\nstresses (FieldsContainer) – Stresses fields container to add interlaminar normal stresses to.\nstrains (FieldsContainer)\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nInterlaminar normal stresses are only added to the layered elements defined\nin the specified composite definition.\nNone\nadd_interlaminar_normal_stresses\nPuck 3D\nFieldsContainer\nFieldsContainer\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nNone" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.html#tsaiwucriterion", - "title": "TsaiWuCriterion", - "section": "TsaiWuCriterion", - "text": "Defines the Tsai-Wu failure criterion for orthotropic reinforced materials.\nwf (float, default: 1.0) – Weighting factor of this failure criterion.\ndim (int, default: 2) – Specifies which formulation of the failure criterion is used.\nTsaiWuCriterion.to_dict()\n\nTsaiWuCriterion.to_json()\n\nTsaiWuCriterion.active\nThe failure criterion is suppressed if active is False.\nTsaiWuCriterion.dim\nSpecifies which formulation of the failure criterion is used.\nTsaiWuCriterion.name\nName of the failure criterion.\nTsaiWuCriterion.wf\nWeighting factor of this failure criterion.\nTsaiWuCriterion\nfloat\n1.0\nint\n2\nTsaiWuCriterion.to_dict\nTsaiWuCriterion.to_json\nTsaiWuCriterion.active\nTsaiWuCriterion.dim\nTsaiWuCriterion.name\nTsaiWuCriterion.wf" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.add_interlaminar_normal_stresses", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.add_interlaminar_normal_stresses.html#ansys.dpf.composites.composite_model.CompositeModel.add_interlaminar_normal_stresses", + "title": "add_interlaminar_normal_stresses > add_interlaminar_normal_stresses > add_interlaminar_normal_stresses", + "section": "add_interlaminar_normal_stresses > add_interlaminar_normal_stresses", + "text": "CompositeModel.add_interlaminar_normal_stresses(stresses, strains, composite_definition_label=None)\n\nAdd interlaminar normal stresses to the stresses fields container.\n\nInterlaminar normal stresses (s3) are not available for layered shells.\nThis function performs a post-processing step which computes s3 and adds\nit to the stress field. s3 is automatically computed if a formulation\nof a failure criterion depends on this stress component, for instance\nPuck 3D .\n\nFor a usage example, see\nsphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py.\n\nParameters\n\nstresses (FieldsContainer) – Stresses fields container to add interlaminar normal stresses to.\n\nstrains (FieldsContainer)\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nInterlaminar normal stresses are only added to the layered elements defined\nin the specified composite definition.\n\nReturn type\n\nNone\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.html#ansys.dpf.composites.failure_criteria.TsaiWuCriterion", - "title": "TsaiWuCriterion > TsaiWuCriterion > TsaiWuCriterion", - "section": "TsaiWuCriterion > TsaiWuCriterion", - "text": "class ansys.dpf.composites.failure_criteria.TsaiWuCriterion(*, active=True, wf=1.0, dim=2)\n\nDefines the Tsai-Wu failure criterion for orthotropic reinforced materials.\n\nParameters\n\nwf (float, default: 1.0) – Weighting factor of this failure criterion.\n\ndim (int, default: 2) – Specifies which formulation of the failure criterion is used.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nTsaiWuCriterion.to_dict()\n\n\n\nTsaiWuCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nTsaiWuCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nTsaiWuCriterion.dim\n\nSpecifies which formulation of the failure criterion is used.\n\nTsaiWuCriterion.name\n\nName of the failure criterion.\n\nTsaiWuCriterion.wf\n\nWeighting factor of this failure criterion.\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lft", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lft.html#lft", + "title": "lft", + "section": "lft", + "text": "Whether to activate the failure evaluation regarding tension in fiber direction.\nbool\nlft\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.p", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.p.html#p", - "title": "p", - "section": "p", - "text": "p" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lft", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lft.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.lft", + "title": "lft > lft > lft", + "section": "lft > lft", + "text": "property LaRCCriterion.lft: bool\n\nWhether to activate the failure evaluation regarding tension in fiber direction.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.p", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.p.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.p", - "title": "p > p > p", - "section": "p > p", - "text": "FailureModeEnum.p = 800\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_angles", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_angles.html#get_layer_angles", + "title": "get_layer_angles", + "section": "get_layer_angles", + "text": "Get angles for all layers. Returns None if element is not layered.\nelement_id (int) – Element Id/Label\nOptional[ndarray[Any, dtype[float64]]]\nget_layer_angles\nint\nOptional\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu12", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu12.html#engineering_constants_nu12", - "title": "Engineering_Constants_nu12", - "section": "Engineering_Constants_nu12", - "text": "Engineering_Constants_nu12" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_angles", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_angles.html#ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_angles", + "title": "get_layer_angles > get_layer_angles > get_layer_angles", + "section": "get_layer_angles > get_layer_angles", + "text": "LayupPropertiesProvider.get_layer_angles(element_id)\n\nGet angles for all layers. Returns None if element is not layered.\n\nParameters\n\nelement_id (int) – Element Id/Label\n\nReturn type\n\nOptional[ndarray[Any, dtype[float64]]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu12", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu12.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu12", - "title": "Engineering_Constants_nu12 > Engineering_Constants_nu12 > Engineering_Constants_nu12", - "section": "Engineering_Constants_nu12 > Engineering_Constants_nu12", - "text": "MaterialProperty.Engineering_Constants_nu12: str = 'poisson_ratio_xy'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.to_dict.html#to_dict", + "title": "to_dict", + "section": "to_dict", + "text": "Get the result definition in a dictionary representation.\ndict[str, Any]\nto_dict\ndict\nstr\nAny" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.s", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.s.html#s", - "title": "s", - "section": "s", - "text": "Specifies the effect of fiber parallel stresses regarding inter-fiber failure. s = [0, 1) and the default is 0.5.\nfloat\ns\n0.5\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.to_dict.html#ansys.dpf.composites.result_definition.ResultDefinition.to_dict", + "title": "to_dict > to_dict > to_dict", + "section": "to_dict > to_dict", + "text": "ResultDefinition.to_dict()\n\nGet the result definition in a dictionary representation.\n\nReturn type\n\ndict[str, Any]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.s", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.s.html#ansys.dpf.composites.failure_criteria.PuckCriterion.s", - "title": "s > s > s", - "section": "s > s", - "text": "property PuckCriterion.s: float\n\nSpecifies the effect of fiber parallel stresses regarding inter-fiber failure. s = [0, 1) and the default is 0.5.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/constants", + "href": "api/constants.html#constants", + "title": "Constants", + "section": "Constants", + "text": "FailureOutput(value[, names, module, ...])\nProvides failure output types.\nSpot(value[, names, module, qualname, type, ...])\nImplements an interface to access the spots of the results of layered elements.\nSym3x3TensorComponent(value[, names, ...])\nProvides tensor indices for symmetrical 3x3 tensors.\nConstants\nFailureOutput\nSpot\nSym3x3TensorComponent" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.name.html#name", - "title": "name", - "section": "name", - "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p22_neg", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p22_neg.html#p22_neg", + "title": "p22_neg", + "section": "p22_neg", + "text": "Global inclination factor of the fracture plane \\perp \\perp for compression.\nfloat\np22_neg\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.name.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.name", - "title": "name > name > name", - "section": "name > name", - "text": "property VonMisesCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p22_neg", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p22_neg.html#ansys.dpf.composites.failure_criteria.PuckCriterion.p22_neg", + "title": "p22_neg > p22_neg > p22_neg", + "section": "p22_neg > p22_neg", + "text": "property PuckCriterion.p22_neg: float\n\nGlobal inclination factor of the fracture plane \\perp \\perp for compression.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/index", - "href": "examples/index.html#examples", - "title": "Examples", - "section": "Examples", - "text": "These examples demonstrate the behavior and usage of PyDPF - Composites.\nsphx_glr_examples_gallery_examples_001_failure_operator_example.py\nsphx_glr_examples_gallery_examples_002_sampling_point_example.py\nsphx_glr_examples_gallery_examples_003_short_fiber_example.py\nsphx_glr_examples_gallery_examples_004_get_material_properties_example.py\nsphx_glr_examples_gallery_examples_005_get_layup_properties_example.py\nsphx_glr_examples_gallery_examples_006_filter_composite_data_example.py\nsphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py\nsphx_glr_examples_gallery_examples_008_assembly_example.py\nsphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py\nsphx_glr_examples_gallery_examples_010_harmonic_example.py\nsphx_glr_examples_gallery_examples_011_rst_workflow.py\nsphx_glr_examples_gallery_examples_012_fatigue_example.py\nsphx_glr_examples_gallery_examples_013_thermal_example.py\nsphx_glr_examples_gallery_examples_014_cyclic_symmetry_example.py\nsphx_glr_examples_gallery_examples_099_dpf_composite_failure_workflow.py\nGallery generated by Sphinx-Gallery\nExamples" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_G12", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_G12.html#polar_properties_g12", + "title": "polar_properties_G12", + "section": "polar_properties_G12", + "text": "Polar property G12 of the laminate.\nndarray[Any, dtype[float64]]\npolar_properties_G12\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pmb", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pmb.html#pmb", - "title": "pmb", - "section": "pmb", - "text": "Whether to activate the failure evaluation regarding matrix failure due to compression.\nbool\npmb\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_G12", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_G12.html#ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_G12", + "title": "polar_properties_G12 > polar_properties_G12 > polar_properties_G12", + "section": "polar_properties_G12 > polar_properties_G12", + "text": "property SamplingPoint.polar_properties_G12: ndarray[Any, dtype[float64]]\n\nPolar property G12 of the laminate.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pmb", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pmb.html#ansys.dpf.composites.failure_criteria.PuckCriterion.pmb", - "title": "pmb > pmb > pmb", - "section": "pmb > pmb", - "text": "property PuckCriterion.pmb: bool\n\nWhether to activate the failure evaluation regarding matrix failure due to compression.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.vMe", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.vMe.html#vme", + "title": "vMe", + "section": "vMe", + "text": "vMe" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.name.html#name", - "title": "name", - "section": "name", - "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.vMe", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.vMe.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.vMe", + "title": "vMe > vMe > vMe", + "section": "vMe > vMe", + "text": "FailureModeEnum.vMe = 1101\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.name.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.name", - "title": "name > name > name", - "section": "name > name", - "text": "property CuntzeCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu23", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu23.html#engineering_constants_nu23", + "title": "Engineering_Constants_nu23", + "section": "Engineering_Constants_nu23", + "text": "Engineering_Constants_nu23" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_json.html#to_json", - "title": "to_json", - "section": "to_json", - "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu23", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu23.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu23", + "title": "Engineering_Constants_nu23 > Engineering_Constants_nu23 > Engineering_Constants_nu23", + "section": "Engineering_Constants_nu23 > Engineering_Constants_nu23", + "text": "MaterialProperty.Engineering_Constants_nu23: str = 'poisson_ratio_yz'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_json.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_json", - "title": "to_json > to_json > to_json", - "section": "to_json > to_json", - "text": "MaxStressCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.html#continuousfibercompositesfiles", + "title": "ContinuousFiberCompositesFiles", + "section": "ContinuousFiberCompositesFiles", + "text": "Provides the container for continuous fiber composite file paths.\nContinuousFiberCompositesFiles.files_are_local\n\nContinuousFiberCompositesFiles.rst\n\nContinuousFiberCompositesFiles.composite\n\nContinuousFiberCompositesFiles.engineering_data\n\nContinuousFiberCompositesFiles\nContinuousFiberCompositesFiles.files_are_local\nContinuousFiberCompositesFiles.rst\nContinuousFiberCompositesFiles.composite\nContinuousFiberCompositesFiles.engineering_data" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_dict.html#to_dict", - "title": "to_dict", - "section": "to_dict", - "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.html#ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles", + "title": "ContinuousFiberCompositesFiles > ContinuousFiberCompositesFiles > ContinuousFiberCompositesFiles", + "section": "ContinuousFiberCompositesFiles > ContinuousFiberCompositesFiles", + "text": "class ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles(rst, composite, engineering_data, files_are_local=True)\n\nProvides the container for continuous fiber composite file paths.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nContinuousFiberCompositesFiles.files_are_local\n\n\n\nContinuousFiberCompositesFiles.rst\n\n\n\nContinuousFiberCompositesFiles.composite\n\n\n\nContinuousFiberCompositesFiles.engineering_data\n\n\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.to_dict", - "title": "to_dict > to_dict > to_dict", - "section": "to_dict > to_dict", - "text": "VonMisesCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hm", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hm.html#hm", + "title": "hm", + "section": "hm", + "text": "hm" }, { - "objectID": "api/ply_wise_data", - "href": "api/ply_wise_data.html#ply-wise-data", - "title": "Ply wise data", - "section": "Ply wise data", - "text": "SpotReductionStrategy(value[, names, ...])\nProvides the strategy for getting from spot values (BOT, MID, TOP) to a single value.\nget_ply_wise_data(field, ply_name, mesh[, ...])\nGet ply-wise data from a field.\nPly wise data\nSpotReductionStrategy\nget_ply_wise_data" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hm", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.hm.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.hm", + "title": "hm > hm > hm", + "section": "hm > hm", + "text": "FailureModeEnum.hm = 602\n\n" }, { "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_LAYER_INDEX", @@ -5446,144 +5467,144 @@ "text": "FailureOutput.MAX_LAYER_INDEX = 2\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.html#compositedefinitionfiles", - "title": "CompositeDefinitionFiles", - "section": "CompositeDefinitionFiles", - "text": "Provides the container for composite definition file paths.\nCompositeDefinitionFiles.mapping\n\nCompositeDefinitionFiles.definition\n\nCompositeDefinitionFiles\nCompositeDefinitionFiles.mapping\nCompositeDefinitionFiles.definition" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.name.html#name", + "title": "name", + "section": "name", + "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.html#ansys.dpf.composites.data_sources.CompositeDefinitionFiles", - "title": "CompositeDefinitionFiles > CompositeDefinitionFiles > CompositeDefinitionFiles", - "section": "CompositeDefinitionFiles > CompositeDefinitionFiles", - "text": "class ansys.dpf.composites.data_sources.CompositeDefinitionFiles(definition, mapping=None)\n\nProvides the container for composite definition file paths.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nCompositeDefinitionFiles.mapping\n\n\n\nCompositeDefinitionFiles.definition\n\n\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.name.html#ansys.dpf.composites.failure_criteria.HoffmanCriterion.name", + "title": "name > name > name", + "section": "name > name", + "text": "property HoffmanCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G13", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G13.html#engineering_constants_g13", - "title": "Engineering_Constants_G13", - "section": "Engineering_Constants_G13", - "text": "Engineering_Constants_G13" + "objectID": "contribute", + "href": "contribute.html#contribute", + "title": "Contribute", + "section": "Contribute", + "text": "Contribute" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G13", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G13.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G13", - "title": "Engineering_Constants_G13 > Engineering_Constants_G13 > Engineering_Constants_G13", - "section": "Engineering_Constants_G13 > Engineering_Constants_G13", - "text": "MaterialProperty.Engineering_Constants_G13: str = 'shear_modulus_xz'\n\n" + "objectID": "contribute", + "href": "contribute.html#install-in-development-mode", + "title": "Contribute > Install in development mode", + "section": "Install in development mode", + "text": "Installing PyDPF - Composites in development mode allows\nyou to modify the source and enhance it.\nBefore attempting to contribute to PyDPF - Composites, ensure that you are thoroughly\nfamiliar with the PyAnsys Developer’s Guide.\nClone the repository:\nInstall dependencies:\nPyDPF - Composites uses Poetry\nto manage the development environment.\nCreate a virtual environment and install the package with the\ndevelopment dependencies:\nActivate the virtual environment:\nInstall in development mode" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.html#hashincriterion", - "title": "HashinCriterion", - "section": "HashinCriterion", - "text": "Defines the Hashin failure criterion for UD reinforced materials.\nhf (bool, default: True) – Whether to activate the failure evaluation regarding fiber failure.\nhm (bool, default: True) – Whether to activate the failure evaluation regarding matrix failure.\nhd (bool, default: False) – Whether to activate the failure evaluation regarding delamination if dim is equal to 3.\ndim (int, default: 2) – Whether the 2D or 3D formulation of the criterion is used. The latter one also supports the failure mode delamination.\nwf_hf (float, default: 1.0) – Weighting factor of the fiber failure (hf) mode.\nwf_hm (float, default: 1.0) – Weighting factor of the matrix failure (hm) mode.\nwf_hd (float, default: 1.0) – Weighting factor of the delamination (hd) mode.\nHashinCriterion.to_dict()\n\nHashinCriterion.to_json()\n\nHashinCriterion.active\nThe failure criterion is suppressed if active is False.\nHashinCriterion.dim\nWhether the 2D or 3D formulation of the criterion is used.\nHashinCriterion.hd\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\nHashinCriterion.hf\nWhether to activate the failure evaluation regarding fiber failure.\nHashinCriterion.hm\nWhether to activate the failure evaluation regarding matrix failure.\nHashinCriterion.name\nName of the failure criterion.\nHashinCriterion.wf_hd\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\nHashinCriterion.wf_hf\nWhether to activate the failure evaluation regarding fiber failure.\nHashinCriterion.wf_hm\nWhether to activate the failure evaluation regarding matrix failure.\nHashinCriterion\nbool\nTrue\nbool\nTrue\nbool\nFalse\nint\n2\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nHashinCriterion.to_dict\nHashinCriterion.to_json\nHashinCriterion.active\nHashinCriterion.dim\nHashinCriterion.hd\nHashinCriterion.hf\nHashinCriterion.hm\nHashinCriterion.name\nHashinCriterion.wf_hd\nHashinCriterion.wf_hf\nHashinCriterion.wf_hm" + "objectID": "contribute", + "href": "contribute.html#test", + "title": "Contribute > Test", + "section": "Test", + "text": "There are different ways to run the PyDPF - Composites tests, depending on how the DPF\nserver is started.\nRun tests with a Docker container:\nFollow the steps in Getting the DPF server Docker image to get\nand run the DPF docker image. Run the tests with the following command\nRun tests with a DPF server started from the Ansys installer. The Ansys version must\nbe 2023 R2 or later.\nRun tests with a Docker container from Github (Ansys Internal only):\nTest" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.html#ansys.dpf.composites.failure_criteria.HashinCriterion", - "title": "HashinCriterion > HashinCriterion > HashinCriterion", - "section": "HashinCriterion > HashinCriterion", - "text": "class ansys.dpf.composites.failure_criteria.HashinCriterion(*, hf=True, hm=True, hd=False, dim=2, wf_hf=1.0, wf_hm=1.0, wf_hd=1.0)\n\nDefines the Hashin failure criterion for UD reinforced materials.\n\nParameters\n\nhf (bool, default: True) – Whether to activate the failure evaluation regarding fiber failure.\n\nhm (bool, default: True) – Whether to activate the failure evaluation regarding matrix failure.\n\nhd (bool, default: False) – Whether to activate the failure evaluation regarding delamination if dim is equal to 3.\n\ndim (int, default: 2) – Whether the 2D or 3D formulation of the criterion is used. The latter one also supports the failure mode delamination.\n\nwf_hf (float, default: 1.0) – Weighting factor of the fiber failure (hf) mode.\n\nwf_hm (float, default: 1.0) – Weighting factor of the matrix failure (hm) mode.\n\nwf_hd (float, default: 1.0) – Weighting factor of the delamination (hd) mode.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nHashinCriterion.to_dict()\n\n\n\nHashinCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nHashinCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nHashinCriterion.dim\n\nWhether the 2D or 3D formulation of the criterion is used.\n\nHashinCriterion.hd\n\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\n\nHashinCriterion.hf\n\nWhether to activate the failure evaluation regarding fiber failure.\n\nHashinCriterion.hm\n\nWhether to activate the failure evaluation regarding matrix failure.\n\nHashinCriterion.name\n\nName of the failure criterion.\n\nHashinCriterion.wf_hd\n\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\n\nHashinCriterion.wf_hf\n\nWhether to activate the failure evaluation regarding fiber failure.\n\nHashinCriterion.wf_hm\n\nWhether to activate the failure evaluation regarding matrix failure.\n\n" + "objectID": "contribute", + "href": "contribute.html#build-documentation", + "title": "Contribute > Build documentation", + "section": "Build documentation", + "text": "Follow the description in Getting the DPF server Docker image image to get\nand run the dpf docker image.\nOn Windows, build the documentation with:\nOn Linux, build the documentation with:\nAnsys internal only: Build the docs with the latest container from Github:\nBuild documentation" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_GLOBAL_LAYER_IN_STACK", - "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_GLOBAL_LAYER_IN_STACK.html#max_global_layer_in_stack", - "title": "MAX_GLOBAL_LAYER_IN_STACK", - "section": "MAX_GLOBAL_LAYER_IN_STACK", - "text": "MAX_GLOBAL_LAYER_IN_STACK" + "objectID": "contribute", + "href": "contribute.html#run-style-checks", + "title": "Contribute > Run style checks", + "section": "Run style checks", + "text": "The style checks use pre-commit and can be run through tox:\nThe style checks can also be configured to run automatically before each git commit:\nRun style checks\ngit commit" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_GLOBAL_LAYER_IN_STACK", - "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_GLOBAL_LAYER_IN_STACK.html#ansys.dpf.composites.constants.FailureOutput.MAX_GLOBAL_LAYER_IN_STACK", - "title": "MAX_GLOBAL_LAYER_IN_STACK > MAX_GLOBAL_LAYER_IN_STACK > MAX_GLOBAL_LAYER_IN_STACK", - "section": "MAX_GLOBAL_LAYER_IN_STACK > MAX_GLOBAL_LAYER_IN_STACK", - "text": "FailureOutput.MAX_GLOBAL_LAYER_IN_STACK = 5\n\n" + "objectID": "contribute", + "href": "contribute.html#view-documentation", + "title": "Contribute > View documentation", + "section": "View documentation", + "text": "Documentation for the latest stable release of PyDPF - Composites is hosted at\nPyDPF - Composites Documentation.\nIn the upper right corner of the documentation’s title bar, there is an option\nfor switching from viewing the documentation for the latest stable release\nto viewing the documentation for the development version or previously\nreleased versions.\nView documentation" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.index", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.index.html#index", - "title": "index", - "section": "index", - "text": "Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end].\nOptional arguments start and end are interpreted as in slice notation.\nRaises ValueError when the substring is not found.\nindex" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.name.html#name", + "title": "name", + "section": "name", + "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.index", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.index.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.index", - "title": "index > index > index", - "section": "index > index", - "text": "FailureMeasureEnum.index(sub, [start, [end]], /)\n\nReturn the lowest index in S where substring sub is found, such that sub is contained within S[start:end].\n\nOptional arguments start and end are interpreted as in slice notation.\nRaises ValueError when the substring is not found.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.name.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.name", + "title": "name > name > name", + "section": "name > name", + "text": "property MaxStrainCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Specific_Heat_cp", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Specific_Heat_cp.html#specific_heat_cp", - "title": "Specific_Heat_cp", - "section": "Specific_Heat_cp", - "text": "Specific_Heat_cp" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kf.html#kf", + "title": "kf", + "section": "kf", + "text": "Weighting factor of the face sheets for evaluation of the maximum allowable load. The default is 0 so the face sheet does not contribute to the allowable load. This property is valid for thin face sheets.\nfloat\nkf\n0\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Specific_Heat_cp", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Specific_Heat_cp.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Specific_Heat_cp", - "title": "Specific_Heat_cp > Specific_Heat_cp > Specific_Heat_cp", - "section": "Specific_Heat_cp > Specific_Heat_cp", - "text": "MaterialProperty.Specific_Heat_cp: str = 'specific_heat'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kf.html#ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kf", + "title": "kf > kf > kf", + "section": "kf > kf", + "text": "property ShearCrimpingCriterion.kf: float\n\nWeighting factor of the face sheets for evaluation of the maximum allowable load. The default is 0 so the face sheet does not contribute to the allowable load. This property is valid for thin face sheets.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Spot.TOP", - "href": "api/_autosummary/ansys.dpf.composites.constants.Spot.TOP.html#top", - "title": "TOP", - "section": "TOP", - "text": "TOP" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tensile_Yield_Strength_effective_stress", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tensile_Yield_Strength_effective_stress.html#tensile_yield_strength_effective_stress", + "title": "Tensile_Yield_Strength_effective_stress", + "section": "Tensile_Yield_Strength_effective_stress", + "text": "Tensile_Yield_Strength_effective_stress" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Spot.TOP", - "href": "api/_autosummary/ansys.dpf.composites.constants.Spot.TOP.html#ansys.dpf.composites.constants.Spot.TOP", - "title": "TOP > TOP > TOP", - "section": "TOP > TOP", - "text": "Spot.TOP = 3\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tensile_Yield_Strength_effective_stress", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tensile_Yield_Strength_effective_stress.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tensile_Yield_Strength_effective_stress", + "title": "Tensile_Yield_Strength_effective_stress > Tensile_Yield_Strength_effective_stress > Tensile_Yield_Strength_effective_stress", + "section": "Tensile_Yield_Strength_effective_stress > Tensile_Yield_Strength_effective_stress", + "text": "MaterialProperty.Tensile_Yield_Strength_effective_stress: str = 'tensile_yield_strength'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zc", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zc.html#stress_limits_zc", - "title": "Stress_Limits_Zc", - "section": "Stress_Limits_Zc", - "text": "Stress_Limits_Zc" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_dict.html#to_dict", + "title": "to_dict", + "section": "to_dict", + "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zc", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zc.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zc", - "title": "Stress_Limits_Zc > Stress_Limits_Zc > Stress_Limits_Zc", - "section": "Stress_Limits_Zc > Stress_Limits_Zc", - "text": "MaterialProperty.Stress_Limits_Zc: str = 'stress_compressive_z_direction'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_dict", + "title": "to_dict > to_dict > to_dict", + "section": "to_dict > to_dict", + "text": "CoreFailureCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZt", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZt.html#strain_limits_ezt", - "title": "Strain_Limits_eZt", - "section": "Strain_Limits_eZt", - "text": "Strain_Limits_eZt" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.rst", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.rst.html#rst", + "title": "rst", + "section": "rst", + "text": "rst" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZt", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZt.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZt", - "title": "Strain_Limits_eZt > Strain_Limits_eZt > Strain_Limits_eZt", - "section": "Strain_Limits_eZt > Strain_Limits_eZt", - "text": "MaterialProperty.Strain_Limits_eZt: str = 'strain_tensile_z_direction'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.rst", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.rst.html#ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.rst", + "title": "rst > rst > rst", + "section": "rst > rst", + "text": "ContinuousFiberCompositesFiles.rst: list[str | PathLike[str]]\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.html#failureresult", - "title": "FailureResult", - "section": "FailureResult", - "text": "Provides the components of a failure result.\nFailureResult.mode\n\nFailureResult.inverse_reserve_factor\n\nFailureResult.safety_factor\n\nFailureResult.safety_margin\n\nFailureResult\nFailureResult.mode\nFailureResult.inverse_reserve_factor\nFailureResult.safety_factor\nFailureResult.safety_margin" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_json.html#to_json", + "title": "to_json", + "section": "to_json", + "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.html#ansys.dpf.composites.sampling_point.FailureResult", - "title": "FailureResult > FailureResult > FailureResult", - "section": "FailureResult > FailureResult", - "text": "class ansys.dpf.composites.sampling_point.FailureResult(mode, inverse_reserve_factor, safety_factor, safety_margin)\n\nProvides the components of a failure result.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nFailureResult.mode\n\n\n\nFailureResult.inverse_reserve_factor\n\n\n\nFailureResult.safety_factor\n\n\n\nFailureResult.safety_margin\n\n\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_json.html#ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_json", + "title": "to_json > to_json > to_json", + "section": "to_json > to_json", + "text": "FaceSheetWrinklingCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" }, { "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.wb", @@ -5600,179 +5621,144 @@ "text": "FailureModeEnum.wb = 321\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pma", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pma.html#wf_pma", - "title": "wf_pma", - "section": "wf_pma", - "text": "Weighting factor of the matrix failure (pma) mode.\nfloat\nwf_pma\nfloat" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pma", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pma.html#ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pma", - "title": "wf_pma > wf_pma > wf_pma", - "section": "wf_pma > wf_pma", - "text": "property PuckCriterion.wf_pma: float\n\nWeighting factor of the matrix failure (pma) mode.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.html#layuppropertiesprovider", - "title": "LayupPropertiesProvider", - "section": "LayupPropertiesProvider", - "text": "Provider for lay-up properties.\nSome properties such as layered dpf_material_ids and\ninformation about the element type are available\nthrough the ElementInfoProvider.\nlayup_provider (Operator) – Use add_layup_info_to_mesh() to obtain a lay-up provider.\nmesh (MeshedRegion)\nLayupPropertiesProvider.get_analysis_plies(...)\nGet analysis ply names.\nLayupPropertiesProvider.get_element_laminate_offset(...)\nGet laminate offset of element.\nLayupPropertiesProvider.get_layer_angles(...)\nGet angles for all layers.\nLayupPropertiesProvider.get_layer_shear_angles(...)\nGet shear angle for all layers.\nLayupPropertiesProvider.get_layer_thicknesses(...)\nGet thicknesses for all layers.\nLayupPropertiesProvider\nElementInfoProvider\nOperator\nadd_layup_info_to_mesh()\nMeshedRegion\nLayupPropertiesProvider.get_analysis_plies\nLayupPropertiesProvider.get_element_laminate_offset\nLayupPropertiesProvider.get_layer_angles\nLayupPropertiesProvider.get_layer_shear_angles\nLayupPropertiesProvider.get_layer_thicknesses" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.html#ansys.dpf.composites.layup_info.LayupPropertiesProvider", - "title": "LayupPropertiesProvider > LayupPropertiesProvider > LayupPropertiesProvider", - "section": "LayupPropertiesProvider > LayupPropertiesProvider", - "text": "class ansys.dpf.composites.layup_info.LayupPropertiesProvider(layup_provider, mesh)\n\nProvider for lay-up properties.\n\nSome properties such as layered dpf_material_ids and\ninformation about the element type are available\nthrough the ElementInfoProvider.\n\nParameters\n\nlayup_provider (Operator) – Use add_layup_info_to_mesh() to obtain a lay-up provider.\n\nmesh (MeshedRegion)\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nLayupPropertiesProvider.get_analysis_plies(...)\n\nGet analysis ply names.\n\nLayupPropertiesProvider.get_element_laminate_offset(...)\n\nGet laminate offset of element.\n\nLayupPropertiesProvider.get_layer_angles(...)\n\nGet angles for all layers.\n\nLayupPropertiesProvider.get_layer_shear_angles(...)\n\nGet shear angle for all layers.\n\nLayupPropertiesProvider.get_layer_thicknesses(...)\n\nGet thicknesses for all layers.\n\n" - }, - { - "objectID": "sg_execution_times", - "href": "sg_execution_times.html#computation-times", - "title": "Computation times", - "section": "Computation times", - "text": "01:20.085 total execution time for 15 files from all galleries:\nExample\nTime\nMem (MB)\nsphx_glr_examples_gallery_examples_001_failure_operator_example.py (../../examples/001_failure_operator_example.py)\n00:11.642\n0.0\nsphx_glr_examples_gallery_examples_010_harmonic_example.py (../../examples/010_harmonic_example.py)\n00:10.117\n0.0\nsphx_glr_examples_gallery_examples_007_interlaminar_normal_stress_example.py (../../examples/007_interlaminar_normal_stress_example.py)\n00:07.347\n0.0\nsphx_glr_examples_gallery_examples_009_short_fiber_orientation_tensor.py (../../examples/009_short_fiber_orientation_tensor.py)\n00:05.877\n0.0\nsphx_glr_examples_gallery_examples_014_cyclic_symmetry_example.py (../../examples/014_cyclic_symmetry_example.py)\n00:05.728\n0.0\nsphx_glr_examples_gallery_examples_011_rst_workflow.py (../../examples/011_rst_workflow.py)\n00:05.110\n0.0\nsphx_glr_examples_gallery_examples_002_sampling_point_example.py (../../examples/002_sampling_point_example.py)\n00:04.837\n0.0\nsphx_glr_examples_gallery_examples_006_filter_composite_data_example.py (../../examples/006_filter_composite_data_example.py)\n00:04.682\n0.0\nsphx_glr_examples_gallery_examples_013_thermal_example.py (../../examples/013_thermal_example.py)\n00:04.427\n0.0\nsphx_glr_examples_gallery_examples_099_dpf_composite_failure_workflow.py (../../examples/099_dpf_composite_failure_workflow.py)\n00:04.414\n0.0\nsphx_glr_examples_gallery_examples_008_assembly_example.py (../../examples/008_assembly_example.py)\n00:04.157\n0.0\nsphx_glr_examples_gallery_examples_012_fatigue_example.py (../../examples/012_fatigue_example.py)\n00:03.564\n0.0\nsphx_glr_examples_gallery_examples_004_get_material_properties_example.py (../../examples/004_get_material_properties_example.py)\n00:03.523\n0.0\nsphx_glr_examples_gallery_examples_003_short_fiber_example.py (../../examples/003_short_fiber_example.py)\n00:03.262\n0.0\nsphx_glr_examples_gallery_examples_005_get_layup_properties_example.py (../../examples/005_get_layup_properties_example.py)\n00:01.399\n0.0\nComputation times\n../../examples/001_failure_operator_example.py\n../../examples/010_harmonic_example.py\n../../examples/007_interlaminar_normal_stress_example.py\n../../examples/009_short_fiber_orientation_tensor.py\n../../examples/014_cyclic_symmetry_example.py\n../../examples/011_rst_workflow.py\n../../examples/002_sampling_point_example.py\n../../examples/006_filter_composite_data_example.py\n../../examples/013_thermal_example.py\n../../examples/099_dpf_composite_failure_workflow.py\n../../examples/008_assembly_example.py\n../../examples/012_fatigue_example.py\n../../examples/004_get_material_properties_example.py\n../../examples/003_short_fiber_example.py\n../../examples/005_get_layup_properties_example.py" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3t", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3t.html#s3t", - "title": "s3t", - "section": "s3t", - "text": "s3t" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.add_ply_sequence_to_plot", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.add_ply_sequence_to_plot.html#add_ply_sequence_to_plot", + "title": "add_ply_sequence_to_plot", + "section": "add_ply_sequence_to_plot", + "text": "Add the stacking (ply and text) to an axis or plot.\naxes (Any) – Matplotlib Axes object.\ncore_scale_factor (float, default: 1.0) – Factor for scaling the thickness of core plies.\nNone\nadd_ply_sequence_to_plot\nAny\nAxes\nfloat\n1.0\nNone" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3t", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3t.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s3t", - "title": "s3t > s3t > s3t", - "section": "s3t > s3t", - "text": "FailureModeEnum.s3t = 231\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.add_ply_sequence_to_plot", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.add_ply_sequence_to_plot.html#ansys.dpf.composites.sampling_point.SamplingPoint.add_ply_sequence_to_plot", + "title": "add_ply_sequence_to_plot > add_ply_sequence_to_plot > add_ply_sequence_to_plot", + "section": "add_ply_sequence_to_plot > add_ply_sequence_to_plot", + "text": "SamplingPoint.add_ply_sequence_to_plot(axes, core_scale_factor=1.0)\n\nAdd the stacking (ply and text) to an axis or plot.\n\nParameters\n\naxes (Any) – Matplotlib Axes object.\n\ncore_scale_factor (float, default: 1.0) – Factor for scaling the thickness of core plies.\n\nReturn type\n\nNone\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_json.html#to_json", - "title": "to_json", - "section": "to_json", - "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.w", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.w.html#w", + "title": "w", + "section": "w", + "text": "w" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_json.html#ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_json", - "title": "to_json > to_json > to_json", - "section": "to_json > to_json", - "text": "CoreFailureCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.w", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.w.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.w", + "title": "w > w > w", + "section": "w > w", + "text": "FailureModeEnum.w = 320\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.get_element_info_provider", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.get_element_info_provider.html#get_element_info_provider", - "title": "get_element_info_provider", - "section": "get_element_info_provider", - "text": "Get ElementInfoProvider Object.\nmesh (MeshedRegion)\nstream_provider_or_data_source (Operator | DataSources) – dpf stream provider or dpf data source\nmaterial_provider (Optional[Operator], default: None) – DPF operator that provides material information.\nno_bounds_checks (bool, default: False) – Disable bounds checks. Improves\nperformance but can result in cryptic error messages\nElementInfoProvider\nEither a data_source or a stream_provider is required\nget_element_info_provider\nElementInfoProvider\nMeshedRegion\nOperator\nDataSources\nOptional\nOperator\nNone\nbool\nFalse" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e2", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e2.html#e2", + "title": "e2", + "section": "e2", + "text": "Activates the failure evaluation regarding the strain in the material 2 direction.\nbool\ne2\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.get_element_info_provider", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.get_element_info_provider.html#ansys.dpf.composites.layup_info.get_element_info_provider", - "title": "get_element_info_provider > get_element_info_provider > get_element_info_provider", - "section": "get_element_info_provider > get_element_info_provider", - "text": "ansys.dpf.composites.layup_info.get_element_info_provider(mesh, stream_provider_or_data_source, material_provider=None, no_bounds_checks=False)\n\nGet ElementInfoProvider Object.\n\nParameters\n\nmesh (MeshedRegion)\n\nstream_provider_or_data_source (Operator | DataSources) – dpf stream provider or dpf data source\n\nmaterial_provider (Optional[Operator], default: None) – DPF operator that provides material information.\n\nno_bounds_checks (bool, default: False) – Disable bounds checks. Improves\nperformance but can result in cryptic error messages\n\nReturn type\n\nElementInfoProvider\n\nNotes\n\nEither a data_source or a stream_provider is required\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e2", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e2.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e2", + "title": "e2 > e2 > e2", + "section": "e2 > e2", + "text": "property MaxStrainCriterion.e2: bool\n\nActivates the failure evaluation regarding the strain in the material 2 direction.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.html#materialproperty", - "title": "MaterialProperty", - "section": "MaterialProperty", - "text": "Provides the material properties that are available.\nMaterialProperty.Engineering_Constants_E1\n\nMaterialProperty.Engineering_Constants_E2\n\nMaterialProperty.Engineering_Constants_E3\n\nMaterialProperty.Engineering_Constants_E\n\nMaterialProperty.Engineering_Constants_G12\n\nMaterialProperty.Engineering_Constants_G23\n\nMaterialProperty.Engineering_Constants_G13\n\nMaterialProperty.Engineering_Constants_nu12\n\nMaterialProperty.Engineering_Constants_nu23\n\nMaterialProperty.Engineering_Constants_nu13\n\nMaterialProperty.Engineering_Constants_nu\n\nMaterialProperty.Strain_Limits_effective_strain\n\nMaterialProperty.Tensile_Yield_Strength_effective_stress\n\nMaterialProperty.Strain_Limits_eXt\n\nMaterialProperty.Strain_Limits_eYt\n\nMaterialProperty.Strain_Limits_eZt\n\nMaterialProperty.Strain_Limits_eXc\n\nMaterialProperty.Strain_Limits_eYc\n\nMaterialProperty.Strain_Limits_eZc\n\nMaterialProperty.Strain_Limits_eSxy\n\nMaterialProperty.Strain_Limits_eSyz\n\nMaterialProperty.Strain_Limits_eSxz\n\nMaterialProperty.Stress_Limits_Xt\n\nMaterialProperty.Stress_Limits_Yt\n\nMaterialProperty.Stress_Limits_Zt\n\nMaterialProperty.Stress_Limits_Xc\n\nMaterialProperty.Stress_Limits_Yc\n\nMaterialProperty.Stress_Limits_Zc\n\nMaterialProperty.Stress_Limits_Sxy\n\nMaterialProperty.Stress_Limits_Syz\n\nMaterialProperty.Stress_Limits_Sxz\n\nMaterialProperty.Thermal_Conductivity_K\n\nMaterialProperty.Thermal_Conductivity_K1\n\nMaterialProperty.Thermal_Conductivity_K2\n\nMaterialProperty.Thermal_Conductivity_K3\n\nMaterialProperty.Specific_Heat_cp\n\nMaterialProperty.Thermal_Expansion_Coefficients_a\n\nMaterialProperty.Thermal_Expansion_Coefficients_aX\n\nMaterialProperty.Thermal_Expansion_Coefficients_aY\n\nMaterialProperty.Thermal_Expansion_Coefficients_aZ\n\nMaterialProperty.Fabric_Fiber_Angle_phi\n\nMaterialProperty.Hill_Yield_Criterion_R11\n\nMaterialProperty.Hill_Yield_Criterion_R22\n\nMaterialProperty.Hill_Yield_Criterion_R33\n\nMaterialProperty.Hill_Yield_Criterion_R12\n\nMaterialProperty.Hill_Yield_Criterion_R23\n\nMaterialProperty.Hill_Yield_Criterion_R13\n\nMaterialProperty.Tsai_Wu_Constant_xy\n\nMaterialProperty.Tsai_Wu_Constant_yz\n\nMaterialProperty.Tsai_Wu_Constant_xz\n\nMaterialProperty.Puck_Constants_p_21_pos\n\nMaterialProperty.Puck_Constants_p_21_neg\n\nMaterialProperty.Puck_Constants_p_22_pos\n\nMaterialProperty.Puck_Constants_p_22_neg\n\nMaterialProperty.Puck_Constants_s\n\nMaterialProperty.Puck_Constants_m\n\nMaterialProperty.Puck_Constants_interface_weakening_factor\n\nMaterialProperty.Larc_Constants_fracture_angle_under_compression\n\nMaterialProperty.Larc_Constants_fracture_toughness_ratio\n\nMaterialProperty.Larc_Constants_fracture_toughness_mode_1\n\nMaterialProperty.Larc_Constants_fracture_toughness_mode_2\n\nMaterialProperty\nMaterialProperty.Engineering_Constants_E1\nMaterialProperty.Engineering_Constants_E2\nMaterialProperty.Engineering_Constants_E3\nMaterialProperty.Engineering_Constants_E\nMaterialProperty.Engineering_Constants_G12\nMaterialProperty.Engineering_Constants_G23\nMaterialProperty.Engineering_Constants_G13\nMaterialProperty.Engineering_Constants_nu12\nMaterialProperty.Engineering_Constants_nu23\nMaterialProperty.Engineering_Constants_nu13\nMaterialProperty.Engineering_Constants_nu\nMaterialProperty.Strain_Limits_effective_strain\nMaterialProperty.Tensile_Yield_Strength_effective_stress\nMaterialProperty.Strain_Limits_eXt\nMaterialProperty.Strain_Limits_eYt\nMaterialProperty.Strain_Limits_eZt\nMaterialProperty.Strain_Limits_eXc\nMaterialProperty.Strain_Limits_eYc\nMaterialProperty.Strain_Limits_eZc\nMaterialProperty.Strain_Limits_eSxy\nMaterialProperty.Strain_Limits_eSyz\nMaterialProperty.Strain_Limits_eSxz\nMaterialProperty.Stress_Limits_Xt\nMaterialProperty.Stress_Limits_Yt\nMaterialProperty.Stress_Limits_Zt\nMaterialProperty.Stress_Limits_Xc\nMaterialProperty.Stress_Limits_Yc\nMaterialProperty.Stress_Limits_Zc\nMaterialProperty.Stress_Limits_Sxy\nMaterialProperty.Stress_Limits_Syz\nMaterialProperty.Stress_Limits_Sxz\nMaterialProperty.Thermal_Conductivity_K\nMaterialProperty.Thermal_Conductivity_K1\nMaterialProperty.Thermal_Conductivity_K2\nMaterialProperty.Thermal_Conductivity_K3\nMaterialProperty.Specific_Heat_cp\nMaterialProperty.Thermal_Expansion_Coefficients_a\nMaterialProperty.Thermal_Expansion_Coefficients_aX\nMaterialProperty.Thermal_Expansion_Coefficients_aY\nMaterialProperty.Thermal_Expansion_Coefficients_aZ\nMaterialProperty.Fabric_Fiber_Angle_phi\nMaterialProperty.Hill_Yield_Criterion_R11\nMaterialProperty.Hill_Yield_Criterion_R22\nMaterialProperty.Hill_Yield_Criterion_R33\nMaterialProperty.Hill_Yield_Criterion_R12\nMaterialProperty.Hill_Yield_Criterion_R23\nMaterialProperty.Hill_Yield_Criterion_R13\nMaterialProperty.Tsai_Wu_Constant_xy\nMaterialProperty.Tsai_Wu_Constant_yz\nMaterialProperty.Tsai_Wu_Constant_xz\nMaterialProperty.Puck_Constants_p_21_pos\nMaterialProperty.Puck_Constants_p_21_neg\nMaterialProperty.Puck_Constants_p_22_pos\nMaterialProperty.Puck_Constants_p_22_neg\nMaterialProperty.Puck_Constants_s\nMaterialProperty.Puck_Constants_m\nMaterialProperty.Puck_Constants_interface_weakening_factor\nMaterialProperty.Larc_Constants_fracture_angle_under_compression\nMaterialProperty.Larc_Constants_fracture_toughness_ratio\nMaterialProperty.Larc_Constants_fracture_toughness_mode_1\nMaterialProperty.Larc_Constants_fracture_toughness_mode_2" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.active.html#active", + "title": "active", + "section": "active", + "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty", - "title": "MaterialProperty > MaterialProperty > MaterialProperty", - "section": "MaterialProperty > MaterialProperty", - "text": "class ansys.dpf.composites.layup_info.material_properties.MaterialProperty(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nProvides the material properties that are available.\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nMaterialProperty.Engineering_Constants_E1\n\n\n\nMaterialProperty.Engineering_Constants_E2\n\n\n\nMaterialProperty.Engineering_Constants_E3\n\n\n\nMaterialProperty.Engineering_Constants_E\n\n\n\nMaterialProperty.Engineering_Constants_G12\n\n\n\nMaterialProperty.Engineering_Constants_G23\n\n\n\nMaterialProperty.Engineering_Constants_G13\n\n\n\nMaterialProperty.Engineering_Constants_nu12\n\n\n\nMaterialProperty.Engineering_Constants_nu23\n\n\n\nMaterialProperty.Engineering_Constants_nu13\n\n\n\nMaterialProperty.Engineering_Constants_nu\n\n\n\nMaterialProperty.Strain_Limits_effective_strain\n\n\n\nMaterialProperty.Tensile_Yield_Strength_effective_stress\n\n\n\nMaterialProperty.Strain_Limits_eXt\n\n\n\nMaterialProperty.Strain_Limits_eYt\n\n\n\nMaterialProperty.Strain_Limits_eZt\n\n\n\nMaterialProperty.Strain_Limits_eXc\n\n\n\nMaterialProperty.Strain_Limits_eYc\n\n\n\nMaterialProperty.Strain_Limits_eZc\n\n\n\nMaterialProperty.Strain_Limits_eSxy\n\n\n\nMaterialProperty.Strain_Limits_eSyz\n\n\n\nMaterialProperty.Strain_Limits_eSxz\n\n\n\nMaterialProperty.Stress_Limits_Xt\n\n\n\nMaterialProperty.Stress_Limits_Yt\n\n\n\nMaterialProperty.Stress_Limits_Zt\n\n\n\nMaterialProperty.Stress_Limits_Xc\n\n\n\nMaterialProperty.Stress_Limits_Yc\n\n\n\nMaterialProperty.Stress_Limits_Zc\n\n\n\nMaterialProperty.Stress_Limits_Sxy\n\n\n\nMaterialProperty.Stress_Limits_Syz\n\n\n\nMaterialProperty.Stress_Limits_Sxz\n\n\n\nMaterialProperty.Thermal_Conductivity_K\n\n\n\nMaterialProperty.Thermal_Conductivity_K1\n\n\n\nMaterialProperty.Thermal_Conductivity_K2\n\n\n\nMaterialProperty.Thermal_Conductivity_K3\n\n\n\nMaterialProperty.Specific_Heat_cp\n\n\n\nMaterialProperty.Thermal_Expansion_Coefficients_a\n\n\n\nMaterialProperty.Thermal_Expansion_Coefficients_aX\n\n\n\nMaterialProperty.Thermal_Expansion_Coefficients_aY\n\n\n\nMaterialProperty.Thermal_Expansion_Coefficients_aZ\n\n\n\nMaterialProperty.Fabric_Fiber_Angle_phi\n\n\n\nMaterialProperty.Hill_Yield_Criterion_R11\n\n\n\nMaterialProperty.Hill_Yield_Criterion_R22\n\n\n\nMaterialProperty.Hill_Yield_Criterion_R33\n\n\n\nMaterialProperty.Hill_Yield_Criterion_R12\n\n\n\nMaterialProperty.Hill_Yield_Criterion_R23\n\n\n\nMaterialProperty.Hill_Yield_Criterion_R13\n\n\n\nMaterialProperty.Tsai_Wu_Constant_xy\n\n\n\nMaterialProperty.Tsai_Wu_Constant_yz\n\n\n\nMaterialProperty.Tsai_Wu_Constant_xz\n\n\n\nMaterialProperty.Puck_Constants_p_21_pos\n\n\n\nMaterialProperty.Puck_Constants_p_21_neg\n\n\n\nMaterialProperty.Puck_Constants_p_22_pos\n\n\n\nMaterialProperty.Puck_Constants_p_22_neg\n\n\n\nMaterialProperty.Puck_Constants_s\n\n\n\nMaterialProperty.Puck_Constants_m\n\n\n\nMaterialProperty.Puck_Constants_interface_weakening_factor\n\n\n\nMaterialProperty.Larc_Constants_fracture_angle_under_compression\n\n\n\nMaterialProperty.Larc_Constants_fracture_toughness_ratio\n\n\n\nMaterialProperty.Larc_Constants_fracture_toughness_mode_1\n\n\n\nMaterialProperty.Larc_Constants_fracture_toughness_mode_2\n\n\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.active.html#ansys.dpf.composites.failure_criteria.TsaiHillCriterion.active", + "title": "active > active > active", + "section": "active > active", + "text": "property TsaiHillCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.html#layerproperty", - "title": "LayerProperty", - "section": "LayerProperty", - "text": "Provides the layer properties available.\nLayerProperty.THICKNESSES\n\nLayerProperty.ANGLES\n\nLayerProperty.SHEAR_ANGLES\n\nLayerProperty\nLayerProperty.THICKNESSES\nLayerProperty.ANGLES\nLayerProperty.SHEAR_ANGLES" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_a", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_a.html#thermal_expansion_coefficients_a", + "title": "Thermal_Expansion_Coefficients_a", + "section": "Thermal_Expansion_Coefficients_a", + "text": "Thermal_Expansion_Coefficients_a" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.html#ansys.dpf.composites.layup_info.LayerProperty", - "title": "LayerProperty > LayerProperty > LayerProperty", - "section": "LayerProperty > LayerProperty", - "text": "class ansys.dpf.composites.layup_info.LayerProperty(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nProvides the layer properties available.\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nLayerProperty.THICKNESSES\n\n\n\nLayerProperty.ANGLES\n\n\n\nLayerProperty.SHEAR_ANGLES\n\n\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_a", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_a.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_a", + "title": "Thermal_Expansion_Coefficients_a > Thermal_Expansion_Coefficients_a > Thermal_Expansion_Coefficients_a", + "section": "Thermal_Expansion_Coefficients_a > Thermal_Expansion_Coefficients_a", + "text": "MaterialProperty.Thermal_Expansion_Coefficients_a: str = 'coefficient_thermal_expansion'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.wf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.wf.html#wf", - "title": "wf", - "section": "wf", - "text": "Weighting factor of the failure mode (wb or wt). The default is 0.5.\nfloat\nwf\n0.5\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_GLOBAL_LAYER_IN_STACK", + "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_GLOBAL_LAYER_IN_STACK.html#max_global_layer_in_stack", + "title": "MAX_GLOBAL_LAYER_IN_STACK", + "section": "MAX_GLOBAL_LAYER_IN_STACK", + "text": "MAX_GLOBAL_LAYER_IN_STACK" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.wf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.wf.html#ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.wf", - "title": "wf > wf > wf", - "section": "wf > wf", - "text": "property FaceSheetWrinklingCriterion.wf: float\n\nWeighting factor of the failure mode (wb or wt). The default is 0.5.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_GLOBAL_LAYER_IN_STACK", + "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.MAX_GLOBAL_LAYER_IN_STACK.html#ansys.dpf.composites.constants.FailureOutput.MAX_GLOBAL_LAYER_IN_STACK", + "title": "MAX_GLOBAL_LAYER_IN_STACK > MAX_GLOBAL_LAYER_IN_STACK > MAX_GLOBAL_LAYER_IN_STACK", + "section": "MAX_GLOBAL_LAYER_IN_STACK > MAX_GLOBAL_LAYER_IN_STACK", + "text": "FailureOutput.MAX_GLOBAL_LAYER_IN_STACK = 5\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s3", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s3.html#s3", - "title": "s3", - "section": "s3", - "text": "Stresses in the material 3 direction of each ply.\nndarray[Any, dtype[float64]]\ns3\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_ply_wise_critical_failures", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_ply_wise_critical_failures.html#get_ply_wise_critical_failures", + "title": "get_ply_wise_critical_failures", + "section": "get_ply_wise_critical_failures", + "text": "Get the critical failure value and modes per ply.\nlist[FailureResult]\nget_ply_wise_critical_failures\nlist\nFailureResult" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s3", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s3.html#ansys.dpf.composites.sampling_point.SamplingPoint.s3", - "title": "s3 > s3 > s3", - "section": "s3 > s3", - "text": "property SamplingPoint.s3: ndarray[Any, dtype[float64]]\n\nStresses in the material 3 direction of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_ply_wise_critical_failures", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_ply_wise_critical_failures.html#ansys.dpf.composites.sampling_point.SamplingPoint.get_ply_wise_critical_failures", + "title": "get_ply_wise_critical_failures > get_ply_wise_critical_failures > get_ply_wise_critical_failures", + "section": "get_ply_wise_critical_failures > get_ply_wise_critical_failures", + "text": "SamplingPoint.get_ply_wise_critical_failures()\n\nGet the critical failure value and modes per ply.\n\nReturn type\n\nlist[FailureResult]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.active.html#active", - "title": "active", - "section": "active", - "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e23", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e23.html#e23", + "title": "e23", + "section": "e23", + "text": "e23" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.active.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.active", - "title": "active > active > active", - "section": "active > active", - "text": "property MaxStressCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e23", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e23.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e23", + "title": "e23 > e23 > e23", + "section": "e23 > e23", + "text": "FailureModeEnum.e23 = 160\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.number_of_plies", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.number_of_plies.html#number_of_plies", - "title": "number_of_plies", - "section": "number_of_plies", - "text": "Number of plies.\nint\nnumber_of_plies\nint" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_files", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_files.html#composite_files", + "title": "composite_files", + "section": "composite_files", + "text": "Get the composite file paths on the server.\nContinuousFiberCompositesFiles\ncomposite_files\nContinuousFiberCompositesFiles" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.number_of_plies", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.number_of_plies.html#ansys.dpf.composites.sampling_point.SamplingPoint.number_of_plies", - "title": "number_of_plies > number_of_plies > number_of_plies", - "section": "number_of_plies > number_of_plies", - "text": "property SamplingPoint.number_of_plies: int\n\nNumber of plies.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_files", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.composite_files.html#ansys.dpf.composites.composite_model.CompositeModel.composite_files", + "title": "composite_files > composite_files > composite_files", + "section": "composite_files > composite_files", + "text": "property CompositeModel.composite_files: ContinuousFiberCompositesFiles\n\nGet the composite file paths on the server.\n\nReturn type\n\nContinuousFiberCompositesFiles\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.solver_material_id", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.solver_material_id.html#solver_material_id", - "title": "solver_material_id", - "section": "solver_material_id", - "text": "solver_material_id" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.html#samplingpointfigure", + "title": "SamplingPointFigure", + "section": "SamplingPointFigure", + "text": "Provides the sampling point figure and axes.\nSamplingPointFigure.figure\n\nSamplingPointFigure.axes\n\nSamplingPointFigure\nSamplingPointFigure.figure\nSamplingPointFigure.axes" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.solver_material_id", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.solver_material_id.html#ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.solver_material_id", - "title": "solver_material_id > solver_material_id > solver_material_id", - "section": "solver_material_id > solver_material_id", - "text": "MaterialMetadata.solver_material_id: int | None = None\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.html#ansys.dpf.composites.sampling_point.SamplingPointFigure", + "title": "SamplingPointFigure > SamplingPointFigure > SamplingPointFigure", + "section": "SamplingPointFigure > SamplingPointFigure", + "text": "class ansys.dpf.composites.sampling_point.SamplingPointFigure(figure, axes)\n\nProvides the sampling point figure and axes.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nSamplingPointFigure.figure\n\n\n\nSamplingPointFigure.axes\n\n\n\n" }, { "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lfc", @@ -5789,543 +5775,515 @@ "text": "property LaRCCriterion.lfc: bool\n\nWhether to activate the failure evaluation regarding compression in fiber direction.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cfc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cfc.html#wf_cfc", - "title": "wf_cfc", - "section": "wf_cfc", - "text": "Weighting factor of fiber failure due to compression (cfc).\nfloat\nwf_cfc\nfloat" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cfc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cfc.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cfc", - "title": "wf_cfc > wf_cfc > wf_cfc", - "section": "wf_cfc > wf_cfc", - "text": "property CuntzeCriterion.wf_cfc: float\n\nWeighting factor of fiber failure due to compression (cfc).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.title", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.title.html#title", - "title": "title", - "section": "title", - "text": "Return a version of the string where each word is titlecased.\nMore specifically, words start with uppercased characters and all remaining\ncased characters have lower case.\ntitle" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.title", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.title.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.title", - "title": "title > title > title", - "section": "title > title", - "text": "FailureMeasureEnum.title(/)\n\nReturn a version of the string where each word is titlecased.\n\nMore specifically, words start with uppercased characters and all remaining\ncased characters have lower case.\n\n!! processed by numpydoc !!" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.element_type", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.element_type.html#element_type", - "title": "element_type", - "section": "element_type", - "text": "element_type" - }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.element_type", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.element_type.html#ansys.dpf.composites.layup_info.ElementInfo.element_type", - "title": "element_type > element_type > element_type", - "section": "element_type > element_type", - "text": "ElementInfo.element_type: int\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.JSON_DICT_KEY", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.JSON_DICT_KEY.html#json_dict_key", + "title": "JSON_DICT_KEY", + "section": "JSON_DICT_KEY", + "text": "JSON_DICT_KEY" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.as", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.as.html#as", - "title": "as", - "section": "as", - "text": "as" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.JSON_DICT_KEY", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.JSON_DICT_KEY.html#ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.JSON_DICT_KEY", + "title": "JSON_DICT_KEY > JSON_DICT_KEY > JSON_DICT_KEY", + "section": "JSON_DICT_KEY > JSON_DICT_KEY", + "text": "CombinedFailureCriterion.JSON_DICT_KEY = 'criteria'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.as", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.as.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.as", - "title": "as > as > as", - "section": "as > as", - "text": "FailureModeEnum.as = 1201\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.html#larccriterion", + "title": "LaRCCriterion", + "section": "LaRCCriterion", + "text": "Defines the LaRC failure criterion for UD reinforced materials.\nlft (bool, default: True) – Whether to activate the failure evaluation regarding tension in fiber direction.\nlfc (bool, default: True) – Whether to activate the failure evaluation regarding compression in fiber direction.\nlmt (bool, default: True) – Whether to activate the failure evaluation of the matrix due to tension.\nlmc (bool, default: True) – Whether to activate the failure evaluation of the matrix due to compression.\ndim (int, default: 2) – Whether the 2D or 3D formulation of the criterion is used. 2D is equivalent to LaRC03, and 3D is equivalent to LaRC04.\nwf_lft (float, default: 1.0) – Weighting factor of fiber failure due to tension (lft).\nwf_lfc (float, default: 1.0) – Weighting factor of fiber failure due to compression (lfc).\nwf_lmt (float, default: 1.0) – Weighting factor of matrix failure due to tension (lmt).\nwf_lmc (float, default: 1.0) – Weighting factor of matrix failure due to compression (lmc).\nLaRCCriterion.to_dict()\n\nLaRCCriterion.to_json()\n\nLaRCCriterion.active\nThe failure criterion is suppressed if active is False.\nLaRCCriterion.dim\nWhether the 2D or 3D formulation of the criterion is used.\nLaRCCriterion.lfc\nWhether to activate the failure evaluation regarding compression in fiber direction.\nLaRCCriterion.lft\nWhether to activate the failure evaluation regarding tension in fiber direction.\nLaRCCriterion.lmc\nWhether to activate the failure evaluation of the matrix due to compression.\nLaRCCriterion.lmt\nWhether to activate the failure evaluation of the matrix due to tension.\nLaRCCriterion.name\nName of the failure criterion.\nLaRCCriterion.wf_lfc\nWeighting factor of fiber failure due to compression (lfc).\nLaRCCriterion.wf_lft\nWeighting factor of fiber failure due to tension (lft).\nLaRCCriterion.wf_lmc\nWeighting factor of matrix failure due to compression (lmc).\nLaRCCriterion.wf_lmt\nWeighting factor of matrix failure due to tension (lmt).\nLaRCCriterion\nbool\nTrue\nbool\nTrue\nbool\nTrue\nbool\nTrue\nint\n2\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nLaRCCriterion.to_dict\nLaRCCriterion.to_json\nLaRCCriterion.active\nLaRCCriterion.dim\nLaRCCriterion.lfc\nLaRCCriterion.lft\nLaRCCriterion.lmc\nLaRCCriterion.lmt\nLaRCCriterion.name\nLaRCCriterion.wf_lfc\nLaRCCriterion.wf_lft\nLaRCCriterion.wf_lmc\nLaRCCriterion.wf_lmt" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.name", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.name.html#name", - "title": "name", - "section": "name", - "text": "Custom name.\nstr\nname\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.html#ansys.dpf.composites.failure_criteria.LaRCCriterion", + "title": "LaRCCriterion > LaRCCriterion > LaRCCriterion", + "section": "LaRCCriterion > LaRCCriterion", + "text": "class ansys.dpf.composites.failure_criteria.LaRCCriterion(*, lft=True, lfc=True, lmt=True, lmc=True, dim=2, wf_lft=1.0, wf_lfc=1.0, wf_lmt=1.0, wf_lmc=1.0)\n\nDefines the LaRC failure criterion for UD reinforced materials.\n\nParameters\n\nlft (bool, default: True) – Whether to activate the failure evaluation regarding tension in fiber direction.\n\nlfc (bool, default: True) – Whether to activate the failure evaluation regarding compression in fiber direction.\n\nlmt (bool, default: True) – Whether to activate the failure evaluation of the matrix due to tension.\n\nlmc (bool, default: True) – Whether to activate the failure evaluation of the matrix due to compression.\n\ndim (int, default: 2) – Whether the 2D or 3D formulation of the criterion is used. 2D is equivalent to LaRC03, and 3D is equivalent to LaRC04.\n\nwf_lft (float, default: 1.0) – Weighting factor of fiber failure due to tension (lft).\n\nwf_lfc (float, default: 1.0) – Weighting factor of fiber failure due to compression (lfc).\n\nwf_lmt (float, default: 1.0) – Weighting factor of matrix failure due to tension (lmt).\n\nwf_lmc (float, default: 1.0) – Weighting factor of matrix failure due to compression (lmc).\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nLaRCCriterion.to_dict()\n\n\n\nLaRCCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nLaRCCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nLaRCCriterion.dim\n\nWhether the 2D or 3D formulation of the criterion is used.\n\nLaRCCriterion.lfc\n\nWhether to activate the failure evaluation regarding compression in fiber direction.\n\nLaRCCriterion.lft\n\nWhether to activate the failure evaluation regarding tension in fiber direction.\n\nLaRCCriterion.lmc\n\nWhether to activate the failure evaluation of the matrix due to compression.\n\nLaRCCriterion.lmt\n\nWhether to activate the failure evaluation of the matrix due to tension.\n\nLaRCCriterion.name\n\nName of the failure criterion.\n\nLaRCCriterion.wf_lfc\n\nWeighting factor of fiber failure due to compression (lfc).\n\nLaRCCriterion.wf_lft\n\nWeighting factor of fiber failure due to tension (lft).\n\nLaRCCriterion.wf_lmc\n\nWeighting factor of matrix failure due to compression (lmc).\n\nLaRCCriterion.wf_lmt\n\nWeighting factor of matrix failure due to tension (lmt).\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.name", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.name.html#ansys.dpf.composites.result_definition.ResultDefinition.name", - "title": "name > name > name", - "section": "name > name", - "text": "property ResultDefinition.name: str\n\nCustom name.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.html#tsaihillcriterion", + "title": "TsaiHillCriterion", + "section": "TsaiHillCriterion", + "text": "Defines the Tsai-Hill failure criterion for orthotropic reinforced materials.\nwf (float, default: 1.0) – Weighting factor of this failure criterion.\ndim (int, default: 2) – Specifies which formulation of the failure criterion is used.\nTsaiHillCriterion.to_dict()\n\nTsaiHillCriterion.to_json()\n\nTsaiHillCriterion.active\nThe failure criterion is suppressed if active is False.\nTsaiHillCriterion.dim\nSpecifies which formulation of the failure criterion is used.\nTsaiHillCriterion.name\nName of the failure criterion.\nTsaiHillCriterion.wf\nWeighting factor of this failure criterion.\nTsaiHillCriterion\nfloat\n1.0\nint\n2\nTsaiHillCriterion.to_dict\nTsaiHillCriterion.to_json\nTsaiHillCriterion.active\nTsaiHillCriterion.dim\nTsaiHillCriterion.name\nTsaiHillCriterion.wf" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXc", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXc.html#strain_limits_exc", - "title": "Strain_Limits_eXc", - "section": "Strain_Limits_eXc", - "text": "Strain_Limits_eXc" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.html#ansys.dpf.composites.failure_criteria.TsaiHillCriterion", + "title": "TsaiHillCriterion > TsaiHillCriterion > TsaiHillCriterion", + "section": "TsaiHillCriterion > TsaiHillCriterion", + "text": "class ansys.dpf.composites.failure_criteria.TsaiHillCriterion(*, active=True, wf=1.0, dim=2)\n\nDefines the Tsai-Hill failure criterion for orthotropic reinforced materials.\n\nParameters\n\nwf (float, default: 1.0) – Weighting factor of this failure criterion.\n\ndim (int, default: 2) – Specifies which formulation of the failure criterion is used.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nTsaiHillCriterion.to_dict()\n\n\n\nTsaiHillCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nTsaiHillCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nTsaiHillCriterion.dim\n\nSpecifies which formulation of the failure criterion is used.\n\nTsaiHillCriterion.name\n\nName of the failure criterion.\n\nTsaiHillCriterion.wf\n\nWeighting factor of this failure criterion.\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXc", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXc.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eXc", - "title": "Strain_Limits_eXc > Strain_Limits_eXc > Strain_Limits_eXc", - "section": "Strain_Limits_eXc > Strain_Limits_eXc", - "text": "MaterialProperty.Strain_Limits_eXc: str = 'strain_compressive_x_direction'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cfc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cfc.html#cfc", + "title": "cfc", + "section": "cfc", + "text": "Activates the failure evaluation regarding compression in fiber direction.\nbool\ncfc\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s12", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s12.html#s12", - "title": "s12", - "section": "s12", - "text": "In-plane shear stresses s12 of each ply.\nndarray[Any, dtype[float64]]\ns12\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cfc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cfc.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.cfc", + "title": "cfc > cfc > cfc", + "section": "cfc > cfc", + "text": "property CuntzeCriterion.cfc: bool\n\nActivates the failure evaluation regarding compression in fiber direction.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s12", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s12.html#ansys.dpf.composites.sampling_point.SamplingPoint.s12", - "title": "s12 > s12 > s12", - "section": "s12 > s12", - "text": "property SamplingPoint.s12: ndarray[Any, dtype[float64]]\n\nIn-plane shear stresses s12 of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.number_of_nodes_per_spot_plane", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.number_of_nodes_per_spot_plane.html#number_of_nodes_per_spot_plane", + "title": "number_of_nodes_per_spot_plane", + "section": "number_of_nodes_per_spot_plane", + "text": "number_of_nodes_per_spot_plane" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.encode", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.encode.html#encode", - "title": "encode", - "section": "encode", - "text": "Encode the string using the codec registered for encoding.\nThe encoding in which to encode the string.\nThe error handling scheme to use for encoding errors.\nThe default is ‘strict’ meaning that encoding errors raise a\nUnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and\n‘xmlcharrefreplace’ as well as any other name registered with\ncodecs.register_error that can handle UnicodeEncodeErrors.\nencode" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.number_of_nodes_per_spot_plane", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.number_of_nodes_per_spot_plane.html#ansys.dpf.composites.layup_info.ElementInfo.number_of_nodes_per_spot_plane", + "title": "number_of_nodes_per_spot_plane > number_of_nodes_per_spot_plane > number_of_nodes_per_spot_plane", + "section": "number_of_nodes_per_spot_plane > number_of_nodes_per_spot_plane", + "text": "ElementInfo.number_of_nodes_per_spot_plane: int\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.encode", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.encode.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.encode", - "title": "encode > encode > encode", - "section": "encode > encode", - "text": "FailureMeasureEnum.encode(/, encoding='utf-8', errors='strict')\n\nEncode the string using the codec registered for encoding.\n\nencoding\n\nThe encoding in which to encode the string.\n\nerrors\n\nThe error handling scheme to use for encoding errors.\nThe default is ‘strict’ meaning that encoding errors raise a\nUnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and\n‘xmlcharrefreplace’ as well as any other name registered with\ncodecs.register_error that can handle UnicodeEncodeErrors.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_json.html#to_json", + "title": "to_json", + "section": "to_json", + "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isalnum", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isalnum.html#isalnum", - "title": "isalnum", - "section": "isalnum", - "text": "Return True if the string is an alpha-numeric string, False otherwise.\nA string is alpha-numeric if all characters in the string are alpha-numeric and\nthere is at least one character in the string.\nisalnum" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_json.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_json", + "title": "to_json > to_json > to_json", + "section": "to_json > to_json", + "text": "MaxStressCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isalnum", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isalnum.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isalnum", - "title": "isalnum > isalnum > isalnum", - "section": "isalnum > isalnum", - "text": "FailureMeasureEnum.isalnum(/)\n\nReturn True if the string is an alpha-numeric string, False otherwise.\n\nA string is alpha-numeric if all characters in the string are alpha-numeric and\nthere is at least one character in the string.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.b21", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.b21.html#b21", + "title": "b21", + "section": "b21", + "text": "In-plane shear friction coefficient. The default is 0.2.\nfloat\nb21\n0.2\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.lstrip", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.lstrip.html#lstrip", - "title": "lstrip", - "section": "lstrip", - "text": "Return a copy of the string with leading whitespace removed.\nIf chars is given and not None, remove characters in chars instead.\nlstrip" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.b21", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.b21.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.b21", + "title": "b21 > b21 > b21", + "section": "b21 > b21", + "text": "property CuntzeCriterion.b21: float\n\nIn-plane shear friction coefficient. The default is 0.2.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.lstrip", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.lstrip.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.lstrip", - "title": "lstrip > lstrip > lstrip", - "section": "lstrip > lstrip", - "text": "FailureMeasureEnum.lstrip(chars=None, /)\n\nReturn a copy of the string with leading whitespace removed.\n\nIf chars is given and not None, remove characters in chars instead.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aZ", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aZ.html#thermal_expansion_coefficients_az", + "title": "Thermal_Expansion_Coefficients_aZ", + "section": "Thermal_Expansion_Coefficients_aZ", + "text": "Thermal_Expansion_Coefficients_aZ" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.server_helpers.upload_continuous_fiber_composite_files_to_server", - "href": "api/_autosummary/ansys.dpf.composites.server_helpers.upload_continuous_fiber_composite_files_to_server.html#upload_continuous_fiber_composite_files_to_server", - "title": "upload_continuous_fiber_composite_files_to_server", - "section": "upload_continuous_fiber_composite_files_to_server", - "text": "Upload continuous fiber composites files to server.\nNote: If server.local_server == True the data_files are returned unmodified.\ndata_files (ContinuousFiberCompositesFiles)\nserver (BaseServer)\nContinuousFiberCompositesFiles\nupload_continuous_fiber_composite_files_to_server\nContinuousFiberCompositesFiles\nBaseServer\nContinuousFiberCompositesFiles" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aZ", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aZ.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aZ", + "title": "Thermal_Expansion_Coefficients_aZ > Thermal_Expansion_Coefficients_aZ > Thermal_Expansion_Coefficients_aZ", + "section": "Thermal_Expansion_Coefficients_aZ > Thermal_Expansion_Coefficients_aZ", + "text": "MaterialProperty.Thermal_Expansion_Coefficients_aZ: str = 'coefficient_thermal_expansion_z'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.server_helpers.upload_continuous_fiber_composite_files_to_server", - "href": "api/_autosummary/ansys.dpf.composites.server_helpers.upload_continuous_fiber_composite_files_to_server.html#ansys.dpf.composites.server_helpers.upload_continuous_fiber_composite_files_to_server", - "title": "upload_continuous_fiber_composite_files_to_server > upload_continuous_fiber_composite_files_to_server > upload_continuous_fiber_composite_files_to_server", - "section": "upload_continuous_fiber_composite_files_to_server > upload_continuous_fiber_composite_files_to_server", - "text": "ansys.dpf.composites.server_helpers.upload_continuous_fiber_composite_files_to_server(data_files, server)\n\nUpload continuous fiber composites files to server.\n\nNote: If server.local_server == True the data_files are returned unmodified.\n\nParameters\n\ndata_files (ContinuousFiberCompositesFiles)\n\nserver (BaseServer)\n\nReturn type\n\nContinuousFiberCompositesFiles\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cf.html#cf", + "title": "cf", + "section": "cf", + "text": "cf" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.active.html#active", - "title": "active", - "section": "active", - "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cf.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.cf", + "title": "cf > cf > cf", + "section": "cf > cf", + "text": "FailureModeEnum.cf = 310\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.active.html#ansys.dpf.composites.failure_criteria.TsaiHillCriterion.active", - "title": "active > active > active", - "section": "active > active", - "text": "property TsaiHillCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmB", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmB.html#cmb", + "title": "cmB", + "section": "cmB", + "text": "cmB" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G12", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G12.html#engineering_constants_g12", - "title": "Engineering_Constants_G12", - "section": "Engineering_Constants_G12", - "text": "Engineering_Constants_G12" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmB", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmB.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.cmB", + "title": "cmB > cmB > cmB", + "section": "cmB > cmB", + "text": "FailureModeEnum.cmB = 1004\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G12", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G12.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G12", - "title": "Engineering_Constants_G12 > Engineering_Constants_G12 > Engineering_Constants_G12", - "section": "Engineering_Constants_G12 > Engineering_Constants_G12", - "text": "MaterialProperty.Engineering_Constants_G12: str = 'shear_modulus_xy'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.name.html#name", + "title": "name", + "section": "name", + "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.dim", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.dim.html#dim", - "title": "dim", - "section": "dim", - "text": "Whether the 2D or 3D formulation of the criterion is used.\nint\ndim\nint" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.name.html#ansys.dpf.composites.failure_criteria.TsaiHillCriterion.name", + "title": "name > name > name", + "section": "name > name", + "text": "property TsaiHillCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.dim", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.dim.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.dim", - "title": "dim > dim > dim", - "section": "dim > dim", - "text": "property CuntzeCriterion.dim: int\n\nWhether the 2D or 3D formulation of the criterion is used.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s3", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s3.html#wf_s3", + "title": "wf_s3", + "section": "wf_s3", + "text": "Weighting factor of the failure mode s3.\nfloat\nwf_s3\nfloat" }, { - "objectID": "examples/gallery_examples/007_interlaminar_normal_stress_example", - "href": "examples/gallery_examples/007_interlaminar_normal_stress_example.html#interlaminar-normal-stresses", - "title": "Interlaminar normal stresses", - "section": "Interlaminar normal stresses", - "text": "This example shows how to enrich the stresses of layered shells by\ncomputing interlaminar normal stresses. Interlaminar normal\nstresses can be important in thick and curved laminates.\nBecause interlaminar normal stresses are typically not available\nfor layered shell elements, the INS operator is used to recompute\nthe s3 result based on the laminate strains, the geometrical\ncurvature, and the lay-up.\nFor simple use cases, using the composite failure operator or\ncomposite sampling point operator is preferable. For examples,\nsee sphx_glr_examples_gallery_examples_001_failure_operator_example.py\nand sphx_glr_examples_gallery_examples_002_sampling_point_example.py.\nIn these workflows, interlaminar normal stresses are computed automatically\nif required, such as if a 3D failure criterion is activated. Additionally,\nsphx_glr_examples_gallery_examples_006_filter_composite_data_example.py\nshows how helper functions can be used to obtain composite result data.\nWhen using a Workbench project,\nuse the composite_files_from_workbench_harmonic_analysis()\nmethod to obtain the input files.\nInterlaminar normal stresses\nINS\ns3\ncomposite_files_from_workbench_harmonic_analysis()" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s3", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s3.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s3", + "title": "wf_s3 > wf_s3 > wf_s3", + "section": "wf_s3 > wf_s3", + "text": "property MaxStressCriterion.wf_s3: float\n\nWeighting factor of the failure mode s3.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/007_interlaminar_normal_stress_example", - "href": "examples/gallery_examples/007_interlaminar_normal_stress_example.html#set-up-analysis", - "title": "Interlaminar normal stresses > Set up analysis", - "section": "Set up analysis", - "text": "Setting up the analysis consists of loading Ansys libraries, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries.\nStart a DPF server and copy the example files into the current working directory.\nSet up analysis" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Fabric_Fiber_Angle_phi", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Fabric_Fiber_Angle_phi.html#fabric_fiber_angle_phi", + "title": "Fabric_Fiber_Angle_phi", + "section": "Fabric_Fiber_Angle_phi", + "text": "Fabric_Fiber_Angle_phi" }, { - "objectID": "examples/gallery_examples/007_interlaminar_normal_stress_example", - "href": "examples/gallery_examples/007_interlaminar_normal_stress_example.html#set-up-model-and-prepare-inputs", - "title": "Interlaminar normal stresses > Set up model and prepare inputs", - "section": "Set up model and prepare inputs", - "text": "Set up the composite model.\nPrepare the inputs for the INS operator.\nrotate_to_global is False because the postprocessing engine expects\nthe results to be in the element coordinate system (material coordinate system).\nSet up model and prepare inputs\nrotate_to_global\nFalse" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Fabric_Fiber_Angle_phi", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Fabric_Fiber_Angle_phi.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Fabric_Fiber_Angle_phi", + "title": "Fabric_Fiber_Angle_phi > Fabric_Fiber_Angle_phi > Fabric_Fiber_Angle_phi", + "section": "Fabric_Fiber_Angle_phi > Fabric_Fiber_Angle_phi", + "text": "MaterialProperty.Fabric_Fiber_Angle_phi: str = 'fabric_fiber_angle'\n\n" }, { - "objectID": "examples/gallery_examples/007_interlaminar_normal_stress_example", - "href": "examples/gallery_examples/007_interlaminar_normal_stress_example.html#compute-interlaminar-normal-stresses", - "title": "Interlaminar normal stresses > Compute interlaminar normal stresses", - "section": "Compute interlaminar normal stresses", - "text": "Compute the interlaminar normal stresses.\nThe INS operator stores the stresses in the provided stress field.\nCompute interlaminar normal stresses\nINS" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids_for_composite_definition_label", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids_for_composite_definition_label.html#get_all_layered_element_ids_for_composite_definition_label", + "title": "get_all_layered_element_ids_for_composite_definition_label", + "section": "get_all_layered_element_ids_for_composite_definition_label", + "text": "Get all layered element IDs that belong to a composite definition label.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nSequence[int]\nget_all_layered_element_ids_for_composite_definition_label\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nSequence\nint" }, { - "objectID": "examples/gallery_examples/007_interlaminar_normal_stress_example", - "href": "examples/gallery_examples/007_interlaminar_normal_stress_example.html#plot-s3-stresses", - "title": "Interlaminar normal stresses > Plot s3 stresses", - "section": "Plot s3 stresses", - "text": "Get the first stress field.\nPlot the maximum s3 of each element.\nPlot s3 at the mid-plane of a certain ply.\nTotal running time of the script: (0 minutes 7.347 seconds)\nDownload Jupyter notebook: 007_interlaminar_normal_stress_example.ipynb\nDownload Python source code: 007_interlaminar_normal_stress_example.py\nDownload zipped: 007_interlaminar_normal_stress_example.zip\nGallery generated by Sphinx-Gallery\nPlot s3 stresses\nDownload Jupyter notebook: 007_interlaminar_normal_stress_example.ipynb\nDownload Python source code: 007_interlaminar_normal_stress_example.py\nDownload zipped: 007_interlaminar_normal_stress_example.zip" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids_for_composite_definition_label", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids_for_composite_definition_label.html#ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids_for_composite_definition_label", + "title": "get_all_layered_element_ids_for_composite_definition_label > get_all_layered_element_ids_for_composite_definition_label > get_all_layered_element_ids_for_composite_definition_label", + "section": "get_all_layered_element_ids_for_composite_definition_label > get_all_layered_element_ids_for_composite_definition_label", + "text": "CompositeModel.get_all_layered_element_ids_for_composite_definition_label(composite_definition_label=None)\n\nGet all layered element IDs that belong to a composite definition label.\n\nParameters\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\n\nReturn type\n\nSequence[int]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_mesh", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_mesh.html#get_mesh", - "title": "get_mesh", - "section": "get_mesh", - "text": "Get the underlying DPF meshed region.\nThe meshed region contains the lay-up information.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nMeshedRegion\nget_mesh\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nMeshedRegion" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.get_material_operators", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.get_material_operators.html#get_material_operators", + "title": "get_material_operators", + "section": "get_material_operators", + "text": "Get material properties related to operators.\nrst_data_source (DataSources) – Data source that contains a RST file. Note that multiple (distributed)\nRST files are not supported.\nengineering_data_source (DataSources) – Data source that contains the Engineering Data file.\nunit_system (Optional[Union[UnitSystem, Operator]], default: None) – Unit System\n----------\nMaterialOperators\nget_material_operators\nDataSources\nDataSources\nOptional\nUnion\nUnitSystem\nOperator\nNone\nMaterialOperators" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_mesh", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_mesh.html#ansys.dpf.composites.composite_model.CompositeModel.get_mesh", - "title": "get_mesh > get_mesh > get_mesh", - "section": "get_mesh > get_mesh", - "text": "CompositeModel.get_mesh(composite_definition_label=None)\n\nGet the underlying DPF meshed region.\n\nThe meshed region contains the lay-up information.\n\nParameters\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\n\nReturn type\n\nMeshedRegion\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.get_material_operators", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.get_material_operators.html#ansys.dpf.composites.layup_info.material_operators.get_material_operators", + "title": "get_material_operators > get_material_operators > get_material_operators", + "section": "get_material_operators > get_material_operators", + "text": "ansys.dpf.composites.layup_info.material_operators.get_material_operators(rst_data_source, engineering_data_source, unit_system=None)\n\nGet material properties related to operators.\n\nParameters\n\nrst_data_source (DataSources) – Data source that contains a RST file. Note that multiple (distributed)\nRST files are not supported.\n\nengineering_data_source (DataSources) – Data source that contains the Engineering Data file.\n\nunit_system (Optional[Union[UnitSystem, Operator]], default: None) – Unit System\n\n----------\n\nReturn type\n\nMaterialOperators\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.html#corefailurecriterion", - "title": "CoreFailureCriterion", - "section": "CoreFailureCriterion", - "text": "Defines the core shear failure criterion for\ncore materials like foam and honeycomb.\ninclude_ins (bool, default: False) – Whether to activate the formulation that considers interlaminar normal stresses.\nwf (float, default: 1.0) – Weighting factor of the failure mode (cs).\nCoreFailureCriterion.to_dict()\n\nCoreFailureCriterion.to_json()\n\nCoreFailureCriterion.active\nThe failure criterion is suppressed if active is False.\nCoreFailureCriterion.include_ins\nWhether to activate the formulation that considers interlaminar normal stresses.\nCoreFailureCriterion.name\nName of the failure criterion.\nCoreFailureCriterion.wf\nWeighting factor of the failure mode (cs).\nCoreFailureCriterion\nbool\nFalse\nfloat\n1.0\nCoreFailureCriterion.to_dict\nCoreFailureCriterion.to_json\nCoreFailureCriterion.active\nCoreFailureCriterion.include_ins\nCoreFailureCriterion.name\nCoreFailureCriterion.wf" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE_REF_SURFACE", + "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE_REF_SURFACE.html#failure_mode_ref_surface", + "title": "FAILURE_MODE_REF_SURFACE", + "section": "FAILURE_MODE_REF_SURFACE", + "text": "FAILURE_MODE_REF_SURFACE" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.html#ansys.dpf.composites.failure_criteria.CoreFailureCriterion", - "title": "CoreFailureCriterion > CoreFailureCriterion > CoreFailureCriterion", - "section": "CoreFailureCriterion > CoreFailureCriterion", - "text": "class ansys.dpf.composites.failure_criteria.CoreFailureCriterion(*, include_ins=False, wf=1.0)\n\nDefines the core shear failure criterion for\ncore materials like foam and honeycomb.\n\nParameters\n\ninclude_ins (bool, default: False) – Whether to activate the formulation that considers interlaminar normal stresses.\n\nwf (float, default: 1.0) – Weighting factor of the failure mode (cs).\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nCoreFailureCriterion.to_dict()\n\n\n\nCoreFailureCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nCoreFailureCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nCoreFailureCriterion.include_ins\n\nWhether to activate the formulation that considers interlaminar normal stresses.\n\nCoreFailureCriterion.name\n\nName of the failure criterion.\n\nCoreFailureCriterion.wf\n\nWeighting factor of the failure mode (cs).\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE_REF_SURFACE", + "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE_REF_SURFACE.html#ansys.dpf.composites.constants.FailureOutput.FAILURE_MODE_REF_SURFACE", + "title": "FAILURE_MODE_REF_SURFACE > FAILURE_MODE_REF_SURFACE > FAILURE_MODE_REF_SURFACE", + "section": "FAILURE_MODE_REF_SURFACE > FAILURE_MODE_REF_SURFACE", + "text": "FailureOutput.FAILURE_MODE_REF_SURFACE = 3\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.wf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.wf.html#wf", - "title": "wf", - "section": "wf", - "text": "Weighting factor of this failure criterion.\nfloat\nwf\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.html#failuremodeenum", + "title": "FailureModeEnum", + "section": "FailureModeEnum", + "text": "FailureModeEnum.emax\n\nFailureModeEnum.evm\n\nFailureModeEnum.e1\n\nFailureModeEnum.e1t\n\nFailureModeEnum.e1c\n\nFailureModeEnum.e2\n\nFailureModeEnum.e2t\n\nFailureModeEnum.e2c\n\nFailureModeEnum.e3\n\nFailureModeEnum.e3t\n\nFailureModeEnum.e3c\n\nFailureModeEnum.e12\n\nFailureModeEnum.e13\n\nFailureModeEnum.e23\n\nFailureModeEnum.smax\n\nFailureModeEnum.svm\n\nFailureModeEnum.s1\n\nFailureModeEnum.s1t\n\nFailureModeEnum.s1c\n\nFailureModeEnum.s2\n\nFailureModeEnum.s2t\n\nFailureModeEnum.s2c\n\nFailureModeEnum.s3\n\nFailureModeEnum.s3t\n\nFailureModeEnum.s3c\n\nFailureModeEnum.s12\n\nFailureModeEnum.s13\n\nFailureModeEnum.s23\n\nFailureModeEnum.cf\n\nFailureModeEnum.w\n\nFailureModeEnum.wb\n\nFailureModeEnum.wt\n\nFailureModeEnum.sc\n\nFailureModeEnum.tw\n\nFailureModeEnum.th\n\nFailureModeEnum.h\n\nFailureModeEnum.hf\n\nFailureModeEnum.hm\n\nFailureModeEnum.hd\n\nFailureModeEnum.ho\n\nFailureModeEnum.p\n\nFailureModeEnum.pf\n\nFailureModeEnum.pmA\n\nFailureModeEnum.pmB\n\nFailureModeEnum.pmC\n\nFailureModeEnum.pd\n\nFailureModeEnum.l\n\nFailureModeEnum.lft3\n\nFailureModeEnum.lfc4\n\nFailureModeEnum.lfc6\n\nFailureModeEnum.lmt1\n\nFailureModeEnum.lmc2\n\nFailureModeEnum.lmc5\n\nFailureModeEnum.c\n\nFailureModeEnum.cft\n\nFailureModeEnum.cfc\n\nFailureModeEnum.cmA\n\nFailureModeEnum.cmB\n\nFailureModeEnum.cmC\n\nFailureModeEnum.vMe\n\nFailureModeEnum.vMs\n\nFailureModeEnum.as\n\nFailureModeEnum.ap\n\nFailureModeEnum.af\n\nFailureModeEnum.ns\n\nFailureModeEnum.na\n\nFailureModeEnum\nFailureModeEnum.emax\nFailureModeEnum.evm\nFailureModeEnum.e1\nFailureModeEnum.e1t\nFailureModeEnum.e1c\nFailureModeEnum.e2\nFailureModeEnum.e2t\nFailureModeEnum.e2c\nFailureModeEnum.e3\nFailureModeEnum.e3t\nFailureModeEnum.e3c\nFailureModeEnum.e12\nFailureModeEnum.e13\nFailureModeEnum.e23\nFailureModeEnum.smax\nFailureModeEnum.svm\nFailureModeEnum.s1\nFailureModeEnum.s1t\nFailureModeEnum.s1c\nFailureModeEnum.s2\nFailureModeEnum.s2t\nFailureModeEnum.s2c\nFailureModeEnum.s3\nFailureModeEnum.s3t\nFailureModeEnum.s3c\nFailureModeEnum.s12\nFailureModeEnum.s13\nFailureModeEnum.s23\nFailureModeEnum.cf\nFailureModeEnum.w\nFailureModeEnum.wb\nFailureModeEnum.wt\nFailureModeEnum.sc\nFailureModeEnum.tw\nFailureModeEnum.th\nFailureModeEnum.h\nFailureModeEnum.hf\nFailureModeEnum.hm\nFailureModeEnum.hd\nFailureModeEnum.ho\nFailureModeEnum.p\nFailureModeEnum.pf\nFailureModeEnum.pmA\nFailureModeEnum.pmB\nFailureModeEnum.pmC\nFailureModeEnum.pd\nFailureModeEnum.l\nFailureModeEnum.lft3\nFailureModeEnum.lfc4\nFailureModeEnum.lfc6\nFailureModeEnum.lmt1\nFailureModeEnum.lmc2\nFailureModeEnum.lmc5\nFailureModeEnum.c\nFailureModeEnum.cft\nFailureModeEnum.cfc\nFailureModeEnum.cmA\nFailureModeEnum.cmB\nFailureModeEnum.cmC\nFailureModeEnum.vMe\nFailureModeEnum.vMs\nFailureModeEnum.as\nFailureModeEnum.ap\nFailureModeEnum.af\nFailureModeEnum.ns\nFailureModeEnum.na" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.wf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.wf.html#ansys.dpf.composites.failure_criteria.TsaiHillCriterion.wf", - "title": "wf > wf > wf", - "section": "wf > wf", - "text": "property TsaiHillCriterion.wf: float\n\nWeighting factor of this failure criterion.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.html#ansys.dpf.composites.failure_criteria.FailureModeEnum", + "title": "FailureModeEnum > FailureModeEnum > FailureModeEnum", + "section": "FailureModeEnum > FailureModeEnum", + "text": "class ansys.dpf.composites.failure_criteria.FailureModeEnum(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nFailureModeEnum.emax\n\n\n\nFailureModeEnum.evm\n\n\n\nFailureModeEnum.e1\n\n\n\nFailureModeEnum.e1t\n\n\n\nFailureModeEnum.e1c\n\n\n\nFailureModeEnum.e2\n\n\n\nFailureModeEnum.e2t\n\n\n\nFailureModeEnum.e2c\n\n\n\nFailureModeEnum.e3\n\n\n\nFailureModeEnum.e3t\n\n\n\nFailureModeEnum.e3c\n\n\n\nFailureModeEnum.e12\n\n\n\nFailureModeEnum.e13\n\n\n\nFailureModeEnum.e23\n\n\n\nFailureModeEnum.smax\n\n\n\nFailureModeEnum.svm\n\n\n\nFailureModeEnum.s1\n\n\n\nFailureModeEnum.s1t\n\n\n\nFailureModeEnum.s1c\n\n\n\nFailureModeEnum.s2\n\n\n\nFailureModeEnum.s2t\n\n\n\nFailureModeEnum.s2c\n\n\n\nFailureModeEnum.s3\n\n\n\nFailureModeEnum.s3t\n\n\n\nFailureModeEnum.s3c\n\n\n\nFailureModeEnum.s12\n\n\n\nFailureModeEnum.s13\n\n\n\nFailureModeEnum.s23\n\n\n\nFailureModeEnum.cf\n\n\n\nFailureModeEnum.w\n\n\n\nFailureModeEnum.wb\n\n\n\nFailureModeEnum.wt\n\n\n\nFailureModeEnum.sc\n\n\n\nFailureModeEnum.tw\n\n\n\nFailureModeEnum.th\n\n\n\nFailureModeEnum.h\n\n\n\nFailureModeEnum.hf\n\n\n\nFailureModeEnum.hm\n\n\n\nFailureModeEnum.hd\n\n\n\nFailureModeEnum.ho\n\n\n\nFailureModeEnum.p\n\n\n\nFailureModeEnum.pf\n\n\n\nFailureModeEnum.pmA\n\n\n\nFailureModeEnum.pmB\n\n\n\nFailureModeEnum.pmC\n\n\n\nFailureModeEnum.pd\n\n\n\nFailureModeEnum.l\n\n\n\nFailureModeEnum.lft3\n\n\n\nFailureModeEnum.lfc4\n\n\n\nFailureModeEnum.lfc6\n\n\n\nFailureModeEnum.lmt1\n\n\n\nFailureModeEnum.lmc2\n\n\n\nFailureModeEnum.lmc5\n\n\n\nFailureModeEnum.c\n\n\n\nFailureModeEnum.cft\n\n\n\nFailureModeEnum.cfc\n\n\n\nFailureModeEnum.cmA\n\n\n\nFailureModeEnum.cmB\n\n\n\nFailureModeEnum.cmC\n\n\n\nFailureModeEnum.vMe\n\n\n\nFailureModeEnum.vMs\n\n\n\nFailureModeEnum.as\n\n\n\nFailureModeEnum.ap\n\n\n\nFailureModeEnum.af\n\n\n\nFailureModeEnum.ns\n\n\n\nFailureModeEnum.na\n\n\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_names", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_names.html#material_names", - "title": "material_names", - "section": "material_names", - "text": "Material name to DPF material ID map.\nThis property can be used to filter analysis plies\nor element layers by material name.\ndict[str, int]\nmaterial_names\ndict\nstr\nint" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2c", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2c.html#s2c", + "title": "s2c", + "section": "s2c", + "text": "s2c" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_names", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_names.html#ansys.dpf.composites.composite_model.CompositeModel.material_names", - "title": "material_names > material_names > material_names", - "section": "material_names > material_names", - "text": "property CompositeModel.material_names: dict[str, int]\n\nMaterial name to DPF material ID map.\n\nThis property can be used to filter analysis plies\nor element layers by material name.\n\nReturn type\n\ndict[str, int]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2c", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2c.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s2c", + "title": "s2c > s2c > s2c", + "section": "s2c > s2c", + "text": "FailureModeEnum.s2c = 222\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_spots", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_spots.html#n_spots", - "title": "n_spots", - "section": "n_spots", - "text": "n_spots" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xt", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xt.html#stress_limits_xt", + "title": "Stress_Limits_Xt", + "section": "Stress_Limits_Xt", + "text": "Stress_Limits_Xt" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_spots", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.n_spots.html#ansys.dpf.composites.layup_info.ElementInfo.n_spots", - "title": "n_spots > n_spots > n_spots", - "section": "n_spots > n_spots", - "text": "ElementInfo.n_spots: int\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xt", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xt.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Xt", + "title": "Stress_Limits_Xt > Stress_Limits_Xt > Stress_Limits_Xt", + "section": "Stress_Limits_Xt > Stress_Limits_Xt", + "text": "MaterialProperty.Stress_Limits_Xt: str = 'stress_tensile_x_direction'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s12", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s12.html#wf_s12", - "title": "wf_s12", - "section": "wf_s12", - "text": "Weighting factor of the failure mode s12.\nfloat\nwf_s12\nfloat" + "objectID": "examples/gallery_examples/008_assembly_example", + "href": "examples/gallery_examples/008_assembly_example.html#postprocess-an-assembly", + "title": "Postprocess an assembly", + "section": "Postprocess an assembly", + "text": "This example shows how to postprocess an assembly with multiple composite parts.\nThe assembly consists of a shell and solid composite model. The\nComposite Model class is used to access\nthe data of the different parts.\nWhen using a Workbench project,\nuse the composite_files_from_workbench_harmonic_analysis()\nmethod to obtain the input files.\nPostprocess an assembly\nComposite Model\ncomposite_files_from_workbench_harmonic_analysis()" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s12", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s12.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s12", - "title": "wf_s12 > wf_s12 > wf_s12", - "section": "wf_s12 > wf_s12", - "text": "property MaxStressCriterion.wf_s12: float\n\nWeighting factor of the failure mode s12.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/008_assembly_example", + "href": "examples/gallery_examples/008_assembly_example.html#set-up-analysis", + "title": "Postprocess an assembly > Set up analysis", + "section": "Set up analysis", + "text": "Setting up the analysis consists of loading Ansys libraries, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries.\nStart a DPF server and copy the example files into the current working directory.\nSet up analysis" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e1", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e1.html#wf_e1", - "title": "wf_e1", - "section": "wf_e1", - "text": "Weighting factor of the failure mode e1.\nfloat\nwf_e1\nfloat" + "objectID": "examples/gallery_examples/008_assembly_example", + "href": "examples/gallery_examples/008_assembly_example.html#configure-combined-failure-criterion", + "title": "Postprocess an assembly > Configure combined failure criterion", + "section": "Configure combined failure criterion", + "text": "Configure the combined failure crition.\nConfigure combined failure criterion" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e1", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e1.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e1", - "title": "wf_e1 > wf_e1 > wf_e1", - "section": "wf_e1 > wf_e1", - "text": "property MaxStrainCriterion.wf_e1: float\n\nWeighting factor of the failure mode e1.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/008_assembly_example", + "href": "examples/gallery_examples/008_assembly_example.html#set-up-model", + "title": "Postprocess an assembly > Set up model", + "section": "Set up model", + "text": "Set up the composite model.\nSet up model" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.force_global_strain_limits", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.force_global_strain_limits.html#force_global_strain_limits", - "title": "force_global_strain_limits", - "section": "force_global_strain_limits", - "text": "Whether to use one set of global strain limits instead of the strain limits of the materials.\nbool\nforce_global_strain_limits\nbool" + "objectID": "examples/gallery_examples/008_assembly_example", + "href": "examples/gallery_examples/008_assembly_example.html#plot-irf", + "title": "Postprocess an assembly > Plot IRF", + "section": "Plot IRF", + "text": "Plot the maximum IRF per (solid) element.\nPlot IRF" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.force_global_strain_limits", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.force_global_strain_limits.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.force_global_strain_limits", - "title": "force_global_strain_limits > force_global_strain_limits > force_global_strain_limits", - "section": "force_global_strain_limits > force_global_strain_limits", - "text": "property MaxStrainCriterion.force_global_strain_limits: bool\n\nWhether to use one set of global strain limits instead of the strain limits of the materials.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/008_assembly_example", + "href": "examples/gallery_examples/008_assembly_example.html#plot-irf-on-the-reference-surface", + "title": "Postprocess an assembly > Plot IRF on the reference surface", + "section": "Plot IRF on the reference surface", + "text": "Plot the maximum IRF on the reference surface\nPlot IRF on the reference surface" + }, + { + "objectID": "examples/gallery_examples/008_assembly_example", + "href": "examples/gallery_examples/008_assembly_example.html#get-element-information", + "title": "Postprocess an assembly > Get element information", + "section": "Get element information", + "text": "In the assembly, two composite definitions exist: one with a “shell” label\nand one with a “solid” label. For DPF Server versions earlier than 7.0,\nthe lay-up properties must be queried with the correct composite definition label. The code\nfollowing gets element information for all layered elements.\nFor DPF Server versions 7.0 and later, element information can be retrieved directly.\nTotal running time of the script: (0 minutes 4.148 seconds)\nDownload Jupyter notebook: 008_assembly_example.ipynb\nDownload Python source code: 008_assembly_example.py\nDownload zipped: 008_assembly_example.zip\nGallery generated by Sphinx-Gallery\nGet element information\nDownload Jupyter notebook: 008_assembly_example.ipynb\nDownload Python source code: 008_assembly_example.py\nDownload zipped: 008_assembly_example.zip" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmB", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmB.html#cmb", - "title": "cmB", - "section": "cmB", - "text": "cmB" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.h", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.h.html#h", + "title": "h", + "section": "h", + "text": "h" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmB", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmB.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.cmB", - "title": "cmB > cmB > cmB", - "section": "cmB > cmB", - "text": "FailureModeEnum.cmB = 1004\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.h", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.h.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.h", + "title": "h > h > h", + "section": "h > h", + "text": "FailureModeEnum.h = 501\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.strip", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.strip.html#strip", - "title": "strip", - "section": "strip", - "text": "Return a copy of the string with leading and trailing whitespace removed.\nIf chars is given and not None, remove characters in chars instead.\nstrip" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.upper", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.upper.html#upper", + "title": "upper", + "section": "upper", + "text": "Return a copy of the string converted to uppercase.\nupper" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.strip", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.strip.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.strip", - "title": "strip > strip > strip", - "section": "strip > strip", - "text": "FailureMeasureEnum.strip(chars=None, /)\n\nReturn a copy of the string with leading and trailing whitespace removed.\n\nIf chars is given and not None, remove characters in chars instead.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.upper", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.upper.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.upper", + "title": "upper > upper > upper", + "section": "upper > upper", + "text": "FailureMeasureEnum.upper(/)\n\nReturn a copy of the string converted to uppercase.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.add_ply_sequence_to_plot", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.add_ply_sequence_to_plot.html#add_ply_sequence_to_plot", - "title": "add_ply_sequence_to_plot", - "section": "add_ply_sequence_to_plot", - "text": "Add the stacking (ply and text) to an axis or plot.\naxes (Any) – Matplotlib Axes object.\ncore_scale_factor (float, default: 1.0) – Factor for scaling the thickness of core plies.\nNone\nadd_ply_sequence_to_plot\nAny\nAxes\nfloat\n1.0\nNone" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ho", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ho.html#ho", + "title": "ho", + "section": "ho", + "text": "ho" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.add_ply_sequence_to_plot", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.add_ply_sequence_to_plot.html#ansys.dpf.composites.sampling_point.SamplingPoint.add_ply_sequence_to_plot", - "title": "add_ply_sequence_to_plot > add_ply_sequence_to_plot > add_ply_sequence_to_plot", - "section": "add_ply_sequence_to_plot > add_ply_sequence_to_plot", - "text": "SamplingPoint.add_ply_sequence_to_plot(axes, core_scale_factor=1.0)\n\nAdd the stacking (ply and text) to an axis or plot.\n\nParameters\n\naxes (Any) – Matplotlib Axes object.\n\ncore_scale_factor (float, default: 1.0) – Factor for scaling the thickness of core plies.\n\nReturn type\n\nNone\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ho", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ho.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.ho", + "title": "ho > ho > ho", + "section": "ho > ho", + "text": "FailureModeEnum.ho = 700\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_dict.html#to_dict", - "title": "to_dict", - "section": "to_dict", - "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kc.html#kc", + "title": "kc", + "section": "kc", + "text": "Weighting factor of the core material for evaluation of the maximum allowable load. The default is 1.\nfloat\nkc\n1\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_dict", - "title": "to_dict > to_dict > to_dict", - "section": "to_dict > to_dict", - "text": "MaxStressCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kc.html#ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kc", + "title": "kc > kc > kc", + "section": "kc > kc", + "text": "property ShearCrimpingCriterion.kc: float\n\nWeighting factor of the core material for evaluation of the maximum allowable load. The default is 1.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pd", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pd.html#pd", - "title": "pd", - "section": "pd", - "text": "pd" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.evm", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.evm.html#evm", + "title": "evm", + "section": "evm", + "text": "evm" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pd", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pd.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.pd", - "title": "pd > pd > pd", - "section": "pd > pd", - "text": "FailureModeEnum.pd = 805\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.evm", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.evm.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.evm", + "title": "evm > evm > evm", + "section": "evm > evm", + "text": "FailureModeEnum.evm = 102\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu23", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu23.html#engineering_constants_nu23", - "title": "Engineering_Constants_nu23", - "section": "Engineering_Constants_nu23", - "text": "Engineering_Constants_nu23" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3c", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3c.html#s3c", + "title": "s3c", + "section": "s3c", + "text": "s3c" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu23", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu23.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu23", - "title": "Engineering_Constants_nu23 > Engineering_Constants_nu23 > Engineering_Constants_nu23", - "section": "Engineering_Constants_nu23 > Engineering_Constants_nu23", - "text": "MaterialProperty.Engineering_Constants_nu23: str = 'poisson_ratio_yz'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3c", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3c.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s3c", + "title": "s3c > s3c > s3c", + "section": "s3c > s3c", + "text": "FailureModeEnum.s3c = 232\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc4", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc4.html#lfc4", - "title": "lfc4", - "section": "lfc4", - "text": "lfc4" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e13", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e13.html#e13", + "title": "e13", + "section": "e13", + "text": "Out-of-plane shear strains e13 of each ply.\nndarray[Any, dtype[float64]]\ne13\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc4", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc4.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.lfc4", - "title": "lfc4 > lfc4 > lfc4", - "section": "lfc4 > lfc4", - "text": "FailureModeEnum.lfc4 = 902\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e13", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e13.html#ansys.dpf.composites.sampling_point.SamplingPoint.e13", + "title": "e13 > e13 > e13", + "section": "e13 > e13", + "text": "property SamplingPoint.e13: ndarray[Any, dtype[float64]]\n\nOut-of-plane shear strains e13 of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.combined_failure_criterion", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.combined_failure_criterion.html#combined_failure_criterion", - "title": "combined_failure_criterion", - "section": "combined_failure_criterion", - "text": "Configuration of the failure criteria such as maximum stress, puck, and wrinkling.\nCombinedFailureCriterion\ncombined_failure_criterion\nCombinedFailureCriterion" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.engineering_data", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.engineering_data.html#engineering_data", + "title": "engineering_data", + "section": "engineering_data", + "text": "engineering_data" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.combined_failure_criterion", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.combined_failure_criterion.html#ansys.dpf.composites.result_definition.ResultDefinition.combined_failure_criterion", - "title": "combined_failure_criterion > combined_failure_criterion > combined_failure_criterion", - "section": "combined_failure_criterion > combined_failure_criterion", - "text": "property ResultDefinition.combined_failure_criterion: CombinedFailureCriterion\n\nConfiguration of the failure criteria such as maximum stress, puck, and wrinkling.\n\nReturn type\n\nCombinedFailureCriterion\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.engineering_data", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.engineering_data.html#ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.engineering_data", + "title": "engineering_data > engineering_data > engineering_data", + "section": "engineering_data > engineering_data", + "text": "ContinuousFiberCompositesFiles.engineering_data: str | PathLike[str]\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.rst", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.rst.html#rst", - "title": "rst", - "section": "rst", - "text": "rst" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E1", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E1.html#polar_properties_e1", + "title": "polar_properties_E1", + "section": "polar_properties_E1", + "text": "Polar property E1 of the laminate.\nndarray[Any, dtype[float64]]\npolar_properties_E1\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.rst", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.rst.html#ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.rst", - "title": "rst > rst > rst", - "section": "rst > rst", - "text": "ContinuousFiberCompositesFiles.rst: list[str | PathLike[str]]\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E1", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E1.html#ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E1", + "title": "polar_properties_E1 > polar_properties_E1 > polar_properties_E1", + "section": "polar_properties_E1 > polar_properties_E1", + "text": "property SamplingPoint.polar_properties_E1: ndarray[Any, dtype[float64]]\n\nPolar property E1 of the laminate.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxz", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxz.html#stress_limits_sxz", - "title": "Stress_Limits_Sxz", - "section": "Stress_Limits_Sxz", - "text": "Stress_Limits_Sxz" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.name.html#name", + "title": "name", + "section": "name", + "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxz", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxz.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxz", - "title": "Stress_Limits_Sxz > Stress_Limits_Sxz > Stress_Limits_Sxz", - "section": "Stress_Limits_Sxz > Stress_Limits_Sxz", - "text": "MaterialProperty.Stress_Limits_Sxz: str = 'stress_shear_xz'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.name.html#ansys.dpf.composites.failure_criteria.TsaiWuCriterion.name", + "title": "name > name > name", + "section": "name > name", + "text": "property TsaiWuCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3c", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3c.html#e3c", - "title": "e3c", - "section": "e3c", - "text": "e3c" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pma", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pma.html#wf_pma", + "title": "wf_pma", + "section": "wf_pma", + "text": "Weighting factor of the matrix failure (pma) mode.\nfloat\nwf_pma\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3c", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e3c.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e3c", - "title": "e3c > e3c > e3c", - "section": "e3c > e3c", - "text": "FailureModeEnum.e3c = 132\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pma", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pma.html#ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pma", + "title": "wf_pma > wf_pma > wf_pma", + "section": "wf_pma > wf_pma", + "text": "property PuckCriterion.wf_pma: float\n\nWeighting factor of the matrix failure (pma) mode.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.material_support", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.material_support.html#material_support", - "title": "material_support", - "section": "material_support", - "text": "material_support" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.html#failureresult", + "title": "FailureResult", + "section": "FailureResult", + "text": "Provides the components of a failure result.\nFailureResult.mode\n\nFailureResult.inverse_reserve_factor\n\nFailureResult.safety_factor\n\nFailureResult.safety_margin\n\nFailureResult\nFailureResult.mode\nFailureResult.inverse_reserve_factor\nFailureResult.safety_factor\nFailureResult.safety_margin" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.material_support", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.material_support.html#ansys.dpf.composites.data_sources.CompositeDataSources.material_support", - "title": "material_support > material_support > material_support", - "section": "material_support > material_support", - "text": "CompositeDataSources.material_support: DataSources\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.html#ansys.dpf.composites.sampling_point.FailureResult", + "title": "FailureResult > FailureResult > FailureResult", + "section": "FailureResult > FailureResult", + "text": "class ansys.dpf.composites.sampling_point.FailureResult(mode, inverse_reserve_factor, safety_factor, safety_margin)\n\nProvides the components of a failure result.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nFailureResult.mode\n\n\n\nFailureResult.inverse_reserve_factor\n\n\n\nFailureResult.safety_factor\n\n\n\nFailureResult.safety_margin\n\n\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e1", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e1.html#e1", - "title": "e1", - "section": "e1", - "text": "Strains in the material 1 direction of each ply.\nndarray[Any, dtype[float64]]\ne1\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_constant_property_dict", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_constant_property_dict.html#get_constant_property_dict", + "title": "get_constant_property_dict", + "section": "get_constant_property_dict", + "text": "Get a dictionary with constant properties.\nReturns a dictionary with dpf_material_id as the key and\na dictionary with the requested properties as the value. Only constant properties\nare supported. Variable properties are evaluated at their\ndefault values.\nThis method can be slow to evaluate and should not\nbe called in a loop.\nmaterial_properties (Collection[MaterialProperty]) – List of the requested material properties.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nThe dictionary only contains the materials of the analysis plies defined\nin the specified composite definition.\ndict[int64, dict[MaterialProperty, float]]\nget_constant_property_dict\ndpf_material_id\nCollection\nMaterialProperty\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\ndict\nint64\ndict\nMaterialProperty\nfloat" }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e1", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e1.html#ansys.dpf.composites.sampling_point.SamplingPoint.e1", - "title": "e1 > e1 > e1", - "section": "e1 > e1", - "text": "property SamplingPoint.e1: ndarray[Any, dtype[float64]]\n\nStrains in the material 1 direction of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + { + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_constant_property_dict", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_constant_property_dict.html#ansys.dpf.composites.composite_model.CompositeModel.get_constant_property_dict", + "title": "get_constant_property_dict > get_constant_property_dict > get_constant_property_dict", + "section": "get_constant_property_dict > get_constant_property_dict", + "text": "CompositeModel.get_constant_property_dict(material_properties, composite_definition_label=None)\n\nGet a dictionary with constant properties.\n\nReturns a dictionary with dpf_material_id as the key and\na dictionary with the requested properties as the value. Only constant properties\nare supported. Variable properties are evaluated at their\ndefault values.\n\nThis method can be slow to evaluate and should not\nbe called in a loop.\n\nParameters\n\nmaterial_properties (Collection[MaterialProperty]) – List of the requested material properties.\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nThe dictionary only contains the materials of the analysis plies defined\nin the specified composite definition.\n\nReturn type\n\ndict[int64, dict[MaterialProperty, float]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p22_neg", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p22_neg.html#p22_neg", - "title": "p22_neg", - "section": "p22_neg", - "text": "Global inclination factor of the fracture plane \\perp \\perp for compression.\nfloat\np22_neg\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s13", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s13.html#s13", + "title": "s13", + "section": "s13", + "text": "Whether to activate the failure evaluation regarding the interlaminar shear stress s13.\nbool\ns13\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p22_neg", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p22_neg.html#ansys.dpf.composites.failure_criteria.PuckCriterion.p22_neg", - "title": "p22_neg > p22_neg > p22_neg", - "section": "p22_neg > p22_neg", - "text": "property PuckCriterion.p22_neg: float\n\nGlobal inclination factor of the fracture plane \\perp \\perp for compression.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s13", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s13.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.s13", + "title": "s13 > s13 > s13", + "section": "s13 > s13", + "text": "property MaxStressCriterion.s13: bool\n\nWhether to activate the failure evaluation regarding the interlaminar shear stress s13.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.material_file", @@ -6342,2292 +6300,2334 @@ "text": "property ResultDefinition.material_file: str | PathLike[str]\n\nPath of the material files that store the material properties.\n\nSupported formats are XML and ENGD.\n\nReturn type\n\nUnion[str, PathLike[str]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.name.html#name", - "title": "name", - "section": "name", - "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.smax", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.smax.html#smax", + "title": "smax", + "section": "smax", + "text": "smax" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.name.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.name", - "title": "name > name > name", - "section": "name > name", - "text": "property MaxStrainCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.smax", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.smax.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.smax", + "title": "smax > smax > smax", + "section": "smax > smax", + "text": "FailureModeEnum.smax = 201\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmB", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmB.html#pmb", - "title": "pmB", - "section": "pmB", - "text": "pmB" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_neg", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_neg.html#puck_constants_p_21_neg", + "title": "Puck_Constants_p_21_neg", + "section": "Puck_Constants_p_21_neg", + "text": "Puck_Constants_p_21_neg" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmB", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmB.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.pmB", - "title": "pmB > pmB > pmB", - "section": "pmB > pmB", - "text": "FailureModeEnum.pmB = 803\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_neg", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_neg.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_neg", + "title": "Puck_Constants_p_21_neg > Puck_Constants_p_21_neg > Puck_Constants_p_21_neg", + "section": "Puck_Constants_p_21_neg > Puck_Constants_p_21_neg", + "text": "MaterialProperty.Puck_Constants_p_21_neg: str = 'compressive_inclination_xz_puck_constants'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.b32", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.b32.html#b32", - "title": "b32", - "section": "b32", - "text": "Out-of-plane shear friction coefficient. The default is 1.3805. The value depends on the fracture plane angle.\nfloat\nb32\n1.3805\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_dict.html#to_dict", + "title": "to_dict", + "section": "to_dict", + "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.b32", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.b32.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.b32", - "title": "b32 > b32 > b32", - "section": "b32 > b32", - "text": "property CuntzeCriterion.b32: float\n\nOut-of-plane shear friction coefficient. The default is 1.3805. The value depends on the fracture plane angle.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_dict", + "title": "to_dict > to_dict > to_dict", + "section": "to_dict > to_dict", + "text": "MaxStrainCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1c", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1c.html#s1c", - "title": "s1c", - "section": "s1c", - "text": "s1c" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmc.html#wf_cmc", + "title": "wf_cmc", + "section": "wf_cmc", + "text": "Weighting factor of matrix failure due to compression or shear (cmc).\nfloat\nwf_cmc\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1c", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1c.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s1c", - "title": "s1c > s1c > s1c", - "section": "s1c > s1c", - "text": "FailureModeEnum.s1c = 212\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmc.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cmc", + "title": "wf_cmc > wf_cmc > wf_cmc", + "section": "wf_cmc > wf_cmc", + "text": "property CuntzeCriterion.wf_cmc: float\n\nWeighting factor of matrix failure due to compression or shear (cmc).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s23", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s23.html#s23", - "title": "s23", - "section": "s23", - "text": "s23" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.name.html#name", + "title": "name", + "section": "name", + "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s23", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s23.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s23", - "title": "s23 > s23 > s23", - "section": "s23 > s23", - "text": "FailureModeEnum.s23 = 260\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.name.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.name", + "title": "name > name > name", + "section": "name > name", + "text": "property CuntzeCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_element_laminate_offset", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_element_laminate_offset.html#get_element_laminate_offset", - "title": "get_element_laminate_offset", - "section": "get_element_laminate_offset", - "text": "Get laminate offset of element. Returns None if element is not layered.\nelement_id (int) – Element Id/Label\nOptional[float64]\nget_element_laminate_offset\nint\nOptional\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_json.html#to_json", + "title": "to_json", + "section": "to_json", + "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_element_laminate_offset", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_element_laminate_offset.html#ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_element_laminate_offset", - "title": "get_element_laminate_offset > get_element_laminate_offset > get_element_laminate_offset", - "section": "get_element_laminate_offset > get_element_laminate_offset", - "text": "LayupPropertiesProvider.get_element_laminate_offset(element_id)\n\nGet laminate offset of element. Returns None if element is not layered.\n\nParameters\n\nelement_id (int) – Element Id/Label\n\nReturn type\n\nOptional[float64]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_json.html#ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.to_json", + "title": "to_json > to_json > to_json", + "section": "to_json > to_json", + "text": "ShearCrimpingCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.splitlines", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.splitlines.html#splitlines", - "title": "splitlines", - "section": "splitlines", - "text": "Return a list of the lines in the string, breaking at line boundaries.\nLine breaks are not included in the resulting list unless keepends is given and\ntrue.\nsplitlines" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.wf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.wf.html#wf", + "title": "wf", + "section": "wf", + "text": "Weighting factor of this failure criterion.\nfloat\nwf\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.splitlines", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.splitlines.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.splitlines", - "title": "splitlines > splitlines > splitlines", - "section": "splitlines > splitlines", - "text": "FailureMeasureEnum.splitlines(/, keepends=False)\n\nReturn a list of the lines in the string, breaking at line boundaries.\n\nLine breaks are not included in the resulting list unless keepends is given and\ntrue.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.wf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.wf.html#ansys.dpf.composites.failure_criteria.TsaiWuCriterion.wf", + "title": "wf > wf > wf", + "section": "wf > wf", + "text": "property TsaiWuCriterion.wf: float\n\nWeighting factor of this failure criterion.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.server_helpers.connect_to_or_start_server", - "href": "api/_autosummary/ansys.dpf.composites.server_helpers.connect_to_or_start_server.html#connect_to_or_start_server", - "title": "connect_to_or_start_server", - "section": "connect_to_or_start_server", - "text": "Connect to or start a DPF server with the DPF Composites plugin loaded.\nIf a port or IP address is set, this method tries to connect to the server specified\nand the ansys_path parameter is ignored. If no parameters are set, a local server\nfrom the latest available Ansys installation is started.\nport (Optional[int], default: None) – Port that the DPF server is listening on.\nip (Optional[str], default: None) – IP address for the DPF server.\nansys_path (Optional[str], default: None) – Root path for the Ansys installation. For example, C:\\\\Program Files\\\\ANSYS Inc\\\\v232.\nThis parameter is ignored if either the port or IP address is set.\nAny\nDPF server.\nconnect_to_or_start_server\nansys_path\nOptional\nint\nNone\nOptional\nstr\nNone\nOptional\nstr\nNone\nC:\\\\Program Files\\\\ANSYS Inc\\\\v232\nAny" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfoProvider.get_element_info", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfoProvider.get_element_info.html#get_element_info", + "title": "get_element_info", + "section": "get_element_info", + "text": "Get ElementInfo for a given element id.\nelement_id (int) – Element Id/Label\nReturns None if element type is not supported\nOptional[ElementInfo]\nget_element_info\nElementInfo\nint" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.server_helpers.connect_to_or_start_server", - "href": "api/_autosummary/ansys.dpf.composites.server_helpers.connect_to_or_start_server.html#ansys.dpf.composites.server_helpers.connect_to_or_start_server", - "title": "connect_to_or_start_server > connect_to_or_start_server > connect_to_or_start_server", - "section": "connect_to_or_start_server > connect_to_or_start_server", - "text": "ansys.dpf.composites.server_helpers.connect_to_or_start_server(port=None, ip=None, ansys_path=None)\n\nConnect to or start a DPF server with the DPF Composites plugin loaded.\n\nIf a port or IP address is set, this method tries to connect to the server specified\nand the ansys_path parameter is ignored. If no parameters are set, a local server\nfrom the latest available Ansys installation is started.\n\nParameters\n\nport (Optional[int], default: None) – Port that the DPF server is listening on.\n\nip (Optional[str], default: None) – IP address for the DPF server.\n\nansys_path (Optional[str], default: None) – Root path for the Ansys installation. For example, C:\\\\Program Files\\\\ANSYS Inc\\\\v232.\nThis parameter is ignored if either the port or IP address is set.\n\nReturn type\n\nAny\n\nReturns\n\nDPF server.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfoProvider.get_element_info", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfoProvider.get_element_info.html#ansys.dpf.composites.layup_info.ElementInfoProvider.get_element_info", + "title": "get_element_info > get_element_info > get_element_info", + "section": "get_element_info > get_element_info", + "text": "ElementInfoProvider.get_element_info(element_id)\n\nGet ElementInfo for a given element id.\n\nParameters\n\nelement_id (int) – Element Id/Label\n\nReturns\n\nReturns None if element type is not supported\n\nReturn type\n\nOptional[ElementInfo]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.safety_factor", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.safety_factor.html#safety_factor", - "title": "safety_factor", - "section": "safety_factor", - "text": "safety_factor" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e23", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e23.html#e23", + "title": "e23", + "section": "e23", + "text": "Out-of-plane shear strains e23 of each ply.\nndarray[Any, dtype[float64]]\ne23\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.safety_factor", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.safety_factor.html#ansys.dpf.composites.sampling_point.FailureResult.safety_factor", - "title": "safety_factor > safety_factor > safety_factor", - "section": "safety_factor > safety_factor", - "text": "FailureResult.safety_factor: float\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e23", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e23.html#ansys.dpf.composites.sampling_point.SamplingPoint.e23", + "title": "e23 > e23 > e23", + "section": "e23 > e23", + "text": "property SamplingPoint.e23: ndarray[Any, dtype[float64]]\n\nOut-of-plane shear strains e23 of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.inverse_reserve_factor", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.inverse_reserve_factor.html#inverse_reserve_factor", - "title": "inverse_reserve_factor", - "section": "inverse_reserve_factor", - "text": "inverse_reserve_factor" + "objectID": "examples/gallery_examples/014_cyclic_symmetry_example", + "href": "examples/gallery_examples/014_cyclic_symmetry_example.html#cyclic-symmetry", + "title": "Cyclic symmetry", + "section": "Cyclic symmetry", + "text": "This example shows how to postprocess a cyclic symmetry analysis.\nThe initial (original) sector can be postprocessed with the same tools\nas a standard analysis. The postprocessing workflow is demonstrated by\nrunning a failure analysis, extracting ply-wise stresses, and implementing\na custom failure criterion.\nThe postprocessing of expanded sectors is not yet supported.\nWhen using a Workbench project,\nuse the composite_files_from_workbench_harmonic_analysis()\nmethod to obtain the input files.\nCyclic symmetry\ncomposite_files_from_workbench_harmonic_analysis()" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.inverse_reserve_factor", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.inverse_reserve_factor.html#ansys.dpf.composites.sampling_point.FailureResult.inverse_reserve_factor", - "title": "inverse_reserve_factor > inverse_reserve_factor > inverse_reserve_factor", - "section": "inverse_reserve_factor > inverse_reserve_factor", - "text": "FailureResult.inverse_reserve_factor: float\n\n" + "objectID": "examples/gallery_examples/014_cyclic_symmetry_example", + "href": "examples/gallery_examples/014_cyclic_symmetry_example.html#set-up-analysis", + "title": "Cyclic symmetry > Set up analysis", + "section": "Set up analysis", + "text": "Setting up the analysis consists of loading the required modules, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries and helper functions.\nStart a DPF server and copy the example files into the current working directory.\nCreate a composite model.\nEvaluate a combined failure criterion.\nPlot the failure results.\nSet up analysis" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E2", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E2.html#polar_properties_e2", - "title": "polar_properties_E2", - "section": "polar_properties_E2", - "text": "Polar property E2 of the laminate.\nndarray[Any, dtype[float64]]\npolar_properties_E2\nndarray\nAny\ndtype\nfloat64" + "objectID": "examples/gallery_examples/014_cyclic_symmetry_example", + "href": "examples/gallery_examples/014_cyclic_symmetry_example.html#plot-ply-wise-stresses", + "title": "Cyclic symmetry > Plot ply-wise stresses", + "section": "Plot ply-wise stresses", + "text": "All functions in PyDPF - Composites can be used to\npostprocess the initial (original) sector.\nPlot ply-wise stresses" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E2", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E2.html#ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_E2", - "title": "polar_properties_E2 > polar_properties_E2 > polar_properties_E2", - "section": "polar_properties_E2 > polar_properties_E2", - "text": "property SamplingPoint.polar_properties_E2: ndarray[Any, dtype[float64]]\n\nPolar property E2 of the laminate.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/014_cyclic_symmetry_example", + "href": "examples/gallery_examples/014_cyclic_symmetry_example.html#custom-failure-criterion", + "title": "Cyclic symmetry > Custom failure criterion", + "section": "Custom failure criterion", + "text": "The following code block shows how to implement a custom failure criterion.\nIt computes the inverse reserve factor for each element with respect to\nfiber failure. The criterion distinguishes between tension and compression.\nCustom failure criterion" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MID", - "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MID.html#mid", - "title": "MID", - "section": "MID", - "text": "MID" + "objectID": "examples/gallery_examples/014_cyclic_symmetry_example", + "href": "examples/gallery_examples/014_cyclic_symmetry_example.html#plot-deformations-on-the-expanded-model", + "title": "Cyclic symmetry > Plot deformations on the expanded model", + "section": "Plot deformations on the expanded model", + "text": "You can expand the deformations of the cyclic symmetry model as shown below.\nThe same expansion is possible for strains and stresses. For more information, see Ansys DPF.\nTotal running time of the script: (0 minutes 7.394 seconds)\nDownload Jupyter notebook: 014_cyclic_symmetry_example.ipynb\nDownload Python source code: 014_cyclic_symmetry_example.py\nDownload zipped: 014_cyclic_symmetry_example.zip\nGallery generated by Sphinx-Gallery\nPlot deformations on the expanded model\nDownload Jupyter notebook: 014_cyclic_symmetry_example.ipynb\nDownload Python source code: 014_cyclic_symmetry_example.py\nDownload zipped: 014_cyclic_symmetry_example.zip" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hf.html#wf_hf", + "title": "wf_hf", + "section": "wf_hf", + "text": "Whether to activate the failure evaluation regarding fiber failure.\nfloat\nwf_hf\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MID", - "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MID.html#ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MID", - "title": "MID > MID > MID", - "section": "MID > MID", - "text": "SpotReductionStrategy.MID = 'MID'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hf.html#ansys.dpf.composites.failure_criteria.HashinCriterion.wf_hf", + "title": "wf_hf > wf_hf > wf_hf", + "section": "wf_hf > wf_hf", + "text": "property HashinCriterion.wf_hf: float\n\nWhether to activate the failure evaluation regarding fiber failure.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tensile_Yield_Strength_effective_stress", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tensile_Yield_Strength_effective_stress.html#tensile_yield_strength_effective_stress", - "title": "Tensile_Yield_Strength_effective_stress", - "section": "Tensile_Yield_Strength_effective_stress", - "text": "Tensile_Yield_Strength_effective_stress" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.id", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.id.html#id", + "title": "id", + "section": "id", + "text": "id" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tensile_Yield_Strength_effective_stress", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tensile_Yield_Strength_effective_stress.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tensile_Yield_Strength_effective_stress", - "title": "Tensile_Yield_Strength_effective_stress > Tensile_Yield_Strength_effective_stress > Tensile_Yield_Strength_effective_stress", - "section": "Tensile_Yield_Strength_effective_stress > Tensile_Yield_Strength_effective_stress", - "text": "MaterialProperty.Tensile_Yield_Strength_effective_stress: str = 'tensile_yield_strength'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.id", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.id.html#ansys.dpf.composites.layup_info.ElementInfo.id", + "title": "id > id > id", + "section": "id > id", + "text": "ElementInfo.id: int\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K1", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K1.html#thermal_conductivity_k1", - "title": "Thermal_Conductivity_K1", - "section": "Thermal_Conductivity_K1", - "text": "Thermal_Conductivity_K1" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXc.html#exc", + "title": "eXc", + "section": "eXc", + "text": "Global compressive strain limit in material direction 1.\nfloat\neXc\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K1", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K1.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K1", - "title": "Thermal_Conductivity_K1 > Thermal_Conductivity_K1 > Thermal_Conductivity_K1", - "section": "Thermal_Conductivity_K1 > Thermal_Conductivity_K1", - "text": "MaterialProperty.Thermal_Conductivity_K1: str = 'thermal_conductivity_x_direction'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXc.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXc", + "title": "eXc > eXc > eXc", + "section": "eXc > eXc", + "text": "property MaxStrainCriterion.eXc: float\n\nGlobal compressive strain limit in material direction 1.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.name.html#name", - "title": "name", - "section": "name", - "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.html#materialoperators", + "title": "MaterialOperators", + "section": "MaterialOperators", + "text": "Provides the container for material-related operators.\nmaterial_support_provider (Operator) – The material support provider takes care of mapping the materials in the RST file to\nthe materials in the composite definitions.\nThe material support contains all the materials from the RST file. Currently\nthe output of this operator cannot be inspected in Python.\nmaterial_provider (Operator) – Outputs the MaterialsContainer, which can be used to\nevaluate material properties. This container cannot be\nqueried in Python, but it can be passed to other DPF operators\nthat evaluate the properties.\nresult_info_provider (Operator) – Provides the ResultInfo object.\nMaterialOperators.material_container_helper_op\nGet material container helper operator.\nMaterialOperators.material_provider\nGet material_provider.\nMaterialOperators.material_support_provider\nGet material_support_provider.\nMaterialOperators.result_info_provider\nGet result_info_provider.\nMaterialOperators\nOperator\nOperator\nMaterialsContainer\nOperator\nResultInfo\nMaterialOperators.material_container_helper_op\nMaterialOperators.material_provider\nMaterialOperators.material_support_provider\nMaterialOperators.result_info_provider" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.name.html#ansys.dpf.composites.failure_criteria.CoreFailureCriterion.name", - "title": "name > name > name", - "section": "name > name", - "text": "property CoreFailureCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.html#ansys.dpf.composites.layup_info.material_operators.MaterialOperators", + "title": "MaterialOperators > MaterialOperators > MaterialOperators", + "section": "MaterialOperators > MaterialOperators", + "text": "class ansys.dpf.composites.layup_info.material_operators.MaterialOperators(material_provider, material_support_provider, result_info_provider)\n\nProvides the container for material-related operators.\n\nParameters\n\nmaterial_support_provider (Operator) – The material support provider takes care of mapping the materials in the RST file to\nthe materials in the composite definitions.\nThe material support contains all the materials from the RST file. Currently\nthe output of this operator cannot be inspected in Python.\n\nmaterial_provider (Operator) – Outputs the MaterialsContainer, which can be used to\nevaluate material properties. This container cannot be\nqueried in Python, but it can be passed to other DPF operators\nthat evaluate the properties.\n\nresult_info_provider (Operator) – Provides the ResultInfo object.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nMaterialOperators.material_container_helper_op\n\nGet material container helper operator.\n\nMaterialOperators.material_provider\n\nGet material_provider.\n\nMaterialOperators.material_support_provider\n\nGet material_support_provider.\n\nMaterialOperators.result_info_provider\n\nGet result_info_provider.\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.max_chunk_size", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.max_chunk_size.html#max_chunk_size", - "title": "max_chunk_size", - "section": "max_chunk_size", - "text": "Maximum chunk size (number of elements) for the result evaluation.\nSmall chunks reduce the maximum peak of memory, but too many chunks causes\nsome overhead. The default is 50,000. Use -1 to disable chunking.\nint\nmax_chunk_size\n-1\nint" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_angle_under_compression", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_angle_under_compression.html#larc_constants_fracture_angle_under_compression", + "title": "Larc_Constants_fracture_angle_under_compression", + "section": "Larc_Constants_fracture_angle_under_compression", + "text": "Larc_Constants_fracture_angle_under_compression" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.max_chunk_size", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.max_chunk_size.html#ansys.dpf.composites.result_definition.ResultDefinition.max_chunk_size", - "title": "max_chunk_size > max_chunk_size > max_chunk_size", - "section": "max_chunk_size > max_chunk_size", - "text": "property ResultDefinition.max_chunk_size: int\n\nMaximum chunk size (number of elements) for the result evaluation.\n\nSmall chunks reduce the maximum peak of memory, but too many chunks causes\nsome overhead. The default is 50,000. Use -1 to disable chunking.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_angle_under_compression", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_angle_under_compression.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_angle_under_compression", + "title": "Larc_Constants_fracture_angle_under_compression > Larc_Constants_fracture_angle_under_compression > Larc_Constants_fracture_angle_under_compression", + "section": "Larc_Constants_fracture_angle_under_compression > Larc_Constants_fracture_angle_under_compression", + "text": "MaterialProperty.Larc_Constants_fracture_angle_under_compression: str = 'fracture_angle_under_compression_larc_constants'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_pos", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_pos.html#puck_constants_p_21_pos", - "title": "Puck_Constants_p_21_pos", - "section": "Puck_Constants_p_21_pos", - "text": "Puck_Constants_p_21_pos" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.split", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.split.html#split", + "title": "split", + "section": "split", + "text": "Return a list of the substrings in the string, using sep as the separator string.\nThe separator used to split the string.\nWhen set to None (the default value), will split on any whitespace\ncharacter (including n r t f and spaces) and will discard\nempty strings from the result.\nMaximum number of splits.\n-1 (the default value) means no limit.\nSplitting starts at the front of the string and works to the end.\nNote, str.split() is mainly useful for data that has been intentionally\ndelimited. With natural text that includes punctuation, consider using\nthe regular expression module.\nsplit" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_pos", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_pos.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_21_pos", - "title": "Puck_Constants_p_21_pos > Puck_Constants_p_21_pos > Puck_Constants_p_21_pos", - "section": "Puck_Constants_p_21_pos > Puck_Constants_p_21_pos", - "text": "MaterialProperty.Puck_Constants_p_21_pos: str = 'tensile_inclination_xz_puck_constants'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.split", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.split.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.split", + "title": "split > split > split", + "section": "split > split", + "text": "FailureMeasureEnum.split(/, sep=None, maxsplit=-1)\n\nReturn a list of the substrings in the string, using sep as the separator string.\n\nsep\n\nThe separator used to split the string.\n\nWhen set to None (the default value), will split on any whitespace\ncharacter (including n r t f and spaces) and will discard\nempty strings from the result.\n\nmaxsplit\n\nMaximum number of splits.\n-1 (the default value) means no limit.\n\nSplitting starts at the front of the string and works to the end.\n\nNote, str.split() is mainly useful for data that has been intentionally\ndelimited. With natural text that includes punctuation, consider using\nthe regular expression module.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.NOT_AVAILABLE", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.NOT_AVAILABLE.html#not_available", - "title": "NOT_AVAILABLE", - "section": "NOT_AVAILABLE", - "text": "NOT_AVAILABLE" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.index", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.index.html#index", + "title": "index", + "section": "index", + "text": "Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end].\nOptional arguments start and end are interpreted as in slice notation.\nRaises ValueError when the substring is not found.\nindex" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.NOT_AVAILABLE", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.NOT_AVAILABLE.html#ansys.dpf.composites.layup_info.LayupModelContextType.NOT_AVAILABLE", - "title": "NOT_AVAILABLE > NOT_AVAILABLE > NOT_AVAILABLE", - "section": "NOT_AVAILABLE > NOT_AVAILABLE", - "text": "LayupModelContextType.NOT_AVAILABLE = 0\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.index", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.index.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.index", + "title": "index > index > index", + "section": "index > index", + "text": "FailureMeasureEnum.index(sub, [start, [end]], /)\n\nReturn the lowest index in S where substring sub is found, such that sub is contained within S[start:end].\n\nOptional arguments start and end are interpreted as in slice notation.\nRaises ValueError when the substring is not found.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rpartition", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rpartition.html#rpartition", - "title": "rpartition", - "section": "rpartition", - "text": "Partition the string into three parts using the given separator.\nThis will search for the separator in the string, starting at the end. If\nthe separator is found, returns a 3-tuple containing the part before the\nseparator, the separator itself, and the part after it.\nIf the separator is not found, returns a 3-tuple containing two empty strings\nand the original string.\nrpartition" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.html#combinedfailurecriterion", + "title": "CombinedFailureCriterion", + "section": "CombinedFailureCriterion", + "text": "Defines the combined failure criterion.\nThis class can be used in combination with the failure evaluator operator in\nDPF Composites.\nCombinedFailureCriterion.insert(fc)\nAdd a failure criterion to a list of selected criteria.\nCombinedFailureCriterion.remove(key)\nRemove a failure criterion.\nCombinedFailureCriterion.to_dict()\nReturn the combined failure criterion as a dictionary.\nCombinedFailureCriterion.to_json()\nReturn the combined failure criterion as a JSON dictionary.\nCombinedFailureCriterion.JSON_DICT_KEY\n\nCombinedFailureCriterion.failure_criteria\nList of failure criteria.\nCombinedFailureCriterion.name\nName of the combined failure criterion.\nCombinedFailureCriterion\nCombinedFailureCriterion.insert\nCombinedFailureCriterion.remove\nCombinedFailureCriterion.to_dict\nCombinedFailureCriterion.to_json\nCombinedFailureCriterion.JSON_DICT_KEY\nCombinedFailureCriterion.failure_criteria\nCombinedFailureCriterion.name" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rpartition", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rpartition.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.rpartition", - "title": "rpartition > rpartition > rpartition", - "section": "rpartition > rpartition", - "text": "FailureMeasureEnum.rpartition(sep, /)\n\nPartition the string into three parts using the given separator.\n\nThis will search for the separator in the string, starting at the end. If\nthe separator is found, returns a 3-tuple containing the part before the\nseparator, the separator itself, and the part after it.\n\nIf the separator is not found, returns a 3-tuple containing two empty strings\nand the original string.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.html#ansys.dpf.composites.failure_criteria.CombinedFailureCriterion", + "title": "CombinedFailureCriterion > CombinedFailureCriterion > CombinedFailureCriterion", + "section": "CombinedFailureCriterion > CombinedFailureCriterion", + "text": "class ansys.dpf.composites.failure_criteria.CombinedFailureCriterion(name='CombinedFailureCriterion', failure_criteria=())\n\nDefines the combined failure criterion.\n\nThis class can be used in combination with the failure evaluator operator in\nDPF Composites.\n\nExamples\n\n>>> combined_failure = CombinedFailureCriterion(\"max_stress 3D\")\n>>> max_stress = MaxStressCriterion(s1=True, s2=True, s3=True, s12=True, s13=True, s23=True)\n>>> combined_failure.insert(max_stress)\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nCombinedFailureCriterion.insert(fc)\n\nAdd a failure criterion to a list of selected criteria.\n\nCombinedFailureCriterion.remove(key)\n\nRemove a failure criterion.\n\nCombinedFailureCriterion.to_dict()\n\nReturn the combined failure criterion as a dictionary.\n\nCombinedFailureCriterion.to_json()\n\nReturn the combined failure criterion as a JSON dictionary.\n\n\n\nAttributes\n\n\n\n\n\n\n\nCombinedFailureCriterion.JSON_DICT_KEY\n\n\n\nCombinedFailureCriterion.failure_criteria\n\nList of failure criteria.\n\nCombinedFailureCriterion.name\n\nName of the combined failure criterion.\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmb", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmb.html#wf_pmb", - "title": "wf_pmb", - "section": "wf_pmb", - "text": "Weighting factor of the matrix failure (pmb) mode.\nfloat\nwf_pmb\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.html#hashincriterion", + "title": "HashinCriterion", + "section": "HashinCriterion", + "text": "Defines the Hashin failure criterion for UD reinforced materials.\nhf (bool, default: True) – Whether to activate the failure evaluation regarding fiber failure.\nhm (bool, default: True) – Whether to activate the failure evaluation regarding matrix failure.\nhd (bool, default: False) – Whether to activate the failure evaluation regarding delamination if dim is equal to 3.\ndim (int, default: 2) – Whether the 2D or 3D formulation of the criterion is used. The latter one also supports the failure mode delamination.\nwf_hf (float, default: 1.0) – Weighting factor of the fiber failure (hf) mode.\nwf_hm (float, default: 1.0) – Weighting factor of the matrix failure (hm) mode.\nwf_hd (float, default: 1.0) – Weighting factor of the delamination (hd) mode.\nHashinCriterion.to_dict()\n\nHashinCriterion.to_json()\n\nHashinCriterion.active\nThe failure criterion is suppressed if active is False.\nHashinCriterion.dim\nWhether the 2D or 3D formulation of the criterion is used.\nHashinCriterion.hd\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\nHashinCriterion.hf\nWhether to activate the failure evaluation regarding fiber failure.\nHashinCriterion.hm\nWhether to activate the failure evaluation regarding matrix failure.\nHashinCriterion.name\nName of the failure criterion.\nHashinCriterion.wf_hd\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\nHashinCriterion.wf_hf\nWhether to activate the failure evaluation regarding fiber failure.\nHashinCriterion.wf_hm\nWhether to activate the failure evaluation regarding matrix failure.\nHashinCriterion\nbool\nTrue\nbool\nTrue\nbool\nFalse\nint\n2\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nHashinCriterion.to_dict\nHashinCriterion.to_json\nHashinCriterion.active\nHashinCriterion.dim\nHashinCriterion.hd\nHashinCriterion.hf\nHashinCriterion.hm\nHashinCriterion.name\nHashinCriterion.wf_hd\nHashinCriterion.wf_hf\nHashinCriterion.wf_hm" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmb", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmb.html#ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pmb", - "title": "wf_pmb > wf_pmb > wf_pmb", - "section": "wf_pmb > wf_pmb", - "text": "property PuckCriterion.wf_pmb: float\n\nWeighting factor of the matrix failure (pmb) mode.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.html#ansys.dpf.composites.failure_criteria.HashinCriterion", + "title": "HashinCriterion > HashinCriterion > HashinCriterion", + "section": "HashinCriterion > HashinCriterion", + "text": "class ansys.dpf.composites.failure_criteria.HashinCriterion(*, hf=True, hm=True, hd=False, dim=2, wf_hf=1.0, wf_hm=1.0, wf_hd=1.0)\n\nDefines the Hashin failure criterion for UD reinforced materials.\n\nParameters\n\nhf (bool, default: True) – Whether to activate the failure evaluation regarding fiber failure.\n\nhm (bool, default: True) – Whether to activate the failure evaluation regarding matrix failure.\n\nhd (bool, default: False) – Whether to activate the failure evaluation regarding delamination if dim is equal to 3.\n\ndim (int, default: 2) – Whether the 2D or 3D formulation of the criterion is used. The latter one also supports the failure mode delamination.\n\nwf_hf (float, default: 1.0) – Weighting factor of the fiber failure (hf) mode.\n\nwf_hm (float, default: 1.0) – Weighting factor of the matrix failure (hm) mode.\n\nwf_hd (float, default: 1.0) – Weighting factor of the delamination (hd) mode.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nHashinCriterion.to_dict()\n\n\n\nHashinCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nHashinCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nHashinCriterion.dim\n\nWhether the 2D or 3D formulation of the criterion is used.\n\nHashinCriterion.hd\n\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\n\nHashinCriterion.hf\n\nWhether to activate the failure evaluation regarding fiber failure.\n\nHashinCriterion.hm\n\nWhether to activate the failure evaluation regarding matrix failure.\n\nHashinCriterion.name\n\nName of the failure criterion.\n\nHashinCriterion.wf_hd\n\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\n\nHashinCriterion.wf_hf\n\nWhether to activate the failure evaluation regarding fiber failure.\n\nHashinCriterion.wf_hm\n\nWhether to activate the failure evaluation regarding matrix failure.\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.layup_model_type", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.layup_model_type.html#layup_model_type", - "title": "layup_model_type", - "section": "layup_model_type", - "text": "Get the context type of the lay-up model.\nThe type specifies whether the lay-up data was loaded from an ACP model, RST, or both.\nType can be one of the following values: NOT_AVAILABLE, ACP, RST, MIXED.\nLayupModelContextType\nlayup_model_type\nNOT_AVAILABLE\nACP\nRST\nMIXED\nLayupModelContextType" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pmb", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pmb.html#pmb", + "title": "pmb", + "section": "pmb", + "text": "Whether to activate the failure evaluation regarding matrix failure due to compression.\nbool\npmb\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.layup_model_type", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.layup_model_type.html#ansys.dpf.composites.composite_model.CompositeModel.layup_model_type", - "title": "layup_model_type > layup_model_type > layup_model_type", - "section": "layup_model_type > layup_model_type", - "text": "property CompositeModel.layup_model_type: LayupModelContextType\n\nGet the context type of the lay-up model.\n\nThe type specifies whether the lay-up data was loaded from an ACP model, RST, or both.\nType can be one of the following values: NOT_AVAILABLE, ACP, RST, MIXED.\n\nReturn type\n\nLayupModelContextType\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pmb", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pmb.html#ansys.dpf.composites.failure_criteria.PuckCriterion.pmb", + "title": "pmb > pmb > pmb", + "section": "pmb > pmb", + "text": "property PuckCriterion.pmb: bool\n\nWhether to activate the failure evaluation regarding matrix failure due to compression.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmb", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmb.html#cmb", - "title": "cmb", - "section": "cmb", - "text": "Activates the failure evaluation of the matrix due to compression.\nbool\ncmb\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.to_dict.html#to_dict", + "title": "to_dict", + "section": "to_dict", + "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmb", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmb.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmb", - "title": "cmb > cmb > cmb", - "section": "cmb > cmb", - "text": "property CuntzeCriterion.cmb: bool\n\nActivates the failure evaluation of the matrix due to compression.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.PuckCriterion.to_dict", + "title": "to_dict > to_dict > to_dict", + "section": "to_dict > to_dict", + "text": "PuckCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.html#failuremeasureenum", - "title": "FailureMeasureEnum", - "section": "FailureMeasureEnum", - "text": "Provides available failure measures.\nFailureMeasureEnum.encode(/[, encoding, errors])\nEncode the string using the codec registered for encoding.\nFailureMeasureEnum.replace(old, new, /[, count])\nReturn a copy with all occurrences of substring old replaced by new.\nFailureMeasureEnum.split(/[, sep, maxsplit])\nReturn a list of the substrings in the string, using sep as the separator string.\nFailureMeasureEnum.rsplit(/[, sep, maxsplit])\nReturn a list of the substrings in the string, using sep as the separator string.\nFailureMeasureEnum.join(iterable, /)\nConcatenate any number of strings.\nFailureMeasureEnum.capitalize(/)\nReturn a capitalized version of the string.\nFailureMeasureEnum.casefold(/)\nReturn a version of the string suitable for caseless comparisons.\nFailureMeasureEnum.title(/)\nReturn a version of the string where each word is titlecased.\nFailureMeasureEnum.center(width[, fillchar])\nReturn a centered string of length width.\nFailureMeasureEnum.count(sub[, start[, end]], /)\nReturn the number of non-overlapping occurrences of substring sub in string S[start:end].\nFailureMeasureEnum.expandtabs(/[, tabsize])\nReturn a copy where all tab characters are expanded using spaces.\nFailureMeasureEnum.find(sub[, start[, end]], /)\nReturn the lowest index in S where substring sub is found, such that sub is contained within S[start:end].\nFailureMeasureEnum.partition(sep, /)\nPartition the string into three parts using the given separator.\nFailureMeasureEnum.index(sub[, start[, end]], /)\nReturn the lowest index in S where substring sub is found, such that sub is contained within S[start:end].\nFailureMeasureEnum.ljust(width[, fillchar])\nReturn a left-justified string of length width.\nFailureMeasureEnum.lower(/)\nReturn a copy of the string converted to lowercase.\nFailureMeasureEnum.lstrip([chars])\nReturn a copy of the string with leading whitespace removed.\nFailureMeasureEnum.rfind(sub[, start[, end]], /)\nReturn the highest index in S where substring sub is found, such that sub is contained within S[start:end].\nFailureMeasureEnum.rindex(sub[, start[, end]], /)\nReturn the highest index in S where substring sub is found, such that sub is contained within S[start:end].\nFailureMeasureEnum.rjust(width[, fillchar])\nReturn a right-justified string of length width.\nFailureMeasureEnum.rstrip([chars])\nReturn a copy of the string with trailing whitespace removed.\nFailureMeasureEnum.rpartition(sep, /)\nPartition the string into three parts using the given separator.\nFailureMeasureEnum.splitlines(/[, keepends])\nReturn a list of the lines in the string, breaking at line boundaries.\nFailureMeasureEnum.strip([chars])\nReturn a copy of the string with leading and trailing whitespace removed.\nFailureMeasureEnum.swapcase(/)\nConvert uppercase characters to lowercase and lowercase characters to uppercase.\nFailureMeasureEnum.translate(table, /)\nReplace each character in the string using the given translation table.\nFailureMeasureEnum.upper(/)\nReturn a copy of the string converted to uppercase.\nFailureMeasureEnum.startswith(prefix[, ...)\nReturn True if the string starts with the specified prefix, False otherwise.\nFailureMeasureEnum.endswith(suffix[, start[, ...)\nReturn True if the string ends with the specified suffix, False otherwise.\nFailureMeasureEnum.removeprefix(prefix, /)\nReturn a str with the given prefix string removed if present.\nFailureMeasureEnum.removesuffix(suffix, /)\nReturn a str with the given suffix string removed if present.\nFailureMeasureEnum.isascii(/)\nReturn True if all characters in the string are ASCII, False otherwise.\nFailureMeasureEnum.islower(/)\nReturn True if the string is a lowercase string, False otherwise.\nFailureMeasureEnum.isupper(/)\nReturn True if the string is an uppercase string, False otherwise.\nFailureMeasureEnum.istitle(/)\nReturn True if the string is a title-cased string, False otherwise.\nFailureMeasureEnum.isspace(/)\nReturn True if the string is a whitespace string, False otherwise.\nFailureMeasureEnum.isdecimal(/)\nReturn True if the string is a decimal string, False otherwise.\nFailureMeasureEnum.isdigit(/)\nReturn True if the string is a digit string, False otherwise.\nFailureMeasureEnum.isnumeric(/)\nReturn True if the string is a numeric string, False otherwise.\nFailureMeasureEnum.isalpha(/)\nReturn True if the string is an alphabetic string, False otherwise.\nFailureMeasureEnum.isalnum(/)\nReturn True if the string is an alpha-numeric string, False otherwise.\nFailureMeasureEnum.isidentifier(/)\nReturn True if the string is a valid Python identifier, False otherwise.\nFailureMeasureEnum.isprintable(/)\nReturn True if the string is printable, False otherwise.\nFailureMeasureEnum.zfill(width, /)\nPad a numeric string with zeros on the left, to fill a field of the given width.\nFailureMeasureEnum.format(*args, **kwargs)\nReturn a formatted version of the string, using substitutions from args and kwargs.\nFailureMeasureEnum.format_map(mapping, /)\nReturn a formatted version of the string, using substitutions from mapping.\nFailureMeasureEnum.maketrans(x[, y, z])\nReturn a translation table usable for str.translate().\nFailureMeasureEnum.INVERSE_RESERVE_FACTOR\n\nFailureMeasureEnum.MARGIN_OF_SAFETY\n\nFailureMeasureEnum.RESERVE_FACTOR\n\nFailureMeasureEnum\nFailureMeasureEnum.encode\nFailureMeasureEnum.replace\nFailureMeasureEnum.split\nFailureMeasureEnum.rsplit\nFailureMeasureEnum.join\nFailureMeasureEnum.capitalize\nFailureMeasureEnum.casefold\nFailureMeasureEnum.title\nFailureMeasureEnum.center\nFailureMeasureEnum.count\nFailureMeasureEnum.expandtabs\nFailureMeasureEnum.find\nFailureMeasureEnum.partition\nFailureMeasureEnum.index\nFailureMeasureEnum.ljust\nFailureMeasureEnum.lower\nFailureMeasureEnum.lstrip\nFailureMeasureEnum.rfind\nFailureMeasureEnum.rindex\nFailureMeasureEnum.rjust\nFailureMeasureEnum.rstrip\nFailureMeasureEnum.rpartition\nFailureMeasureEnum.splitlines\nFailureMeasureEnum.strip\nFailureMeasureEnum.swapcase\nFailureMeasureEnum.translate\nFailureMeasureEnum.upper\nFailureMeasureEnum.startswith\nFailureMeasureEnum.endswith\nFailureMeasureEnum.removeprefix\nFailureMeasureEnum.removesuffix\nFailureMeasureEnum.isascii\nFailureMeasureEnum.islower\nFailureMeasureEnum.isupper\nFailureMeasureEnum.istitle\nFailureMeasureEnum.isspace\nFailureMeasureEnum.isdecimal\nFailureMeasureEnum.isdigit\nFailureMeasureEnum.isnumeric\nFailureMeasureEnum.isalpha\nFailureMeasureEnum.isalnum\nFailureMeasureEnum.isidentifier\nFailureMeasureEnum.isprintable\nFailureMeasureEnum.zfill\nFailureMeasureEnum.format\nFailureMeasureEnum.format_map\nFailureMeasureEnum.maketrans\nFailureMeasureEnum.INVERSE_RESERVE_FACTOR\nFailureMeasureEnum.MARGIN_OF_SAFETY\nFailureMeasureEnum.RESERVE_FACTOR" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e13", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e13.html#e13", + "title": "e13", + "section": "e13", + "text": "e13" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.html#ansys.dpf.composites.result_definition.FailureMeasureEnum", - "title": "FailureMeasureEnum > FailureMeasureEnum > FailureMeasureEnum", - "section": "FailureMeasureEnum > FailureMeasureEnum", - "text": "class ansys.dpf.composites.result_definition.FailureMeasureEnum(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nProvides available failure measures.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nFailureMeasureEnum.encode(/[, encoding, errors])\n\nEncode the string using the codec registered for encoding.\n\nFailureMeasureEnum.replace(old, new, /[, count])\n\nReturn a copy with all occurrences of substring old replaced by new.\n\nFailureMeasureEnum.split(/[, sep, maxsplit])\n\nReturn a list of the substrings in the string, using sep as the separator string.\n\nFailureMeasureEnum.rsplit(/[, sep, maxsplit])\n\nReturn a list of the substrings in the string, using sep as the separator string.\n\nFailureMeasureEnum.join(iterable, /)\n\nConcatenate any number of strings.\n\nFailureMeasureEnum.capitalize(/)\n\nReturn a capitalized version of the string.\n\nFailureMeasureEnum.casefold(/)\n\nReturn a version of the string suitable for caseless comparisons.\n\nFailureMeasureEnum.title(/)\n\nReturn a version of the string where each word is titlecased.\n\nFailureMeasureEnum.center(width[, fillchar])\n\nReturn a centered string of length width.\n\nFailureMeasureEnum.count(sub[, start[, end]], /)\n\nReturn the number of non-overlapping occurrences of substring sub in string S[start:end].\n\nFailureMeasureEnum.expandtabs(/[, tabsize])\n\nReturn a copy where all tab characters are expanded using spaces.\n\nFailureMeasureEnum.find(sub[, start[, end]], /)\n\nReturn the lowest index in S where substring sub is found, such that sub is contained within S[start:end].\n\nFailureMeasureEnum.partition(sep, /)\n\nPartition the string into three parts using the given separator.\n\nFailureMeasureEnum.index(sub[, start[, end]], /)\n\nReturn the lowest index in S where substring sub is found, such that sub is contained within S[start:end].\n\nFailureMeasureEnum.ljust(width[, fillchar])\n\nReturn a left-justified string of length width.\n\nFailureMeasureEnum.lower(/)\n\nReturn a copy of the string converted to lowercase.\n\nFailureMeasureEnum.lstrip([chars])\n\nReturn a copy of the string with leading whitespace removed.\n\nFailureMeasureEnum.rfind(sub[, start[, end]], /)\n\nReturn the highest index in S where substring sub is found, such that sub is contained within S[start:end].\n\nFailureMeasureEnum.rindex(sub[, start[, end]], /)\n\nReturn the highest index in S where substring sub is found, such that sub is contained within S[start:end].\n\nFailureMeasureEnum.rjust(width[, fillchar])\n\nReturn a right-justified string of length width.\n\nFailureMeasureEnum.rstrip([chars])\n\nReturn a copy of the string with trailing whitespace removed.\n\nFailureMeasureEnum.rpartition(sep, /)\n\nPartition the string into three parts using the given separator.\n\nFailureMeasureEnum.splitlines(/[, keepends])\n\nReturn a list of the lines in the string, breaking at line boundaries.\n\nFailureMeasureEnum.strip([chars])\n\nReturn a copy of the string with leading and trailing whitespace removed.\n\nFailureMeasureEnum.swapcase(/)\n\nConvert uppercase characters to lowercase and lowercase characters to uppercase.\n\nFailureMeasureEnum.translate(table, /)\n\nReplace each character in the string using the given translation table.\n\nFailureMeasureEnum.upper(/)\n\nReturn a copy of the string converted to uppercase.\n\nFailureMeasureEnum.startswith(prefix[, ...)\n\nReturn True if the string starts with the specified prefix, False otherwise.\n\nFailureMeasureEnum.endswith(suffix[, start[, ...)\n\nReturn True if the string ends with the specified suffix, False otherwise.\n\nFailureMeasureEnum.removeprefix(prefix, /)\n\nReturn a str with the given prefix string removed if present.\n\nFailureMeasureEnum.removesuffix(suffix, /)\n\nReturn a str with the given suffix string removed if present.\n\nFailureMeasureEnum.isascii(/)\n\nReturn True if all characters in the string are ASCII, False otherwise.\n\nFailureMeasureEnum.islower(/)\n\nReturn True if the string is a lowercase string, False otherwise.\n\nFailureMeasureEnum.isupper(/)\n\nReturn True if the string is an uppercase string, False otherwise.\n\nFailureMeasureEnum.istitle(/)\n\nReturn True if the string is a title-cased string, False otherwise.\n\nFailureMeasureEnum.isspace(/)\n\nReturn True if the string is a whitespace string, False otherwise.\n\nFailureMeasureEnum.isdecimal(/)\n\nReturn True if the string is a decimal string, False otherwise.\n\nFailureMeasureEnum.isdigit(/)\n\nReturn True if the string is a digit string, False otherwise.\n\nFailureMeasureEnum.isnumeric(/)\n\nReturn True if the string is a numeric string, False otherwise.\n\nFailureMeasureEnum.isalpha(/)\n\nReturn True if the string is an alphabetic string, False otherwise.\n\nFailureMeasureEnum.isalnum(/)\n\nReturn True if the string is an alpha-numeric string, False otherwise.\n\nFailureMeasureEnum.isidentifier(/)\n\nReturn True if the string is a valid Python identifier, False otherwise.\n\nFailureMeasureEnum.isprintable(/)\n\nReturn True if the string is printable, False otherwise.\n\nFailureMeasureEnum.zfill(width, /)\n\nPad a numeric string with zeros on the left, to fill a field of the given width.\n\nFailureMeasureEnum.format(*args, **kwargs)\n\nReturn a formatted version of the string, using substitutions from args and kwargs.\n\nFailureMeasureEnum.format_map(mapping, /)\n\nReturn a formatted version of the string, using substitutions from mapping.\n\nFailureMeasureEnum.maketrans(x[, y, z])\n\nReturn a translation table usable for str.translate().\n\n\n\nAttributes\n\n\n\n\n\n\n\nFailureMeasureEnum.INVERSE_RESERVE_FACTOR\n\n\n\nFailureMeasureEnum.MARGIN_OF_SAFETY\n\n\n\nFailureMeasureEnum.RESERVE_FACTOR\n\n\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e13", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e13.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e13", + "title": "e13 > e13 > e13", + "section": "e13 > e13", + "text": "FailureModeEnum.e13 = 150\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_angles", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_angles.html#get_layer_angles", - "title": "get_layer_angles", - "section": "get_layer_angles", - "text": "Get angles for all layers. Returns None if element is not layered.\nelement_id (int) – Element Id/Label\nOptional[ndarray[Any, dtype[float64]]]\nget_layer_angles\nint\nOptional\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/data_sources", + "href": "api/data_sources.html#data-sources", + "title": "Data sources", + "section": "Data sources", + "text": "CompositeDefinitionFiles(definition[, mapping])\nProvides the container for composite definition file paths.\nContinuousFiberCompositesFiles(rst, ...[, ...])\nProvides the container for continuous fiber composite file paths.\nShortFiberCompositesFiles(rst, dsdat, ...[, ...])\nProvides the container for short fiber composite file paths.\nCompositeDataSources(rst, material_support, ...)\nProvides data sources related to the composite lay-up.\nget_composite_files_from_workbench_result_folder(...)\nGet a ContinuousFiberCompositesFiles object from a result folder.\ncomposite_files_from_workbench_harmonic_analysis(...)\nGet a ContinuousFiberCompositesFiles object for a harmonic analysis.\nget_composites_data_sources(...)\nCreate DPF data sources from a ContinuousFiberCompositeFiles object.\nData sources\nCompositeDefinitionFiles\nContinuousFiberCompositesFiles\nShortFiberCompositesFiles\nCompositeDataSources\nget_composite_files_from_workbench_result_folder\nContinuousFiberCompositesFiles\ncomposite_files_from_workbench_harmonic_analysis\nContinuousFiberCompositesFiles\nget_composites_data_sources\nContinuousFiberCompositeFiles" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_angles", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_angles.html#ansys.dpf.composites.layup_info.LayupPropertiesProvider.get_layer_angles", - "title": "get_layer_angles > get_layer_angles > get_layer_angles", - "section": "get_layer_angles > get_layer_angles", - "text": "LayupPropertiesProvider.get_layer_angles(element_id)\n\nGet angles for all layers. Returns None if element is not layered.\n\nParameters\n\nelement_id (int) – Element Id/Label\n\nReturn type\n\nOptional[ndarray[Any, dtype[float64]]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.data_sources", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.data_sources.html#data_sources", + "title": "data_sources", + "section": "data_sources", + "text": "Composite data sources.\nCompositeDataSources\ndata_sources\nCompositeDataSources" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.islower", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.islower.html#islower", - "title": "islower", - "section": "islower", - "text": "Return True if the string is a lowercase string, False otherwise.\nA string is lowercase if all cased characters in the string are lowercase and\nthere is at least one cased character in the string.\nislower" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.data_sources", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.data_sources.html#ansys.dpf.composites.composite_model.CompositeModel.data_sources", + "title": "data_sources > data_sources > data_sources", + "section": "data_sources > data_sources", + "text": "property CompositeModel.data_sources: CompositeDataSources\n\nComposite data sources.\n\nReturn type\n\nCompositeDataSources\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.islower", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.islower.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.islower", - "title": "islower > islower > islower", - "section": "islower > islower", - "text": "FailureMeasureEnum.islower(/)\n\nReturn True if the string is a lowercase string, False otherwise.\n\nA string is lowercase if all cased characters in the string are lowercase and\nthere is at least one cased character in the string.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s13", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s13.html#s13", + "title": "s13", + "section": "s13", + "text": "s13" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R22", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R22.html#hill_yield_criterion_r22", - "title": "Hill_Yield_Criterion_R22", - "section": "Hill_Yield_Criterion_R22", - "text": "Hill_Yield_Criterion_R22" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s13", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s13.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s13", + "title": "s13 > s13 > s13", + "section": "s13 > s13", + "text": "FailureModeEnum.s13 = 250\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R22", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R22.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R22", - "title": "Hill_Yield_Criterion_R22 > Hill_Yield_Criterion_R22 > Hill_Yield_Criterion_R22", - "section": "Hill_Yield_Criterion_R22 > Hill_Yield_Criterion_R22", - "text": "MaterialProperty.Hill_Yield_Criterion_R22: str = 'yield_stress_ratio_y_hill_criterion'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.replace", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.replace.html#replace", + "title": "replace", + "section": "replace", + "text": "Return a copy with all occurrences of substring old replaced by new.\nMaximum number of occurrences to replace.\n-1 (the default value) means replace all occurrences.\nIf the optional argument count is given, only the first count occurrences are\nreplaced.\nreplace" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.translate", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.translate.html#translate", - "title": "translate", - "section": "translate", - "text": "Replace each character in the string using the given translation table.\nTranslation table, which must be a mapping of Unicode ordinals to\nUnicode ordinals, strings, or None.\nThe table must implement lookup/indexing via __getitem__, for instance a\ndictionary or list. If this operation raises LookupError, the character is\nleft untouched. Characters mapped to None are deleted.\ntranslate" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.replace", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.replace.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.replace", + "title": "replace > replace > replace", + "section": "replace > replace", + "text": "FailureMeasureEnum.replace(old, new, /, count=-1)\n\nReturn a copy with all occurrences of substring old replaced by new.\n\ncount\n\nMaximum number of occurrences to replace.\n-1 (the default value) means replace all occurrences.\n\nIf the optional argument count is given, only the first count occurrences are\nreplaced.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.translate", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.translate.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.translate", - "title": "translate > translate > translate", - "section": "translate > translate", - "text": "FailureMeasureEnum.translate(table, /)\n\nReplace each character in the string using the given translation table.\n\ntable\n\nTranslation table, which must be a mapping of Unicode ordinals to\nUnicode ordinals, strings, or None.\n\nThe table must implement lookup/indexing via __getitem__, for instance a\ndictionary or list. If this operation raises LookupError, the character is\nleft untouched. Characters mapped to None are deleted.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.lstrip", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.lstrip.html#lstrip", + "title": "lstrip", + "section": "lstrip", + "text": "Return a copy of the string with leading whitespace removed.\nIf chars is given and not None, remove characters in chars instead.\nlstrip" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxy", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxy.html#esxy", - "title": "eSxy", - "section": "eSxy", - "text": "Global strain limit in material direction 12.\nfloat\neSxy\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.lstrip", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.lstrip.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.lstrip", + "title": "lstrip > lstrip > lstrip", + "section": "lstrip > lstrip", + "text": "FailureMeasureEnum.lstrip(chars=None, /)\n\nReturn a copy of the string with leading whitespace removed.\n\nIf chars is given and not None, remove characters in chars instead.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxy", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxy.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxy", - "title": "eSxy > eSxy > eSxy", - "section": "eSxy > eSxy", - "text": "property MaxStrainCriterion.eSxy: float\n\nGlobal strain limit in material direction 12.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1c", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1c.html#s1c", + "title": "s1c", + "section": "s1c", + "text": "s1c" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_dict.html#to_dict", - "title": "to_dict", - "section": "to_dict", - "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1c", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s1c.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s1c", + "title": "s1c > s1c > s1c", + "section": "s1c > s1c", + "text": "FailureModeEnum.s1c = 212\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.to_dict", - "title": "to_dict > to_dict > to_dict", - "section": "to_dict > to_dict", - "text": "FaceSheetWrinklingCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmt1", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmt1.html#lmt1", + "title": "lmt1", + "section": "lmt1", + "text": "lmt1" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_analysis_plies", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_analysis_plies.html#get_analysis_plies", - "title": "get_analysis_plies", - "section": "get_analysis_plies", - "text": "Get analysis ply names.\nThis method returns None if the element is not layered.\nelement_id (int) – Element ID or label.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nThe dictionary only contains the analysis plies in the specified composite\ndefinition.\nOptional[Sequence[str]]\nget_analysis_plies\nNone\nint\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nOptional\nSequence\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmt1", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmt1.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.lmt1", + "title": "lmt1 > lmt1 > lmt1", + "section": "lmt1 > lmt1", + "text": "FailureModeEnum.lmt1 = 904\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_analysis_plies", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_analysis_plies.html#ansys.dpf.composites.composite_model.CompositeModel.get_analysis_plies", - "title": "get_analysis_plies > get_analysis_plies > get_analysis_plies", - "section": "get_analysis_plies > get_analysis_plies", - "text": "CompositeModel.get_analysis_plies(element_id, composite_definition_label=None)\n\nGet analysis ply names.\n\nThis method returns None if the element is not layered.\n\nParameters\n\nelement_id (int) – Element ID or label.\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nThe dictionary only contains the analysis plies in the specified composite\ndefinition.\n\nReturn type\n\nOptional[Sequence[str]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rsplit", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rsplit.html#rsplit", + "title": "rsplit", + "section": "rsplit", + "text": "Return a list of the substrings in the string, using sep as the separator string.\nThe separator used to split the string.\nWhen set to None (the default value), will split on any whitespace\ncharacter (including n r t f and spaces) and will discard\nempty strings from the result.\nMaximum number of splits.\n-1 (the default value) means no limit.\nSplitting starts at the end of the string and works to the front.\nrsplit" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.th", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.th.html#th", - "title": "th", - "section": "th", - "text": "th" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rsplit", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rsplit.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.rsplit", + "title": "rsplit > rsplit > rsplit", + "section": "rsplit > rsplit", + "text": "FailureMeasureEnum.rsplit(/, sep=None, maxsplit=-1)\n\nReturn a list of the substrings in the string, using sep as the separator string.\n\nsep\n\nThe separator used to split the string.\n\nWhen set to None (the default value), will split on any whitespace\ncharacter (including n r t f and spaces) and will discard\nempty strings from the result.\n\nmaxsplit\n\nMaximum number of splits.\n-1 (the default value) means no limit.\n\nSplitting starts at the end of the string and works to the front.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.th", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.th.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.th", - "title": "th > th > th", - "section": "th > th", - "text": "FailureModeEnum.th = 500\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.server_helpers.upload_continuous_fiber_composite_files_to_server", + "href": "api/_autosummary/ansys.dpf.composites.server_helpers.upload_continuous_fiber_composite_files_to_server.html#upload_continuous_fiber_composite_files_to_server", + "title": "upload_continuous_fiber_composite_files_to_server", + "section": "upload_continuous_fiber_composite_files_to_server", + "text": "Upload continuous fiber composites files to server.\nNote: If server.local_server == True the data_files are returned unmodified.\ndata_files (ContinuousFiberCompositesFiles)\nserver (BaseServer)\nContinuousFiberCompositesFiles\nupload_continuous_fiber_composite_files_to_server\nContinuousFiberCompositesFiles\nBaseServer\nContinuousFiberCompositesFiles" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MAX", - "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MAX.html#max", - "title": "MAX", - "section": "MAX", - "text": "MAX" + "objectID": "api/_autosummary/ansys.dpf.composites.server_helpers.upload_continuous_fiber_composite_files_to_server", + "href": "api/_autosummary/ansys.dpf.composites.server_helpers.upload_continuous_fiber_composite_files_to_server.html#ansys.dpf.composites.server_helpers.upload_continuous_fiber_composite_files_to_server", + "title": "upload_continuous_fiber_composite_files_to_server > upload_continuous_fiber_composite_files_to_server > upload_continuous_fiber_composite_files_to_server", + "section": "upload_continuous_fiber_composite_files_to_server > upload_continuous_fiber_composite_files_to_server", + "text": "ansys.dpf.composites.server_helpers.upload_continuous_fiber_composite_files_to_server(data_files, server)\n\nUpload continuous fiber composites files to server.\n\nNote: If server.local_server == True the data_files are returned unmodified.\n\nParameters\n\ndata_files (ContinuousFiberCompositesFiles)\n\nserver (BaseServer)\n\nReturn type\n\nContinuousFiberCompositesFiles\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MAX", - "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MAX.html#ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.MAX", - "title": "MAX > MAX > MAX", - "section": "MAX > MAX", - "text": "SpotReductionStrategy.MAX = 'MAX'\n\n" + "objectID": "api/index", + "href": "api/index.html#api-reference", + "title": "API reference", + "section": "API reference", + "text": "This section describes the public classes, methods, and attributes of the PyDPF - Composites API.\nFor in-depth documentation on the different failure criteria, refer to the ACP help.\nAPI reference" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.zfill", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.zfill.html#zfill", - "title": "zfill", - "section": "zfill", - "text": "Pad a numeric string with zeros on the left, to fill a field of the given width.\nThe string is never truncated.\nzfill" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.html#layerproperty", + "title": "LayerProperty", + "section": "LayerProperty", + "text": "Provides the layer properties available.\nLayerProperty.THICKNESSES\n\nLayerProperty.ANGLES\n\nLayerProperty.SHEAR_ANGLES\n\nLayerProperty\nLayerProperty.THICKNESSES\nLayerProperty.ANGLES\nLayerProperty.SHEAR_ANGLES" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.zfill", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.zfill.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.zfill", - "title": "zfill > zfill > zfill", - "section": "zfill > zfill", - "text": "FailureMeasureEnum.zfill(width, /)\n\nPad a numeric string with zeros on the left, to fill a field of the given width.\n\nThe string is never truncated.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.html#ansys.dpf.composites.layup_info.LayerProperty", + "title": "LayerProperty > LayerProperty > LayerProperty", + "section": "LayerProperty > LayerProperty", + "text": "class ansys.dpf.composites.layup_info.LayerProperty(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nProvides the layer properties available.\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nLayerProperty.THICKNESSES\n\n\n\nLayerProperty.ANGLES\n\n\n\nLayerProperty.SHEAR_ANGLES\n\n\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cft", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cft.html#cft", - "title": "cft", - "section": "cft", - "text": "Activates the failure evaluation regarding tension in fiber direction.\nbool\ncft\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.rst", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.rst.html#rst", + "title": "rst", + "section": "rst", + "text": "rst" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cft", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cft.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.cft", - "title": "cft > cft > cft", - "section": "cft > cft", - "text": "property CuntzeCriterion.cft: bool\n\nActivates the failure evaluation regarding tension in fiber direction.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.rst", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.rst.html#ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.rst", + "title": "rst > rst > rst", + "section": "rst > rst", + "text": "ShortFiberCompositesFiles.rst: list[str | PathLike[str]]\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.replace", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.replace.html#replace", - "title": "replace", - "section": "replace", - "text": "Return a copy with all occurrences of substring old replaced by new.\nMaximum number of occurrences to replace.\n-1 (the default value) means replace all occurrences.\nIf the optional argument count is given, only the first count occurrences are\nreplaced.\nreplace" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G12", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G12.html#engineering_constants_g12", + "title": "Engineering_Constants_G12", + "section": "Engineering_Constants_G12", + "text": "Engineering_Constants_G12" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.replace", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.replace.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.replace", - "title": "replace > replace > replace", - "section": "replace > replace", - "text": "FailureMeasureEnum.replace(old, new, /, count=-1)\n\nReturn a copy with all occurrences of substring old replaced by new.\n\ncount\n\nMaximum number of occurrences to replace.\n-1 (the default value) means replace all occurrences.\n\nIf the optional argument count is given, only the first count occurrences are\nreplaced.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G12", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G12.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G12", + "title": "Engineering_Constants_G12 > Engineering_Constants_G12 > Engineering_Constants_G12", + "section": "Engineering_Constants_G12 > Engineering_Constants_G12", + "text": "MaterialProperty.Engineering_Constants_G12: str = 'shear_modulus_xy'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.upper", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.upper.html#upper", - "title": "upper", - "section": "upper", - "text": "Return a copy of the string converted to uppercase.\nupper" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_neg", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_neg.html#puck_constants_p_22_neg", + "title": "Puck_Constants_p_22_neg", + "section": "Puck_Constants_p_22_neg", + "text": "Puck_Constants_p_22_neg" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.upper", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.upper.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.upper", - "title": "upper > upper > upper", - "section": "upper > upper", - "text": "FailureMeasureEnum.upper(/)\n\nReturn a copy of the string converted to uppercase.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_neg", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_neg.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_neg", + "title": "Puck_Constants_p_22_neg > Puck_Constants_p_22_neg > Puck_Constants_p_22_neg", + "section": "Puck_Constants_p_22_neg > Puck_Constants_p_22_neg", + "text": "MaterialProperty.Puck_Constants_p_22_neg: str = 'compressive_inclination_yz_puck_constants'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc5", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc5.html#lmc5", - "title": "lmc5", - "section": "lmc5", - "text": "lmc5" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.failure_criteria", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.failure_criteria.html#failure_criteria", + "title": "failure_criteria", + "section": "failure_criteria", + "text": "List of failure criteria. Use insert and remove to edit the list.\ndict[str, FailureCriterionBase]\nfailure_criteria\ndict\nstr\nFailureCriterionBase" }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc5", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc5.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc5", - "title": "lmc5 > lmc5 > lmc5", - "section": "lmc5 > lmc5", - "text": "FailureModeEnum.lmc5 = 906\n\n" + { + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.failure_criteria", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.failure_criteria.html#ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.failure_criteria", + "title": "failure_criteria > failure_criteria > failure_criteria", + "section": "failure_criteria > failure_criteria", + "text": "property CombinedFailureCriterion.failure_criteria: dict[str, FailureCriterionBase]\n\nList of failure criteria. Use insert and remove to edit the list.\n\nReturn type\n\ndict[str, FailureCriterionBase]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_dict.html#to_dict", - "title": "to_dict", - "section": "to_dict", - "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.swapcase", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.swapcase.html#swapcase", + "title": "swapcase", + "section": "swapcase", + "text": "Convert uppercase characters to lowercase and lowercase characters to uppercase.\nswapcase" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.to_dict", - "title": "to_dict > to_dict > to_dict", - "section": "to_dict > to_dict", - "text": "MaxStrainCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.swapcase", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.swapcase.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.swapcase", + "title": "swapcase > swapcase > swapcase", + "section": "swapcase > swapcase", + "text": "FailureMeasureEnum.swapcase(/)\n\nConvert uppercase characters to lowercase and lowercase characters to uppercase.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids_for_composite_definition_label", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids_for_composite_definition_label.html#get_all_layered_element_ids_for_composite_definition_label", - "title": "get_all_layered_element_ids_for_composite_definition_label", - "section": "get_all_layered_element_ids_for_composite_definition_label", - "text": "Get all layered element IDs that belong to a composite definition label.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nSequence[int]\nget_all_layered_element_ids_for_composite_definition_label\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nSequence\nint" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e1", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e1.html#e1", + "title": "e1", + "section": "e1", + "text": "Strains in the material 1 direction of each ply.\nndarray[Any, dtype[float64]]\ne1\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids_for_composite_definition_label", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids_for_composite_definition_label.html#ansys.dpf.composites.composite_model.CompositeModel.get_all_layered_element_ids_for_composite_definition_label", - "title": "get_all_layered_element_ids_for_composite_definition_label > get_all_layered_element_ids_for_composite_definition_label > get_all_layered_element_ids_for_composite_definition_label", - "section": "get_all_layered_element_ids_for_composite_definition_label > get_all_layered_element_ids_for_composite_definition_label", - "text": "CompositeModel.get_all_layered_element_ids_for_composite_definition_label(composite_definition_label=None)\n\nGet all layered element IDs that belong to a composite definition label.\n\nParameters\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\n\nReturn type\n\nSequence[int]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e1", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e1.html#ansys.dpf.composites.sampling_point.SamplingPoint.e1", + "title": "e1 > e1 > e1", + "section": "e1 > e1", + "text": "property SamplingPoint.e1: ndarray[Any, dtype[float64]]\n\nStrains in the material 1 direction of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmt1", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmt1.html#lmt1", - "title": "lmt1", - "section": "lmt1", - "text": "lmt1" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_yz", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_yz.html#tsai_wu_constant_yz", + "title": "Tsai_Wu_Constant_yz", + "section": "Tsai_Wu_Constant_yz", + "text": "Tsai_Wu_Constant_yz" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmt1", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmt1.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.lmt1", - "title": "lmt1 > lmt1 > lmt1", - "section": "lmt1 > lmt1", - "text": "FailureModeEnum.lmt1 = 904\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_yz", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_yz.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Tsai_Wu_Constant_yz", + "title": "Tsai_Wu_Constant_yz > Tsai_Wu_Constant_yz > Tsai_Wu_Constant_yz", + "section": "Tsai_Wu_Constant_yz > Tsai_Wu_Constant_yz", + "text": "MaterialProperty.Tsai_Wu_Constant_yz: str = 'coupling_coef_yz_tsai_wu'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmA", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmA.html#pma", - "title": "pmA", - "section": "pmA", - "text": "pmA" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s1", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s1.html#wf_s1", + "title": "wf_s1", + "section": "wf_s1", + "text": "Weighting factor of the failure mode s1.\nfloat\nwf_s1\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmA", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmA.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.pmA", - "title": "pmA > pmA > pmA", - "section": "pmA > pmA", - "text": "FailureModeEnum.pmA = 802\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s1", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s1.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s1", + "title": "wf_s1 > wf_s1 > wf_s1", + "section": "wf_s1 > wf_s1", + "text": "property MaxStressCriterion.wf_s1: float\n\nWeighting factor of the failure mode s1.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.get_layer_index_by_element_id", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.get_layer_index_by_element_id.html#get_layer_index_by_element_id", - "title": "get_layer_index_by_element_id", - "section": "get_layer_index_by_element_id", - "text": "Get the layer index for the analysis ply in a given element.\nelement_id (int) – Element Id/Label\nOptional[int64]\nget_layer_index_by_element_id\nint\nOptional\nint64" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s12", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s12.html#s12", + "title": "s12", + "section": "s12", + "text": "Whether to activate the failure evaluation regarding the in-plane shear stress s12.\nbool\ns12\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.get_layer_index_by_element_id", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.get_layer_index_by_element_id.html#ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.get_layer_index_by_element_id", - "title": "get_layer_index_by_element_id > get_layer_index_by_element_id > get_layer_index_by_element_id", - "section": "get_layer_index_by_element_id > get_layer_index_by_element_id", - "text": "AnalysisPlyInfoProvider.get_layer_index_by_element_id(element_id)\n\nGet the layer index for the analysis ply in a given element.\n\nParameters\n\nelement_id (int) – Element Id/Label\n\nReturn type\n\nOptional[int64]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s12", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s12.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.s12", + "title": "s12 > s12 > s12", + "section": "s12 > s12", + "text": "property MaxStressCriterion.s12: bool\n\nWhether to activate the failure evaluation regarding the in-plane shear stress s12.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.RST", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.RST.html#rst", - "title": "RST", - "section": "RST", - "text": "RST" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.composite", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.composite.html#composite", + "title": "composite", + "section": "composite", + "text": "composite" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.RST", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.RST.html#ansys.dpf.composites.layup_info.LayupModelContextType.RST", - "title": "RST > RST > RST", - "section": "RST > RST", - "text": "LayupModelContextType.RST = 2\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.composite", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.composite.html#ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.composite", + "title": "composite > composite > composite", + "section": "composite > composite", + "text": "ContinuousFiberCompositesFiles.composite: dict[str, CompositeDefinitionFiles]\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lft", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lft.html#lft", - "title": "lft", - "section": "lft", - "text": "Whether to activate the failure evaluation regarding tension in fiber direction.\nbool\nlft\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E1", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E1.html#engineering_constants_e1", + "title": "Engineering_Constants_E1", + "section": "Engineering_Constants_E1", + "text": "Engineering_Constants_E1" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lft", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lft.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.lft", - "title": "lft > lft > lft", - "section": "lft > lft", - "text": "property LaRCCriterion.lft: bool\n\nWhether to activate the failure evaluation regarding tension in fiber direction.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E1", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E1.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E1", + "title": "Engineering_Constants_E1 > Engineering_Constants_E1 > Engineering_Constants_E1", + "section": "Engineering_Constants_E1 > Engineering_Constants_E1", + "text": "MaterialProperty.Engineering_Constants_E1: str = 'young_modulus_x_direction'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.html#resultdefinitionscope", - "title": "ResultDefinitionScope", - "section": "ResultDefinitionScope", - "text": "Provides the result definition scope.\nResultDefinitionScope.mapping_file\nPath to the mapping file for all element labels in the element scope.\nResultDefinitionScope.write_data_for_full_element_scope\nWhether to write the data for all element labels in the element scope.\nResultDefinitionScope.composite_definition\n\nResultDefinitionScope.element_scope\n\nResultDefinitionScope.ply_scope\n\nResultDefinitionScope.named_selection_scope\nAssembly files that define the mapping of the labels.\nResultDefinitionScope\nResultDefinitionScope.mapping_file\nResultDefinitionScope.write_data_for_full_element_scope\nResultDefinitionScope.composite_definition\nResultDefinitionScope.element_scope\nResultDefinitionScope.ply_scope\nResultDefinitionScope.named_selection_scope" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Spot.TOP", + "href": "api/_autosummary/ansys.dpf.composites.constants.Spot.TOP.html#top", + "title": "TOP", + "section": "TOP", + "text": "TOP" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.html#ansys.dpf.composites.result_definition.ResultDefinitionScope", - "title": "ResultDefinitionScope > ResultDefinitionScope > ResultDefinitionScope", - "section": "ResultDefinitionScope > ResultDefinitionScope", - "text": "class ansys.dpf.composites.result_definition.ResultDefinitionScope(composite_definition, element_scope=, ply_scope=, named_selection_scope=, mapping_file=None, write_data_for_full_element_scope=True)\n\nProvides the result definition scope.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nResultDefinitionScope.mapping_file\n\nPath to the mapping file for all element labels in the element scope.\n\nResultDefinitionScope.write_data_for_full_element_scope\n\nWhether to write the data for all element labels in the element scope.\n\nResultDefinitionScope.composite_definition\n\n\n\nResultDefinitionScope.element_scope\n\n\n\nResultDefinitionScope.ply_scope\n\n\n\nResultDefinitionScope.named_selection_scope\n\nAssembly files that define the mapping of the labels.\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Spot.TOP", + "href": "api/_autosummary/ansys.dpf.composites.constants.Spot.TOP.html#ansys.dpf.composites.constants.Spot.TOP", + "title": "TOP > TOP > TOP", + "section": "TOP > TOP", + "text": "Spot.TOP = 3\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.dim", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.dim.html#dim", - "title": "dim", - "section": "dim", - "text": "Specifies which formulation of the failure criterion is used.\nint\ndim\nint" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.margin_of_safety", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.margin_of_safety.html#margin_of_safety", + "title": "margin_of_safety", + "section": "margin_of_safety", + "text": "Lowest margin of safety of each ply.\nThis attribute is equivalent to the safety margin.\nndarray[Any, dtype[float64]]\nmargin_of_safety\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.dim", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.dim.html#ansys.dpf.composites.failure_criteria.TsaiWuCriterion.dim", - "title": "dim > dim > dim", - "section": "dim > dim", - "text": "property TsaiWuCriterion.dim: int\n\nSpecifies which formulation of the failure criterion is used.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.margin_of_safety", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.margin_of_safety.html#ansys.dpf.composites.sampling_point.SamplingPoint.margin_of_safety", + "title": "margin_of_safety > margin_of_safety > margin_of_safety", + "section": "margin_of_safety > margin_of_safety", + "text": "property SamplingPoint.margin_of_safety: ndarray[Any, dtype[float64]]\n\nLowest margin of safety of each ply.\n\nThis attribute is equivalent to the safety margin.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pmc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pmc.html#pmc", - "title": "pmc", - "section": "pmc", - "text": "Whether to activate the failure evaluation regarding matrix failure due to shear failure.\nbool\npmc\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZt", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZt.html#strain_limits_ezt", + "title": "Strain_Limits_eZt", + "section": "Strain_Limits_eZt", + "text": "Strain_Limits_eZt" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pmc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pmc.html#ansys.dpf.composites.failure_criteria.PuckCriterion.pmc", - "title": "pmc > pmc > pmc", - "section": "pmc > pmc", - "text": "property PuckCriterion.pmc: bool\n\nWhether to activate the failure evaluation regarding matrix failure due to shear failure.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZt", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZt.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZt", + "title": "Strain_Limits_eZt > Strain_Limits_eZt > Strain_Limits_eZt", + "section": "Strain_Limits_eZt > Strain_Limits_eZt", + "text": "MaterialProperty.Strain_Limits_eZt: str = 'strain_tensile_z_direction'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.figure", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.figure.html#figure", - "title": "figure", - "section": "figure", - "text": "figure" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s2", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s2.html#wf_s2", + "title": "wf_s2", + "section": "wf_s2", + "text": "Weighting factor of the failure mode s2.\nfloat\nwf_s2\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.figure", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.figure.html#ansys.dpf.composites.sampling_point.SamplingPointFigure.figure", - "title": "figure > figure > figure", - "section": "figure > figure", - "text": "SamplingPointFigure.figure: Any\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s2", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s2.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s2", + "title": "wf_s2 > wf_s2 > wf_s2", + "section": "wf_s2 > wf_s2", + "text": "property MaxStressCriterion.wf_s2: float\n\nWeighting factor of the failure mode s2.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rindex", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rindex.html#rindex", - "title": "rindex", - "section": "rindex", - "text": "Return the highest index in S where substring sub is found, such that sub is contained within S[start:end].\nOptional arguments start and end are interpreted as in slice notation.\nRaises ValueError when the substring is not found.\nrindex" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s12", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s12.html#s12", + "title": "s12", + "section": "s12", + "text": "In-plane shear stresses s12 of each ply.\nndarray[Any, dtype[float64]]\ns12\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rindex", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rindex.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.rindex", - "title": "rindex > rindex > rindex", - "section": "rindex > rindex", - "text": "FailureMeasureEnum.rindex(sub, [start, [end]], /)\n\nReturn the highest index in S where substring sub is found, such that sub is contained within S[start:end].\n\nOptional arguments start and end are interpreted as in slice notation.\nRaises ValueError when the substring is not found.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s12", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s12.html#ansys.dpf.composites.sampling_point.SamplingPoint.s12", + "title": "s12 > s12 > s12", + "section": "s12 > s12", + "text": "property SamplingPoint.s12: ndarray[Any, dtype[float64]]\n\nIn-plane shear stresses s12 of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXt", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXt.html#ext", - "title": "eXt", - "section": "eXt", - "text": "Global tensile strain limit in material direction 1.\nfloat\neXt\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K1", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K1.html#thermal_conductivity_k1", + "title": "Thermal_Conductivity_K1", + "section": "Thermal_Conductivity_K1", + "text": "Thermal_Conductivity_K1" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXt", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXt.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eXt", - "title": "eXt > eXt > eXt", - "section": "eXt > eXt", - "text": "property MaxStrainCriterion.eXt: float\n\nGlobal tensile strain limit in material direction 1.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K1", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K1.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K1", + "title": "Thermal_Conductivity_K1 > Thermal_Conductivity_K1 > Thermal_Conductivity_K1", + "section": "Thermal_Conductivity_K1 > Thermal_Conductivity_K1", + "text": "MaterialProperty.Thermal_Conductivity_K1: str = 'thermal_conductivity_x_direction'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.THICKNESSES", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.THICKNESSES.html#thicknesses", - "title": "THICKNESSES", - "section": "THICKNESSES", - "text": "THICKNESSES" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.force_global_constants", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.force_global_constants.html#force_global_constants", + "title": "force_global_constants", + "section": "force_global_constants", + "text": "Whether to use global constants instead of the material-wise properties.\nbool\nforce_global_constants\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.THICKNESSES", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayerProperty.THICKNESSES.html#ansys.dpf.composites.layup_info.LayerProperty.THICKNESSES", - "title": "THICKNESSES > THICKNESSES > THICKNESSES", - "section": "THICKNESSES > THICKNESSES", - "text": "LayerProperty.THICKNESSES = 0\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.force_global_constants", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.force_global_constants.html#ansys.dpf.composites.failure_criteria.PuckCriterion.force_global_constants", + "title": "force_global_constants > force_global_constants > force_global_constants", + "section": "force_global_constants > force_global_constants", + "text": "property PuckCriterion.force_global_constants: bool\n\nWhether to use global constants instead of the material-wise properties.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rsplit", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rsplit.html#rsplit", - "title": "rsplit", - "section": "rsplit", - "text": "Return a list of the substrings in the string, using sep as the separator string.\nThe separator used to split the string.\nWhen set to None (the default value), will split on any whitespace\ncharacter (including n r t f and spaces) and will discard\nempty strings from the result.\nMaximum number of splits.\n-1 (the default value) means no limit.\nSplitting starts at the end of the string and works to the front.\nrsplit" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmA", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmA.html#cma", + "title": "cmA", + "section": "cmA", + "text": "cmA" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rsplit", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rsplit.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.rsplit", - "title": "rsplit > rsplit > rsplit", - "section": "rsplit > rsplit", - "text": "FailureMeasureEnum.rsplit(/, sep=None, maxsplit=-1)\n\nReturn a list of the substrings in the string, using sep as the separator string.\n\nsep\n\nThe separator used to split the string.\n\nWhen set to None (the default value), will split on any whitespace\ncharacter (including n r t f and spaces) and will discard\nempty strings from the result.\n\nmaxsplit\n\nMaximum number of splits.\n-1 (the default value) means no limit.\n\nSplitting starts at the end of the string and works to the front.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmA", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmA.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.cmA", + "title": "cmA > cmA > cmA", + "section": "cmA > cmA", + "text": "FailureModeEnum.cmA = 1003\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.html#compositedatasources", - "title": "CompositeDataSources", - "section": "CompositeDataSources", - "text": "Provides data sources related to the composite lay-up.\nrst (ansys.dpf.core.data_sources.DataSources) – Result file. Currently only RST (MAPDL) is supported.\nmaterial_support (ansys.dpf.core.data_sources.DataSources) – NOTE: The material_support parameter is explicitly listed because it is currently not\nsupported (by the DPF Core) to use a distributed RST file as source for the\nmaterial support. Instead, we create a separate DataSources object for the\nmaterial support from the first RST file. This is a workaround until the\nsupport for distributed RST is added.\nengineering_data (ansys.dpf.core.data_sources.DataSources) – File with the material properties.\nold_composite_sources (dict[str, ansys.dpf.core.data_sources.DataSources]) – Member used to support assemblies in combination with the old\nDPF server (<7.0). It should be removed once the support of this\nserver version is dropped.\nCompositeDataSources.rst\n\nCompositeDataSources.material_support\n\nCompositeDataSources.composite\n\nCompositeDataSources.engineering_data\n\nCompositeDataSources.old_composite_sources\n\nCompositeDataSources\nmaterial_support\nCompositeDataSources.rst\nCompositeDataSources.material_support\nCompositeDataSources.composite\nCompositeDataSources.engineering_data\nCompositeDataSources.old_composite_sources" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zt", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zt.html#stress_limits_zt", + "title": "Stress_Limits_Zt", + "section": "Stress_Limits_Zt", + "text": "Stress_Limits_Zt" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.html#ansys.dpf.composites.data_sources.CompositeDataSources", - "title": "CompositeDataSources > CompositeDataSources > CompositeDataSources", - "section": "CompositeDataSources > CompositeDataSources", - "text": "class ansys.dpf.composites.data_sources.CompositeDataSources(rst, material_support, composite, engineering_data, old_composite_sources)\n\nProvides data sources related to the composite lay-up.\n\nParameters\n\nrst (ansys.dpf.core.data_sources.DataSources) – Result file. Currently only RST (MAPDL) is supported.\n\nmaterial_support (ansys.dpf.core.data_sources.DataSources) – NOTE: The material_support parameter is explicitly listed because it is currently not\nsupported (by the DPF Core) to use a distributed RST file as source for the\nmaterial support. Instead, we create a separate DataSources object for the\nmaterial support from the first RST file. This is a workaround until the\nsupport for distributed RST is added.\n\nengineering_data (ansys.dpf.core.data_sources.DataSources) – File with the material properties.\n\nold_composite_sources (dict[str, ansys.dpf.core.data_sources.DataSources]) – Member used to support assemblies in combination with the old\nDPF server (<7.0). It should be removed once the support of this\nserver version is dropped.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nCompositeDataSources.rst\n\n\n\nCompositeDataSources.material_support\n\n\n\nCompositeDataSources.composite\n\n\n\nCompositeDataSources.engineering_data\n\n\n\nCompositeDataSources.old_composite_sources\n\n\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zt", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zt.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zt", + "title": "Stress_Limits_Zt > Stress_Limits_Zt > Stress_Limits_Zt", + "section": "Stress_Limits_Zt > Stress_Limits_Zt", + "text": "MaterialProperty.Stress_Limits_Zt: str = 'stress_tensile_z_direction'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p21_neg", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p21_neg.html#p21_neg", - "title": "p21_neg", - "section": "p21_neg", - "text": "Global inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for compression.\nfloat\np21_neg\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vme", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vme.html#wf_vme", + "title": "wf_vme", + "section": "wf_vme", + "text": "Weighting factor of the strain criterion (vme).\nfloat\nwf_vme\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p21_neg", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p21_neg.html#ansys.dpf.composites.failure_criteria.PuckCriterion.p21_neg", - "title": "p21_neg > p21_neg > p21_neg", - "section": "p21_neg > p21_neg", - "text": "property PuckCriterion.p21_neg: float\n\nGlobal inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for compression.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vme", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vme.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.wf_vme", + "title": "wf_vme > wf_vme > wf_vme", + "section": "wf_vme > wf_vme", + "text": "property VonMisesCriterion.wf_vme: float\n\nWeighting factor of the strain criterion (vme).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G23", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G23.html#engineering_constants_g23", - "title": "Engineering_Constants_G23", - "section": "Engineering_Constants_G23", - "text": "Engineering_Constants_G23" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e1", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e1.html#e1", + "title": "e1", + "section": "e1", + "text": "Activates the failure evaluation regarding the strain in the material 1 direction.\nbool\ne1\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G23", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G23.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_G23", - "title": "Engineering_Constants_G23 > Engineering_Constants_G23 > Engineering_Constants_G23", - "section": "Engineering_Constants_G23 > Engineering_Constants_G23", - "text": "MaterialProperty.Engineering_Constants_G23: str = 'shear_modulus_yz'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e1", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e1.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e1", + "title": "e1 > e1 > e1", + "section": "e1 > e1", + "text": "property MaxStrainCriterion.e1: bool\n\nActivates the failure evaluation regarding the strain in the material 1 direction.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.dsdat", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.dsdat.html#dsdat", - "title": "dsdat", - "section": "dsdat", - "text": "dsdat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_json.html#to_json", + "title": "to_json", + "section": "to_json", + "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.dsdat", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.dsdat.html#ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.dsdat", - "title": "dsdat > dsdat > dsdat", - "section": "dsdat > dsdat", - "text": "ShortFiberCompositesFiles.dsdat: str | PathLike[str]\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_json.html#ansys.dpf.composites.failure_criteria.CoreFailureCriterion.to_json", + "title": "to_json > to_json > to_json", + "section": "to_json > to_json", + "text": "CoreFailureCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hd", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hd.html#hd", - "title": "hd", - "section": "hd", - "text": "Whether to activate the failure evaluation regarding delamination if dim is equal to 3.\nbool\nhd\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e1", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e1.html#wf_e1", + "title": "wf_e1", + "section": "wf_e1", + "text": "Weighting factor of the failure mode e1.\nfloat\nwf_e1\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hd", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hd.html#ansys.dpf.composites.failure_criteria.HashinCriterion.hd", - "title": "hd > hd > hd", - "section": "hd > hd", - "text": "property HashinCriterion.hd: bool\n\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e1", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e1.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e1", + "title": "wf_e1 > wf_e1 > wf_e1", + "section": "wf_e1 > wf_e1", + "text": "property MaxStrainCriterion.wf_e1: float\n\nWeighting factor of the failure mode e1.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.files_are_local", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.files_are_local.html#files_are_local", - "title": "files_are_local", - "section": "files_are_local", - "text": "files_are_local" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.add_layup_info_to_mesh", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.add_layup_info_to_mesh.html#add_layup_info_to_mesh", + "title": "add_layup_info_to_mesh", + "section": "add_layup_info_to_mesh", + "text": "Add lay-up information to the mesh.\nCreates a lay-up provider operator that is run and returned.\ndata_sources (CompositeDataSources) – DPF data sources available from the CompositeModel.data_sources attribute.\nmesh (MeshedRegion) – DPF meshed region available from the CompositeModel.get_mesh() method.\nmaterial_operators (MaterialOperators) – MaterialOperators object available from the CompositeModel.material_operators\nattribute.\nunit_system (Optional[Union[UnitSystem, Operator]], default: None) – Unit system specification\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nrst_stream_provider (Optional[Operator], default: None) – Pass RST stream to load the section data directly from the RST file. This parameter is\nsupported in DPF version 8.0 (2024 R2) and later.\nOperator\nadd_layup_info_to_mesh\nCompositeDataSources\nCompositeModel.data_sources\nMeshedRegion\nCompositeModel.get_mesh()\nMaterialOperators\nCompositeModel.material_operators\nOptional\nUnion\nUnitSystem\nOperator\nNone\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nOptional\nOperator\nNone\nOperator" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.files_are_local", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.files_are_local.html#ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.files_are_local", - "title": "files_are_local > files_are_local > files_are_local", - "section": "files_are_local > files_are_local", - "text": "ShortFiberCompositesFiles.files_are_local: bool = True\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.add_layup_info_to_mesh", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.add_layup_info_to_mesh.html#ansys.dpf.composites.layup_info.add_layup_info_to_mesh", + "title": "add_layup_info_to_mesh > add_layup_info_to_mesh > add_layup_info_to_mesh", + "section": "add_layup_info_to_mesh > add_layup_info_to_mesh", + "text": "ansys.dpf.composites.layup_info.add_layup_info_to_mesh(data_sources, material_operators, mesh, unit_system=None, composite_definition_label=None, rst_stream_provider=None)\n\nAdd lay-up information to the mesh.\n\nCreates a lay-up provider operator that is run and returned.\n\nParameters\n\ndata_sources (CompositeDataSources) – DPF data sources available from the CompositeModel.data_sources attribute.\n\nmesh (MeshedRegion) – DPF meshed region available from the CompositeModel.get_mesh() method.\n\nmaterial_operators (MaterialOperators) – MaterialOperators object available from the CompositeModel.material_operators\nattribute.\n\nunit_system (Optional[Union[UnitSystem, Operator]], default: None) – Unit system specification\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\n\nrst_stream_provider (Optional[Operator], default: None) – Pass RST stream to load the section data directly from the RST file. This parameter is\nsupported in DPF version 8.0 (2024 R2) and later.\n\nReturn type\n\nOperator\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.rst", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.rst.html#rst", - "title": "rst", - "section": "rst", - "text": "rst" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.number_of_plies", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.number_of_plies.html#number_of_plies", + "title": "number_of_plies", + "section": "number_of_plies", + "text": "Number of plies.\nint\nnumber_of_plies\nint" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.rst", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.rst.html#ansys.dpf.composites.data_sources.CompositeDataSources.rst", - "title": "rst > rst > rst", - "section": "rst > rst", - "text": "CompositeDataSources.rst: DataSources\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.number_of_plies", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.number_of_plies.html#ansys.dpf.composites.sampling_point.SamplingPoint.number_of_plies", + "title": "number_of_plies > number_of_plies > number_of_plies", + "section": "number_of_plies > number_of_plies", + "text": "property SamplingPoint.number_of_plies: int\n\nNumber of plies.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.html#compositemodel", - "title": "CompositeModel", - "section": "CompositeModel", - "text": "Provides access to the basic composite postprocessing functionality.\nOn initialization, the CompositeModel class automatically adds composite lay-up\ninformation to the meshed regions. It prepares the providers for different lay-up properties\nso that they can be efficiently evaluated. The composite_files provided are automatically\nuploaded to the server if needed.\nWhen creating a CompositeModel instance, several providers are created and\nlay-up information is added to the DPF meshed regions. Depending on the use\ncase, it can be more efficient to create the providers separately.\nThe handling of models with multiple composite definition files (assemblies)\ndiffer depending on the version of the DPF server. The handling is simplified\nwith DPF Server 7.0 (2024 R1) or later and the full assembly can be post-processed\nin the same way as a model with a single ACP model.\nBefore DPF Server 7.0 (2024 R1):\nFor assemblies with multiple composite definition files, separate meshes and\nlay-up operators are generated (wrapped by the CompositeInfo class). This\nis needed because the lay-up provider can only add the data of a single\ncomposite definitions file to a mesh. All functions that depend on composite\ndefinitions mut be called with the correct composite_definition_label\nparameter. The layered elements that get information from a given\ncomposite definition label can be determined by calling\nCompositeModel.get_all_layered_element_ids_for_composite_definition_label().\nAll the elements that are not part of a composite definition are either homogeneous\nsolids or layered models defined outside of an ACP model. The\nCompositeModel.composite_definition_labels() command returns all available composite\ndefinition labels. For more information, see\nsphx_glr_examples_gallery_examples_008_assembly_example.py.\ncomposite_files (ContinuousFiberCompositesFiles) – Use the get_composite_files_from_workbench_result_folder() function to obtain\nthe ContinuousFiberCompositesFiles object.\nserver (BaseServer) – DPF Server on which the model is created\ndefault_unit_system (Optional[UnitSystem], default: None) – Unit system that is used if the result file\ndoes not specify the unit system. This happens\nfor pure MAPDL projects.\nCompositeModel.add_interlaminar_normal_stresses(...)\nAdd interlaminar normal stresses to the stresses fields container.\nCompositeModel.evaluate_failure_criteria(...)\nGet a fields container with the evaluated failure criteria.\nCompositeModel.get_all_layered_element_ids()\nGet all element IDs with lay-up data.\nCompositeModel.get_all_layered_element_ids_for_composite_definition_label([...])\nGet all layered element IDs that belong to a composite definition label.\nCompositeModel.get_analysis_plies(element_id)\nGet analysis ply names.\nCompositeModel.get_constant_property_dict(...)\nGet a dictionary with constant properties.\nCompositeModel.get_element_info(element_id)\nGet element information for an element ID.\nCompositeModel.get_element_laminate_offset(...)\nGet the laminate offset of an element.\nCompositeModel.get_layup_operator([...])\nGet the lay-up operator.\nCompositeModel.get_mesh([...])\nGet the underlying DPF meshed region.\nCompositeModel.get_property_for_all_layers(...)\nGet a layer property for an element ID.\nCompositeModel.get_result_times_or_frequencies()\nGet the times or frequencies in the result file.\nCompositeModel.get_rst_streams_provider()\nGet the streams provider of the loaded result file.\nCompositeModel.get_sampling_point(...[, ...])\nGet a sampling point for an element ID and failure criteria.\nCompositeModel.composite_definition_labels\nAll composite definition labels in the model.\nCompositeModel.composite_files\nGet the composite file paths on the server.\nCompositeModel.core_model\nUnderlying DPF core model.\nCompositeModel.data_sources\nComposite data sources.\nCompositeModel.layup_model_type\nGet the context type of the lay-up model.\nCompositeModel.material_metadata\nDPF material ID to metadata map of the materials.\nCompositeModel.material_names\nMaterial name to DPF material ID map.\nCompositeModel.material_operators\nMaterial operators.\nCompositeModel\nCompositeModel\nCompositeModel\nCompositeInfo\ncomposite_definition_label\nCompositeModel.get_all_layered_element_ids_for_composite_definition_label()\nCompositeModel.composite_definition_labels()\nContinuousFiberCompositesFiles\nget_composite_files_from_workbench_result_folder()\nContinuousFiberCompositesFiles\nBaseServer\nOptional\nUnitSystem\nNone\nCompositeModel.add_interlaminar_normal_stresses\nCompositeModel.evaluate_failure_criteria\nCompositeModel.get_all_layered_element_ids\nCompositeModel.get_all_layered_element_ids_for_composite_definition_label\nCompositeModel.get_analysis_plies\nCompositeModel.get_constant_property_dict\nCompositeModel.get_element_info\nCompositeModel.get_element_laminate_offset\nCompositeModel.get_layup_operator\nCompositeModel.get_mesh\nCompositeModel.get_property_for_all_layers\nCompositeModel.get_result_times_or_frequencies\nCompositeModel.get_rst_streams_provider\nCompositeModel.get_sampling_point\nCompositeModel.composite_definition_labels\nCompositeModel.composite_files\nCompositeModel.core_model\nCompositeModel.data_sources\nCompositeModel.layup_model_type\nCompositeModel.material_metadata\nCompositeModel.material_names\nCompositeModel.material_operators" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.ply_element_ids", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.ply_element_ids.html#ply_element_ids", + "title": "ply_element_ids", + "section": "ply_element_ids", + "text": "Return list of element labels of the analysis ply.\nSequence[int64]\nply_element_ids\nSequence\nint64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.html#ansys.dpf.composites.composite_model.CompositeModel", - "title": "CompositeModel > CompositeModel > CompositeModel", - "section": "CompositeModel > CompositeModel", - "text": "class ansys.dpf.composites.composite_model.CompositeModel(composite_files, server, default_unit_system=None)\n\nProvides access to the basic composite postprocessing functionality.\n\nOn initialization, the CompositeModel class automatically adds composite lay-up\ninformation to the meshed regions. It prepares the providers for different lay-up properties\nso that they can be efficiently evaluated. The composite_files provided are automatically\nuploaded to the server if needed.\n\nWhen creating a CompositeModel instance, several providers are created and\nlay-up information is added to the DPF meshed regions. Depending on the use\ncase, it can be more efficient to create the providers separately.\n\nThe handling of models with multiple composite definition files (assemblies)\ndiffer depending on the version of the DPF server. The handling is simplified\nwith DPF Server 7.0 (2024 R1) or later and the full assembly can be post-processed\nin the same way as a model with a single ACP model.\n\nBefore DPF Server 7.0 (2024 R1):\n\nFor assemblies with multiple composite definition files, separate meshes and\nlay-up operators are generated (wrapped by the CompositeInfo class). This\nis needed because the lay-up provider can only add the data of a single\ncomposite definitions file to a mesh. All functions that depend on composite\ndefinitions mut be called with the correct composite_definition_label\nparameter. The layered elements that get information from a given\ncomposite definition label can be determined by calling\nCompositeModel.get_all_layered_element_ids_for_composite_definition_label().\nAll the elements that are not part of a composite definition are either homogeneous\nsolids or layered models defined outside of an ACP model. The\nCompositeModel.composite_definition_labels() command returns all available composite\ndefinition labels. For more information, see\nsphx_glr_examples_gallery_examples_008_assembly_example.py.\n\nParameters\n\ncomposite_files (ContinuousFiberCompositesFiles) – Use the get_composite_files_from_workbench_result_folder() function to obtain\nthe ContinuousFiberCompositesFiles object.\n\nserver (BaseServer) – DPF Server on which the model is created\n\ndefault_unit_system (Optional[UnitSystem], default: None) – Unit system that is used if the result file\ndoes not specify the unit system. This happens\nfor pure MAPDL projects.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nCompositeModel.add_interlaminar_normal_stresses(...)\n\nAdd interlaminar normal stresses to the stresses fields container.\n\nCompositeModel.evaluate_failure_criteria(...)\n\nGet a fields container with the evaluated failure criteria.\n\nCompositeModel.get_all_layered_element_ids()\n\nGet all element IDs with lay-up data.\n\nCompositeModel.get_all_layered_element_ids_for_composite_definition_label([...])\n\nGet all layered element IDs that belong to a composite definition label.\n\nCompositeModel.get_analysis_plies(element_id)\n\nGet analysis ply names.\n\nCompositeModel.get_constant_property_dict(...)\n\nGet a dictionary with constant properties.\n\nCompositeModel.get_element_info(element_id)\n\nGet element information for an element ID.\n\nCompositeModel.get_element_laminate_offset(...)\n\nGet the laminate offset of an element.\n\nCompositeModel.get_layup_operator([...])\n\nGet the lay-up operator.\n\nCompositeModel.get_mesh([...])\n\nGet the underlying DPF meshed region.\n\nCompositeModel.get_property_for_all_layers(...)\n\nGet a layer property for an element ID.\n\nCompositeModel.get_result_times_or_frequencies()\n\nGet the times or frequencies in the result file.\n\nCompositeModel.get_rst_streams_provider()\n\nGet the streams provider of the loaded result file.\n\nCompositeModel.get_sampling_point(...[, ...])\n\nGet a sampling point for an element ID and failure criteria.\n\n\n\nAttributes\n\n\n\n\n\n\n\nCompositeModel.composite_definition_labels\n\nAll composite definition labels in the model.\n\nCompositeModel.composite_files\n\nGet the composite file paths on the server.\n\nCompositeModel.core_model\n\nUnderlying DPF core model.\n\nCompositeModel.data_sources\n\nComposite data sources.\n\nCompositeModel.layup_model_type\n\nGet the context type of the lay-up model.\n\nCompositeModel.material_metadata\n\nDPF material ID to metadata map of the materials.\n\nCompositeModel.material_names\n\nMaterial name to DPF material ID map.\n\nCompositeModel.material_operators\n\nMaterial operators.\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.ply_element_ids", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.ply_element_ids.html#ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.ply_element_ids", + "title": "ply_element_ids > ply_element_ids > ply_element_ids", + "section": "ply_element_ids > ply_element_ids", + "text": "AnalysisPlyInfoProvider.ply_element_ids()\n\nReturn list of element labels of the analysis ply.\n\nReturn type\n\nSequence[int64]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.istitle", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.istitle.html#istitle", - "title": "istitle", - "section": "istitle", - "text": "Return True if the string is a title-cased string, False otherwise.\nIn a title-cased string, upper- and title-case characters may only\nfollow uncased characters and lowercase characters only cased ones.\nistitle" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.count", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.count.html#count", + "title": "count", + "section": "count", + "text": "Return the number of non-overlapping occurrences of substring sub in string S[start:end].\nOptional arguments start and end are interpreted as in slice notation.\ncount" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.istitle", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.istitle.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.istitle", - "title": "istitle > istitle > istitle", - "section": "istitle > istitle", - "text": "FailureMeasureEnum.istitle(/)\n\nReturn True if the string is a title-cased string, False otherwise.\n\nIn a title-cased string, upper- and title-case characters may only\nfollow uncased characters and lowercase characters only cased ones.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.count", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.count.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.count", + "title": "count > count > count", + "section": "count > count", + "text": "FailureMeasureEnum.count(sub, [start, [end]], /)\n\nReturn the number of non-overlapping occurrences of substring sub in string S[start:end].\n\nOptional arguments start and end are interpreted as in slice notation.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Syz", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Syz.html#stress_limits_syz", - "title": "Stress_Limits_Syz", - "section": "Stress_Limits_Syz", - "text": "Stress_Limits_Syz" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e23", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e23.html#e23", + "title": "e23", + "section": "e23", + "text": "Whether to activate the failure evaluation regarding the interlaminar shear strain e23.\nbool\ne23\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Syz", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Syz.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Syz", - "title": "Stress_Limits_Syz > Stress_Limits_Syz > Stress_Limits_Syz", - "section": "Stress_Limits_Syz > Stress_Limits_Syz", - "text": "MaterialProperty.Stress_Limits_Syz: str = 'stress_shear_yz'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e23", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e23.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.e23", + "title": "e23 > e23 > e23", + "section": "e23 > e23", + "text": "property MaxStrainCriterion.e23: bool\n\nWhether to activate the failure evaluation regarding the interlaminar shear strain e23.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + }, + { + "objectID": "api/failure_criteria", + "href": "api/failure_criteria.html#failure-criteria", + "title": "Failure criteria", + "section": "Failure criteria", + "text": "CombinedFailureCriterion([name, ...])\nDefines the combined failure criterion.\nCoreFailureCriterion(*[, include_ins, wf])\nDefines the core shear failure criterion for core materials like foam and honeycomb.\nCuntzeCriterion(*[, cfc, cft, cma, cmb, ...])\nDefines the Cuntze criterion for uni-directional orthotropic reinforced materials.\nFaceSheetWrinklingCriterion(*[, ...])\nDefines the face sheet wrinkling criterion for sandwiches (laminate with cores).\nHashinCriterion(*[, hf, hm, hd, dim, wf_hf, ...])\nDefines the Hashin failure criterion for UD reinforced materials.\nHoffmanCriterion(*[, active, wf, dim])\nDefines the Hoffman failure criterion for orthotropic reinforced materials.\nLaRCCriterion(*[, lft, lfc, lmt, lmc, dim, ...])\nDefines the LaRC failure criterion for UD reinforced materials.\nMaxStrainCriterion(*[, e1, e2, e3, e12, ...])\nDefines the maximum strain failure criterion for orthotropic reinforced materials.\nMaxStressCriterion(*[, s1, s2, s3, s12, ...])\nDefines the maximum stress failure criterion for orthotropic reinforced materials.\nPuckCriterion(*[, pf, pma, pmb, pmc, pd, ...])\nDefines the Puck failure criterion for UD reinforced materials.\nShearCrimpingCriterion(*[, kc, kf, wf])\nDefines the shear crimping failure criterion for sandwich structures.\nTsaiHillCriterion(*[, active, wf, dim])\nDefines the Tsai-Hill failure criterion for orthotropic reinforced materials.\nTsaiWuCriterion(*[, active, wf, dim])\nDefines the Tsai-Wu failure criterion for orthotropic reinforced materials.\nVonMisesCriterion(*[, vme, vms, wf_vme, ...])\nDefines the von Mises criterion for isotropic materials.\nFailureModeEnum(value[, names, module, ...])\n\nFailure criteria\nCombinedFailureCriterion\nCoreFailureCriterion\nCuntzeCriterion\nFaceSheetWrinklingCriterion\nHashinCriterion\nHoffmanCriterion\nLaRCCriterion\nMaxStrainCriterion\nMaxStressCriterion\nPuckCriterion\nShearCrimpingCriterion\nTsaiHillCriterion\nTsaiWuCriterion\nVonMisesCriterion\nFailureModeEnum" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_json.html#to_json", - "title": "to_json", - "section": "to_json", - "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s23", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s23.html#s23", + "title": "s23", + "section": "s23", + "text": "Out-of-plane shear stresses s23 of each ply.\nndarray[Any, dtype[float64]]\ns23\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_json.html#ansys.dpf.composites.failure_criteria.TsaiWuCriterion.to_json", - "title": "to_json > to_json > to_json", - "section": "to_json > to_json", - "text": "TsaiWuCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s23", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.s23.html#ansys.dpf.composites.sampling_point.SamplingPoint.s23", + "title": "s23 > s23 > s23", + "section": "s23 > s23", + "text": "property SamplingPoint.s23: ndarray[Any, dtype[float64]]\n\nOut-of-plane shear stresses s23 of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cf.html#cf", - "title": "cf", - "section": "cf", - "text": "cf" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.active.html#active", + "title": "active", + "section": "active", + "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cf.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.cf", - "title": "cf > cf > cf", - "section": "cf > cf", - "text": "FailureModeEnum.cf = 310\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.active.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.active", + "title": "active > active > active", + "section": "active > active", + "text": "property MaxStressCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.RESERVE_FACTOR", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.RESERVE_FACTOR.html#reserve_factor", - "title": "RESERVE_FACTOR", - "section": "RESERVE_FACTOR", - "text": "RESERVE_FACTOR" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.html#compositedefinitionfiles", + "title": "CompositeDefinitionFiles", + "section": "CompositeDefinitionFiles", + "text": "Provides the container for composite definition file paths.\nCompositeDefinitionFiles.mapping\n\nCompositeDefinitionFiles.definition\n\nCompositeDefinitionFiles\nCompositeDefinitionFiles.mapping\nCompositeDefinitionFiles.definition" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.RESERVE_FACTOR", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.RESERVE_FACTOR.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.RESERVE_FACTOR", - "title": "RESERVE_FACTOR > RESERVE_FACTOR > RESERVE_FACTOR", - "section": "RESERVE_FACTOR > RESERVE_FACTOR", - "text": "FailureMeasureEnum.RESERVE_FACTOR: str = 'safety_factor'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.html#ansys.dpf.composites.data_sources.CompositeDefinitionFiles", + "title": "CompositeDefinitionFiles > CompositeDefinitionFiles > CompositeDefinitionFiles", + "section": "CompositeDefinitionFiles > CompositeDefinitionFiles", + "text": "class ansys.dpf.composites.data_sources.CompositeDefinitionFiles(definition, mapping=None)\n\nProvides the container for composite definition file paths.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nCompositeDefinitionFiles.mapping\n\n\n\nCompositeDefinitionFiles.definition\n\n\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_angle_under_compression", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_angle_under_compression.html#larc_constants_fracture_angle_under_compression", - "title": "Larc_Constants_fracture_angle_under_compression", - "section": "Larc_Constants_fracture_angle_under_compression", - "text": "Larc_Constants_fracture_angle_under_compression" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.evaluate_failure_criteria", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.evaluate_failure_criteria.html#evaluate_failure_criteria", + "title": "evaluate_failure_criteria", + "section": "evaluate_failure_criteria", + "text": "Get a fields container with the evaluated failure criteria.\nThe fields container contains the maximum per element if the measure\nis FailureMeasureEnum.INVERSE_RESERVE_FACTOR and the minimum per element\nif the measure is FailureMeasureEnum.MARGIN_OF_SAFETY or\nFailureMeasureEnum.RESERVE_FACTOR.\ncombined_criterion (CombinedFailureCriterion) – Combined failure criterion to evaluate.\ncomposite_scope (Optional[CompositeScope], default: None) – Composite scope on which to evaluate the failure criteria. If empty, the criteria\nis evaluated on the full model. If the time is not set, the last time or\nfrequency in the result file is used.\nmeasure (FailureMeasureEnum, default: ) – Failure measure to evaluate.\nwrite_data_for_full_element_scope (bool, default: True) – Whether each element in the element scope is to get a\n(potentially zero) failure value, even elements that are not\npart of composite_scope.plies. If no element scope is\nspecified (composite_scope.elements), a (potentially zero)\nfailure value is written for all elements.\nmax_chunk_size (int, default: 50000) – A higher value results in more memory consumption, but faster evaluation.For some special element types such as beams,\nwrite_data_for_full_element_scope=True is not supported.\nA higher value results in more memory consumption, but faster evaluation.\nFor some special element types such as beams,\nwrite_data_for_full_element_scope=True is not supported.\nFieldsContainer\nevaluate_failure_criteria\nFailureMeasureEnum.INVERSE_RESERVE_FACTOR\nFailureMeasureEnum.MARGIN_OF_SAFETY\nFailureMeasureEnum.RESERVE_FACTOR\nCombinedFailureCriterion\nOptional\nCompositeScope\nNone\nFailureMeasureEnum\n\nbool\nTrue\ncomposite_scope.plies\ncomposite_scope.elements\nint\n50000\nwrite_data_for_full_element_scope=True\nFieldsContainer" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_angle_under_compression", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_angle_under_compression.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_angle_under_compression", - "title": "Larc_Constants_fracture_angle_under_compression > Larc_Constants_fracture_angle_under_compression > Larc_Constants_fracture_angle_under_compression", - "section": "Larc_Constants_fracture_angle_under_compression > Larc_Constants_fracture_angle_under_compression", - "text": "MaterialProperty.Larc_Constants_fracture_angle_under_compression: str = 'fracture_angle_under_compression_larc_constants'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.evaluate_failure_criteria", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.evaluate_failure_criteria.html#ansys.dpf.composites.composite_model.CompositeModel.evaluate_failure_criteria", + "title": "evaluate_failure_criteria > evaluate_failure_criteria > evaluate_failure_criteria", + "section": "evaluate_failure_criteria > evaluate_failure_criteria", + "text": "CompositeModel.evaluate_failure_criteria(combined_criterion, composite_scope=None, measure=FailureMeasureEnum.INVERSE_RESERVE_FACTOR, write_data_for_full_element_scope=True, max_chunk_size=50000)\n\nGet a fields container with the evaluated failure criteria.\n\nThe fields container contains the maximum per element if the measure\nis FailureMeasureEnum.INVERSE_RESERVE_FACTOR and the minimum per element\nif the measure is FailureMeasureEnum.MARGIN_OF_SAFETY or\nFailureMeasureEnum.RESERVE_FACTOR.\n\nParameters\n\ncombined_criterion (CombinedFailureCriterion) – Combined failure criterion to evaluate.\n\ncomposite_scope (Optional[CompositeScope], default: None) – Composite scope on which to evaluate the failure criteria. If empty, the criteria\nis evaluated on the full model. If the time is not set, the last time or\nfrequency in the result file is used.\n\nmeasure (FailureMeasureEnum, default: ) – Failure measure to evaluate.\n\nwrite_data_for_full_element_scope (bool, default: True) – Whether each element in the element scope is to get a\n(potentially zero) failure value, even elements that are not\npart of composite_scope.plies. If no element scope is\nspecified (composite_scope.elements), a (potentially zero)\nfailure value is written for all elements.\n\nmax_chunk_size (int, default: 50000) – A higher value results in more memory consumption, but faster evaluation.For some special element types such as beams,\nwrite_data_for_full_element_scope=True is not supported.\n\nReturn type\n\nFieldsContainer\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e13", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e13.html#e13", - "title": "e13", - "section": "e13", - "text": "Out-of-plane shear strains e13 of each ply.\nndarray[Any, dtype[float64]]\ne13\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy", + "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.html#spotreductionstrategy", + "title": "SpotReductionStrategy", + "section": "SpotReductionStrategy", + "text": "Provides the strategy for getting from spot values (BOT, MID, TOP) to a single value.\nSpotReductionStrategy.MIN\n\nSpotReductionStrategy.MAX\n\nSpotReductionStrategy.AVG\n\nSpotReductionStrategy.BOT\n\nSpotReductionStrategy.MID\n\nSpotReductionStrategy.TOP\n\nSpotReductionStrategy\nSpotReductionStrategy.MIN\nSpotReductionStrategy.MAX\nSpotReductionStrategy.AVG\nSpotReductionStrategy.BOT\nSpotReductionStrategy.MID\nSpotReductionStrategy.TOP" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e13", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.e13.html#ansys.dpf.composites.sampling_point.SamplingPoint.e13", - "title": "e13 > e13 > e13", - "section": "e13 > e13", - "text": "property SamplingPoint.e13: ndarray[Any, dtype[float64]]\n\nOut-of-plane shear strains e13 of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy", + "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.html#ansys.dpf.composites.ply_wise_data.SpotReductionStrategy", + "title": "SpotReductionStrategy > SpotReductionStrategy > SpotReductionStrategy", + "section": "SpotReductionStrategy > SpotReductionStrategy", + "text": "class ansys.dpf.composites.ply_wise_data.SpotReductionStrategy(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nProvides the strategy for getting from spot values (BOT, MID, TOP) to a single value.\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nSpotReductionStrategy.MIN\n\n\n\nSpotReductionStrategy.MAX\n\n\n\nSpotReductionStrategy.AVG\n\n\n\nSpotReductionStrategy.BOT\n\n\n\nSpotReductionStrategy.MID\n\n\n\nSpotReductionStrategy.TOP\n\n\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.get_ply_wise_data", - "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.get_ply_wise_data.html#get_ply_wise_data", - "title": "get_ply_wise_data", - "section": "get_ply_wise_data", - "text": "Get ply-wise data from a field.\nfield (Field) – Field to extract data from.\nply_name (str) – Name of the ply to extract data from.\nmesh (MeshedRegion) – Meshed region that needs to be enriched with composite information.\nUse the CompositeModel.get_mesh() method to get the meshed region.\nspot_reduction_strategy (SpotReductionStrategy, default: ) – Reduction strategy for getting from spot values (BOT, MID, TOP) to a single value\nper corner node and layer. The default is AVG.\nrequested_location (str, default: 'ElementalNodal') – Location of the output field. Important: The function always averages nodal values\nfor \"elemental\" or \"nodal\" locations,\nirrespective of \"spot_reduction_strategy\".\nOptions are \"elemental\", \"elemental_nodal\", and \"nodal\".\nThe default is \"elemental_nodal\".\ncomponent (IntEnum | int, default: 0) – Component to extract data from. The default is 0.\nField\nget_ply_wise_data\nField\nstr\nMeshedRegion\nCompositeModel.get_mesh()\nSpotReductionStrategy\n\nAVG\nstr\n'ElementalNodal'\n\"elemental\"\n\"nodal\"\n\"spot_reduction_strategy\"\n\"elemental\"\n\"elemental_nodal\"\n\"nodal\"\n\"elemental_nodal\"\nIntEnum\nint\n0\n0\nField" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc2", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc2.html#lmc2", + "title": "lmc2", + "section": "lmc2", + "text": "lmc2" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.get_ply_wise_data", - "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.get_ply_wise_data.html#ansys.dpf.composites.ply_wise_data.get_ply_wise_data", - "title": "get_ply_wise_data > get_ply_wise_data > get_ply_wise_data", - "section": "get_ply_wise_data > get_ply_wise_data", - "text": "ansys.dpf.composites.ply_wise_data.get_ply_wise_data(field, ply_name, mesh, spot_reduction_strategy=SpotReductionStrategy.AVG, requested_location='ElementalNodal', component=0)\n\nGet ply-wise data from a field.\n\nParameters\n\nfield (Field) – Field to extract data from.\n\nply_name (str) – Name of the ply to extract data from.\n\nmesh (MeshedRegion) – Meshed region that needs to be enriched with composite information.\nUse the CompositeModel.get_mesh() method to get the meshed region.\n\nspot_reduction_strategy (SpotReductionStrategy, default: ) – Reduction strategy for getting from spot values (BOT, MID, TOP) to a single value\nper corner node and layer. The default is AVG.\n\nrequested_location (str, default: 'ElementalNodal') – Location of the output field. Important: The function always averages nodal values\nfor \"elemental\" or \"nodal\" locations,\nirrespective of \"spot_reduction_strategy\".\nOptions are \"elemental\", \"elemental_nodal\", and \"nodal\".\nThe default is \"elemental_nodal\".\n\ncomponent (IntEnum | int, default: 0) – Component to extract data from. The default is 0.\n\nReturn type\n\nField\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc2", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc2.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.lmc2", + "title": "lmc2 > lmc2 > lmc2", + "section": "lmc2 > lmc2", + "text": "FailureModeEnum.lmc2 = 905\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pd", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pd.html#pd", - "title": "pd", - "section": "pd", - "text": "Whether to activate the failure evaluation regarding delamination if dim is equal to 3.\nbool\npd\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.figure", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.figure.html#figure", + "title": "figure", + "section": "figure", + "text": "figure" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pd", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pd.html#ansys.dpf.composites.failure_criteria.PuckCriterion.pd", - "title": "pd > pd > pd", - "section": "pd > pd", - "text": "property PuckCriterion.pd: bool\n\nWhether to activate the failure evaluation regarding delamination if dim is equal to 3.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.figure", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPointFigure.figure.html#ansys.dpf.composites.sampling_point.SamplingPointFigure.figure", + "title": "figure > figure > figure", + "section": "figure > figure", + "text": "SamplingPointFigure.figure: Any\n\n" }, { - "objectID": "examples/gallery_examples/005_get_layup_properties_example", - "href": "examples/gallery_examples/005_get_layup_properties_example.html#lay-up-properties", - "title": "Lay-up properties", - "section": "Lay-up properties", - "text": "This example shows how to efficiently extract elemental lay-up properties such as\nthickness, angles, and analysis ply names. These are typically used for layer-wise\npostprocessing and data filtering.\nTo get the full layer information of an element, including results,\nconsider using the SamplingPoint class.\nWhen using a Workbench project,\nuse the composite_files_from_workbench_harmonic_analysis()\nmethod to obtain the input files.\nLay-up properties\nSamplingPoint\ncomposite_files_from_workbench_harmonic_analysis()" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.th", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.th.html#th", + "title": "th", + "section": "th", + "text": "th" }, { - "objectID": "examples/gallery_examples/005_get_layup_properties_example", - "href": "examples/gallery_examples/005_get_layup_properties_example.html#set-up-analysis", - "title": "Lay-up properties > Set up analysis", - "section": "Set up analysis", - "text": "Setting up the analysis consists of importing dependencies, connecting to the\nDPF server, and retrieving the example files.\nImport dependencies.\nStart a DPF server and copy the example files into the current working directory.\nSet up analysis" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.th", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.th.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.th", + "title": "th > th > th", + "section": "th > th", + "text": "FailureModeEnum.th = 500\n\n" }, { - "objectID": "examples/gallery_examples/005_get_layup_properties_example", - "href": "examples/gallery_examples/005_get_layup_properties_example.html#set-up-model", - "title": "Lay-up properties > Set up model", - "section": "Set up model", - "text": "Set up the composite model.\nSet up model" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE", + "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE.html#failure_value", + "title": "FAILURE_VALUE", + "section": "FAILURE_VALUE", + "text": "FAILURE_VALUE" }, { - "objectID": "examples/gallery_examples/005_get_layup_properties_example", - "href": "examples/gallery_examples/005_get_layup_properties_example.html#get-lay-up-properties", - "title": "Lay-up properties > Get lay-up properties", - "section": "Get lay-up properties", - "text": "Get lay-up properties for all elements and show the first one as an example.\nGet lay-up properties" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE", + "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE.html#ansys.dpf.composites.constants.FailureOutput.FAILURE_VALUE", + "title": "FAILURE_VALUE > FAILURE_VALUE > FAILURE_VALUE", + "section": "FAILURE_VALUE > FAILURE_VALUE", + "text": "FailureOutput.FAILURE_VALUE = 1\n\n" }, { - "objectID": "examples/gallery_examples/005_get_layup_properties_example", - "href": "examples/gallery_examples/005_get_layup_properties_example.html#plot-lay-up-properties", - "title": "Lay-up properties > Plot lay-up properties", - "section": "Plot lay-up properties", - "text": "Plot basic layer properties (layer thicknesses, angles, and analysis ply names).\nTotal running time of the script: (0 minutes 1.399 seconds)\nDownload Jupyter notebook: 005_get_layup_properties_example.ipynb\nDownload Python source code: 005_get_layup_properties_example.py\nDownload zipped: 005_get_layup_properties_example.zip\nGallery generated by Sphinx-Gallery\nPlot lay-up properties\nDownload Jupyter notebook: 005_get_layup_properties_example.ipynb\nDownload Python source code: 005_get_layup_properties_example.py\nDownload zipped: 005_get_layup_properties_example.zip" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_dict.html#to_dict", + "title": "to_dict", + "section": "to_dict", + "text": "Return the combined failure criterion as a dictionary.\ndict[str, Any]\nJSON dictionary that can be used for the result definition\nof the DPF Composites Failure evaluator operator.\nto_dict\ndict\nstr\nAny" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.expression", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.expression.html#expression", - "title": "expression", - "section": "expression", - "text": "Type of the result. The supported type is \"composite_failure\".\nstr\nexpression\n\"composite_failure\"\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.to_dict", + "title": "to_dict > to_dict > to_dict", + "section": "to_dict > to_dict", + "text": "CombinedFailureCriterion.to_dict()\n\nReturn the combined failure criterion as a dictionary.\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\nJSON dictionary that can be used for the result definition\nof the DPF Composites Failure evaluator operator.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.expression", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.expression.html#ansys.dpf.composites.result_definition.ResultDefinition.expression", - "title": "expression > expression > expression", - "section": "expression > expression", - "text": "property ResultDefinition.expression: str\n\nType of the result. The supported type is \"composite_failure\".\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmc.html#cmc", + "title": "cmc", + "section": "cmc", + "text": "Activates the failure evaluation of the matrix due to compression or shear.\nbool\ncmc\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.engineering_data", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.engineering_data.html#engineering_data", - "title": "engineering_data", - "section": "engineering_data", - "text": "engineering_data" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmc.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.cmc", + "title": "cmc > cmc > cmc", + "section": "cmc > cmc", + "text": "property CuntzeCriterion.cmc: bool\n\nActivates the failure evaluation of the matrix due to compression or shear.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.engineering_data", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.engineering_data.html#ansys.dpf.composites.data_sources.CompositeDataSources.engineering_data", - "title": "engineering_data > engineering_data > engineering_data", - "section": "engineering_data > engineering_data", - "text": "CompositeDataSources.engineering_data: DataSources\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.mode", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.mode.html#mode", + "title": "mode", + "section": "mode", + "text": "mode" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.homogeneous_core_coeff", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.homogeneous_core_coeff.html#homogeneous_core_coeff", - "title": "homogeneous_core_coeff", - "section": "homogeneous_core_coeff", - "text": "Wrinkling coefficient (reduction factor) for homogeneous core materials.\nfloat\nhomogeneous_core_coeff\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.mode", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.mode.html#ansys.dpf.composites.sampling_point.FailureResult.mode", + "title": "mode > mode > mode", + "section": "mode > mode", + "text": "FailureResult.mode: str\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.homogeneous_core_coeff", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.homogeneous_core_coeff.html#ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.homogeneous_core_coeff", - "title": "homogeneous_core_coeff > homogeneous_core_coeff > homogeneous_core_coeff", - "section": "homogeneous_core_coeff > homogeneous_core_coeff", - "text": "property FaceSheetWrinklingCriterion.homogeneous_core_coeff: float\n\nWrinkling coefficient (reduction factor) for homogeneous core materials.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.title", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.title.html#title", + "title": "title", + "section": "title", + "text": "Return a version of the string where each word is titlecased.\nMore specifically, words start with uppercased characters and all remaining\ncased characters have lower case.\ntitle" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.title", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.title.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.title", + "title": "title > title > title", + "section": "title > title", + "text": "FailureMeasureEnum.title(/)\n\nReturn a version of the string where each word is titlecased.\n\nMore specifically, words start with uppercased characters and all remaining\ncased characters have lower case.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s13", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s13.html#s13", - "title": "s13", - "section": "s13", - "text": "Whether to activate the failure evaluation regarding the interlaminar shear stress s13.\nbool\ns13\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.composite_definition", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.composite_definition.html#composite_definition", + "title": "composite_definition", + "section": "composite_definition", + "text": "composite_definition" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s13", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.s13.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.s13", - "title": "s13 > s13 > s13", - "section": "s13 > s13", - "text": "property MaxStressCriterion.s13: bool\n\nWhether to activate the failure evaluation regarding the interlaminar shear stress s13.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.composite_definition", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.composite_definition.html#ansys.dpf.composites.result_definition.ResultDefinitionScope.composite_definition", + "title": "composite_definition > composite_definition > composite_definition", + "section": "composite_definition > composite_definition", + "text": "ResultDefinitionScope.composite_definition: str | PathLike[str]\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.server_helpers.upload_short_fiber_composite_files_to_server", - "href": "api/_autosummary/ansys.dpf.composites.server_helpers.upload_short_fiber_composite_files_to_server.html#upload_short_fiber_composite_files_to_server", - "title": "upload_short_fiber_composite_files_to_server", - "section": "upload_short_fiber_composite_files_to_server", - "text": "Upload short fiber composites files to server.\ndata_files (ShortFiberCompositesFiles)\nserver (BaseServer)\nShortFiberCompositesFiles\nupload_short_fiber_composite_files_to_server\nShortFiberCompositesFiles\nBaseServer\nShortFiberCompositesFiles" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.force_global_strain_limits", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.force_global_strain_limits.html#force_global_strain_limits", + "title": "force_global_strain_limits", + "section": "force_global_strain_limits", + "text": "Whether to use one set of global strain limits instead of the strain limits of the materials.\nbool\nforce_global_strain_limits\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.server_helpers.upload_short_fiber_composite_files_to_server", - "href": "api/_autosummary/ansys.dpf.composites.server_helpers.upload_short_fiber_composite_files_to_server.html#ansys.dpf.composites.server_helpers.upload_short_fiber_composite_files_to_server", - "title": "upload_short_fiber_composite_files_to_server > upload_short_fiber_composite_files_to_server > upload_short_fiber_composite_files_to_server", - "section": "upload_short_fiber_composite_files_to_server > upload_short_fiber_composite_files_to_server", - "text": "ansys.dpf.composites.server_helpers.upload_short_fiber_composite_files_to_server(data_files, server)\n\nUpload short fiber composites files to server.\n\nParameters\n\ndata_files (ShortFiberCompositesFiles)\n\nserver (BaseServer)\n\nReturn type\n\nShortFiberCompositesFiles\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.force_global_strain_limits", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.force_global_strain_limits.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.force_global_strain_limits", + "title": "force_global_strain_limits > force_global_strain_limits > force_global_strain_limits", + "section": "force_global_strain_limits > force_global_strain_limits", + "text": "property MaxStrainCriterion.force_global_strain_limits: bool\n\nWhether to use one set of global strain limits instead of the strain limits of the materials.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e23", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e23.html#wf_e23", - "title": "wf_e23", - "section": "wf_e23", - "text": "Weighting factor of the failure mode e23.\nfloat\nwf_e23\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.s", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.s.html#s", + "title": "s", + "section": "s", + "text": "Specifies the effect of fiber parallel stresses regarding inter-fiber failure. s = [0, 1) and the default is 0.5.\nfloat\ns\n0.5\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e23", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e23.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e23", - "title": "wf_e23 > wf_e23 > wf_e23", - "section": "wf_e23 > wf_e23", - "text": "property MaxStrainCriterion.wf_e23: float\n\nWeighting factor of the failure mode e23.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.s", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.s.html#ansys.dpf.composites.failure_criteria.PuckCriterion.s", + "title": "s > s > s", + "section": "s > s", + "text": "property PuckCriterion.s: float\n\nSpecifies the effect of fiber parallel stresses regarding inter-fiber failure. s = [0, 1) and the default is 0.5.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.html#vonmisescriterion", - "title": "VonMisesCriterion", - "section": "VonMisesCriterion", - "text": "Defines the von Mises criterion for isotropic materials.\nvme (bool, default: True) – Whether to activate the von Mises strain criterion.\nvms (bool, default: True) – Whether to activate the von Mises stress criterion.\nwf_vme (float, default: 1.0) – Weighting factor of the strain criterion (vme).\nwf_vms (float, default: 1.0) – Weighting factor of the stress criterion (vms).\neval_ins (bool, default: False) – Whether to consider interlaminar normal stresses (s3) and compute them for layered shells.\nVonMisesCriterion.to_dict()\n\nVonMisesCriterion.to_json()\n\nVonMisesCriterion.active\nThe failure criterion is suppressed if active is False.\nVonMisesCriterion.eval_ins\nWhether to consider interlaminar normal stresses (s3) and compute them for layered shells.\nVonMisesCriterion.name\nName of the failure criterion.\nVonMisesCriterion.vme\nWhether to activate the von Mises strain criterion.\nVonMisesCriterion.vms\nWhether to activate the von Mises stress criterion.\nVonMisesCriterion.wf_vme\nWeighting factor of the strain criterion (vme).\nVonMisesCriterion.wf_vms\nWeighting factor of the stress criterion (vms).\nVonMisesCriterion\nbool\nTrue\nbool\nTrue\nfloat\n1.0\nfloat\n1.0\nbool\nFalse\nVonMisesCriterion.to_dict\nVonMisesCriterion.to_json\nVonMisesCriterion.active\nVonMisesCriterion.eval_ins\nVonMisesCriterion.name\nVonMisesCriterion.vme\nVonMisesCriterion.vms\nVonMisesCriterion.wf_vme\nVonMisesCriterion.wf_vms" + "objectID": "examples/gallery_examples/001_failure_operator_example", + "href": "examples/gallery_examples/001_failure_operator_example.html#composite-failure-analysis", + "title": "Composite failure analysis", + "section": "Composite failure analysis", + "text": "This example shows how to analyze a composite structure by a combined failure criterion.\nThe failure operator of DPF Composites computes the minimum and maximum failure values\nand failure modes of a combined failure criterion. A combined failure criterion is a selection of\nfailure criteria such as Puck, Tsai-Wu, or face sheet wrinkling. For a list of all\nfailure criteria, see failure_criteria.\nThe Combined Failure Criterion class\nallows you to assess different type of materials and failure modes at once.\nThe scoping enables you to evaluate the minimum and maximum failures per element\nor select a list of materials or plies.\nWhen using a Workbench project,\nuse the get_composite_files_from_workbench_result_folder()\nmethod to obtain the input files.\nComposite failure analysis\nCombined Failure Criterion\nget_composite_files_from_workbench_result_folder()" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion", - "title": "VonMisesCriterion > VonMisesCriterion > VonMisesCriterion", - "section": "VonMisesCriterion > VonMisesCriterion", - "text": "class ansys.dpf.composites.failure_criteria.VonMisesCriterion(*, vme=True, vms=True, wf_vme=1.0, wf_vms=1.0, eval_ins=False)\n\nDefines the von Mises criterion for isotropic materials.\n\nParameters\n\nvme (bool, default: True) – Whether to activate the von Mises strain criterion.\n\nvms (bool, default: True) – Whether to activate the von Mises stress criterion.\n\nwf_vme (float, default: 1.0) – Weighting factor of the strain criterion (vme).\n\nwf_vms (float, default: 1.0) – Weighting factor of the stress criterion (vms).\n\neval_ins (bool, default: False) – Whether to consider interlaminar normal stresses (s3) and compute them for layered shells.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nVonMisesCriterion.to_dict()\n\n\n\nVonMisesCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nVonMisesCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nVonMisesCriterion.eval_ins\n\nWhether to consider interlaminar normal stresses (s3) and compute them for layered shells.\n\nVonMisesCriterion.name\n\nName of the failure criterion.\n\nVonMisesCriterion.vme\n\nWhether to activate the von Mises strain criterion.\n\nVonMisesCriterion.vms\n\nWhether to activate the von Mises stress criterion.\n\nVonMisesCriterion.wf_vme\n\nWeighting factor of the strain criterion (vme).\n\nVonMisesCriterion.wf_vms\n\nWeighting factor of the stress criterion (vms).\n\n" + "objectID": "examples/gallery_examples/001_failure_operator_example", + "href": "examples/gallery_examples/001_failure_operator_example.html#set-up-analysis", + "title": "Composite failure analysis > Set up analysis", + "section": "Set up analysis", + "text": "Setting up the analysis consists of loading Ansys libraries, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries.\nStart a DPF server and copy the example files into the current working directory.\nSet up analysis" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.dim", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.dim.html#dim", - "title": "dim", - "section": "dim", - "text": "Whether the 2D or 3D formulation of the criterion is used. 2D is equivalent to LaRC03, and 3D is equivalent to LaRC04.\nint\ndim\nint" + "objectID": "examples/gallery_examples/001_failure_operator_example", + "href": "examples/gallery_examples/001_failure_operator_example.html#configure-combined-failure-criterion", + "title": "Composite failure analysis > Configure combined failure criterion", + "section": "Configure combined failure criterion", + "text": "Configure the combined failure criterion.\nConfigure combined failure criterion" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.dim", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.dim.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.dim", - "title": "dim > dim > dim", - "section": "dim > dim", - "text": "property LaRCCriterion.dim: int\n\nWhether the 2D or 3D formulation of the criterion is used. 2D is equivalent to LaRC03, and 3D is equivalent to LaRC04.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" + "objectID": "examples/gallery_examples/001_failure_operator_example", + "href": "examples/gallery_examples/001_failure_operator_example.html#set-up-model-and-evaluate-failures", + "title": "Composite failure analysis > Set up model and evaluate failures", + "section": "Set up model and evaluate failures", + "text": "Set up the composite model.\nEvaluate failures for the entire model\nScope failure evaluation to a certain element scope.\nScope failure evaluation by plies.\nTotal running time of the script: (0 minutes 12.061 seconds)\nDownload Jupyter notebook: 001_failure_operator_example.ipynb\nDownload Python source code: 001_failure_operator_example.py\nDownload zipped: 001_failure_operator_example.zip\nGallery generated by Sphinx-Gallery\nSet up model and evaluate failures\nDownload Jupyter notebook: 001_failure_operator_example.ipynb\nDownload Python source code: 001_failure_operator_example.py\nDownload zipped: 001_failure_operator_example.zip" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput", - "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.html#failureoutput", - "title": "FailureOutput", - "section": "FailureOutput", - "text": "Provides failure output types.\nThe enum value corresponds to the index in the fields container.\nFailureOutput.FAILURE_MODE\n\nFailureOutput.FAILURE_VALUE\n\nFailureOutput.MAX_LAYER_INDEX\n\nFailureOutput.FAILURE_MODE_REF_SURFACE\n\nFailureOutput.FAILURE_VALUE_REF_SURFACE\n\nFailureOutput.MAX_GLOBAL_LAYER_IN_STACK\n\nFailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT\n\nFailureOutput.MAX_SOLID_ELEMENT_ID\n\nFailureOutput\nFailureOutput.FAILURE_MODE\nFailureOutput.FAILURE_VALUE\nFailureOutput.MAX_LAYER_INDEX\nFailureOutput.FAILURE_MODE_REF_SURFACE\nFailureOutput.FAILURE_VALUE_REF_SURFACE\nFailureOutput.MAX_GLOBAL_LAYER_IN_STACK\nFailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT\nFailureOutput.MAX_SOLID_ELEMENT_ID" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYc.html#eyc", + "title": "eYc", + "section": "eYc", + "text": "Global compressive strain limit in material direction 1.\nfloat\neYc\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput", - "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.html#ansys.dpf.composites.constants.FailureOutput", - "title": "FailureOutput > FailureOutput > FailureOutput", - "section": "FailureOutput > FailureOutput", - "text": "class ansys.dpf.composites.constants.FailureOutput(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nProvides failure output types.\n\nThe enum value corresponds to the index in the fields container.\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nFailureOutput.FAILURE_MODE\n\n\n\nFailureOutput.FAILURE_VALUE\n\n\n\nFailureOutput.MAX_LAYER_INDEX\n\n\n\nFailureOutput.FAILURE_MODE_REF_SURFACE\n\n\n\nFailureOutput.FAILURE_VALUE_REF_SURFACE\n\n\n\nFailureOutput.MAX_GLOBAL_LAYER_IN_STACK\n\n\n\nFailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT\n\n\n\nFailureOutput.MAX_SOLID_ELEMENT_ID\n\n\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYc.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eYc", + "title": "eYc > eYc > eYc", + "section": "eYc > eYc", + "text": "property MaxStrainCriterion.eYc: float\n\nGlobal compressive strain limit in material direction 1.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_offsets_by_spots", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_offsets_by_spots.html#get_offsets_by_spots", - "title": "get_offsets_by_spots", - "section": "get_offsets_by_spots", - "text": "Access the y coordinates of the selected spots (interfaces) for each ply.\nspots (Collection[Spot], default: (, , )) – Collection of spots.\ncore_scale_factor (float, default: 1.0) – Factor for scaling the thickness of core plies.\nndarray[Any, dtype[float64]]\nget_offsets_by_spots\nCollection\nSpot\n(, , )\nfloat\n1.0\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lmt", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lmt.html#lmt", + "title": "lmt", + "section": "lmt", + "text": "Whether to activate the failure evaluation of the matrix due to tension.\nbool\nlmt\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_offsets_by_spots", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_offsets_by_spots.html#ansys.dpf.composites.sampling_point.SamplingPoint.get_offsets_by_spots", - "title": "get_offsets_by_spots > get_offsets_by_spots > get_offsets_by_spots", - "section": "get_offsets_by_spots > get_offsets_by_spots", - "text": "SamplingPoint.get_offsets_by_spots(spots=(Spot.BOTTOM, Spot.MIDDLE, Spot.TOP), core_scale_factor=1.0)\n\nAccess the y coordinates of the selected spots (interfaces) for each ply.\n\nParameters\n\nspots (Collection[Spot], default: (, , )) – Collection of spots.\n\ncore_scale_factor (float, default: 1.0) – Factor for scaling the thickness of core plies.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lmt", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.lmt.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.lmt", + "title": "lmt > lmt > lmt", + "section": "lmt > lmt", + "text": "property LaRCCriterion.lmt: bool\n\nWhether to activate the failure evaluation of the matrix due to tension.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfoProvider", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfoProvider.html#elementinfoprovider", - "title": "ElementInfoProvider", - "section": "ElementInfoProvider", - "text": "Provider for ElementInfo.\nUse get_element_info_provider() to create ElementInfoProvider\nobjects.\nInitialize the class before a loop and\ncall get_element_info() for each element.\nNote that the ElementInfoProvider class is not fully supported for\ndistributed RST files. The get_element_info() method will raise an\nexception if the DPF server version does not support reading the required\ninformation.\nmesh (MeshedRegion)\nlayer_indices (PropertyField)\nelement_types_apdl (PropertyField)\nelement_types_dpf (PropertyField)\nkeyopt_8_values (PropertyField)\nkeyopt_3_values (PropertyField)\nmaterial_ids (PropertyField)\nno_bounds_checks (bool, default: False) – Disable bounds checks.\nResults in better performance but potentially cryptic\nerror messages\nElementInfoProvider.get_element_info(element_id)\nGet ElementInfo for a given element id.\nElementInfoProvider\nElementInfo\nget_element_info_provider()\nElementInfoProvider\nget_element_info()\nElementInfoProvider\nget_element_info()\nMeshedRegion\nPropertyField\nPropertyField\nPropertyField\nPropertyField\nPropertyField\nPropertyField\nbool\nFalse\nElementInfoProvider.get_element_info\nElementInfo" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rstrip", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rstrip.html#rstrip", + "title": "rstrip", + "section": "rstrip", + "text": "Return a copy of the string with trailing whitespace removed.\nIf chars is given and not None, remove characters in chars instead.\nrstrip" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfoProvider", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfoProvider.html#ansys.dpf.composites.layup_info.ElementInfoProvider", - "title": "ElementInfoProvider > ElementInfoProvider > ElementInfoProvider", - "section": "ElementInfoProvider > ElementInfoProvider", - "text": "class ansys.dpf.composites.layup_info.ElementInfoProvider(mesh, layer_indices, element_types_apdl, element_types_dpf, keyopt_8_values, keyopt_3_values, material_ids, solver_material_ids=None, no_bounds_checks=False)\n\nProvider for ElementInfo.\n\nUse get_element_info_provider() to create ElementInfoProvider\nobjects.\n\nInitialize the class before a loop and\ncall get_element_info() for each element.\n\nNote that the ElementInfoProvider class is not fully supported for\ndistributed RST files. The get_element_info() method will raise an\nexception if the DPF server version does not support reading the required\ninformation.\n\nParameters\n\nmesh (MeshedRegion)\n\nlayer_indices (PropertyField)\n\nelement_types_apdl (PropertyField)\n\nelement_types_dpf (PropertyField)\n\nkeyopt_8_values (PropertyField)\n\nkeyopt_3_values (PropertyField)\n\nmaterial_ids (PropertyField)\n\nno_bounds_checks (bool, default: False) – Disable bounds checks.\nResults in better performance but potentially cryptic\nerror messages\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nElementInfoProvider.get_element_info(element_id)\n\nGet ElementInfo for a given element id.\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rstrip", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rstrip.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.rstrip", + "title": "rstrip > rstrip > rstrip", + "section": "rstrip > rstrip", + "text": "FailureMeasureEnum.rstrip(chars=None, /)\n\nReturn a copy of the string with trailing whitespace removed.\n\nIf chars is given and not None, remove characters in chars instead.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.get_dpf_material_id_by_analyis_ply_map", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.get_dpf_material_id_by_analyis_ply_map.html#get_dpf_material_id_by_analyis_ply_map", - "title": "get_dpf_material_id_by_analyis_ply_map", - "section": "get_dpf_material_id_by_analyis_ply_map", - "text": "Get Dict that maps analysis ply names to dpf_material_ids.\nmesh (MeshedRegion) – DPF Meshed region enriched with lay-up information\ndata_source_or_streams_provider (DataSources | Operator) – DPF data source with rst file or streams_provider. The streams provider is\navailable from CompositeModel.core_model (under metadata.streams_provider).\nCache the output because the computation can be performance-critical.\ndict[str, int64]\nget_dpf_material_id_by_analyis_ply_map\nMeshedRegion\nDataSources\nOperator\nCompositeModel.core_model\ndict\nstr\nint64" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e12", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e12.html#e12", + "title": "e12", + "section": "e12", + "text": "e12" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.get_dpf_material_id_by_analyis_ply_map", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.get_dpf_material_id_by_analyis_ply_map.html#ansys.dpf.composites.layup_info.get_dpf_material_id_by_analyis_ply_map", - "title": "get_dpf_material_id_by_analyis_ply_map > get_dpf_material_id_by_analyis_ply_map > get_dpf_material_id_by_analyis_ply_map", - "section": "get_dpf_material_id_by_analyis_ply_map > get_dpf_material_id_by_analyis_ply_map", - "text": "ansys.dpf.composites.layup_info.get_dpf_material_id_by_analyis_ply_map(mesh, data_source_or_streams_provider)\n\nGet Dict that maps analysis ply names to dpf_material_ids.\n\nParameters\n\nmesh (MeshedRegion) – DPF Meshed region enriched with lay-up information\n\ndata_source_or_streams_provider (DataSources | Operator) – DPF data source with rst file or streams_provider. The streams provider is\navailable from CompositeModel.core_model (under metadata.streams_provider).\n\nNotes\n\nCache the output because the computation can be performance-critical.\n\nReturn type\n\ndict[str, int64]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e12", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e12.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e12", + "title": "e12 > e12 > e12", + "section": "e12 > e12", + "text": "FailureModeEnum.e12 = 140\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.dpf_material_id", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.dpf_material_id.html#dpf_material_id", - "title": "dpf_material_id", - "section": "dpf_material_id", - "text": "dpf_material_id" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.zfill", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.zfill.html#zfill", + "title": "zfill", + "section": "zfill", + "text": "Pad a numeric string with zeros on the left, to fill a field of the given width.\nThe string is never truncated.\nzfill" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.dpf_material_id", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.dpf_material_id.html#ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.dpf_material_id", - "title": "dpf_material_id > dpf_material_id > dpf_material_id", - "section": "dpf_material_id > dpf_material_id", - "text": "MaterialMetadata.dpf_material_id: int = 0\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.zfill", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.zfill.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.zfill", + "title": "zfill > zfill > zfill", + "section": "zfill > zfill", + "text": "FailureMeasureEnum.zfill(width, /)\n\nPad a numeric string with zeros on the left, to fill a field of the given width.\n\nThe string is never truncated.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.composite_files_from_workbench_harmonic_analysis", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.composite_files_from_workbench_harmonic_analysis.html#composite_files_from_workbench_harmonic_analysis", - "title": "composite_files_from_workbench_harmonic_analysis", - "section": "composite_files_from_workbench_harmonic_analysis", - "text": "Get a ContinuousFiberCompositesFiles object for a harmonic analysis.\nresult_folder_modal (str) – Result folder of the Modal solution.\nIn the Modal system, right-click the solution item in the Ansys Mechanical tree\nand select Open Solver Files Directory to obtain the result folder.\nresult_folder_harmonic (str) – Result folder of the Harmonic Response solution.\nIn the Harmonic Response system,\nright-click the solution item in the Ansys Mechanical tree\nand select Open Solver Files Directory to obtain the result folder.\nContinuousFiberCompositesFiles\ncomposite_files_from_workbench_harmonic_analysis\nContinuousFiberCompositesFiles\nContinuousFiberCompositesFiles" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.remove", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.remove.html#remove", + "title": "remove", + "section": "remove", + "text": "Remove a failure criterion.\nkey (str) – Name of the failure criterion.\nFailureCriterionBase\nRemoved failure criterion or None.\nremove\nstr\nFailureCriterionBase\nNone" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.composite_files_from_workbench_harmonic_analysis", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.composite_files_from_workbench_harmonic_analysis.html#ansys.dpf.composites.data_sources.composite_files_from_workbench_harmonic_analysis", - "title": "composite_files_from_workbench_harmonic_analysis > composite_files_from_workbench_harmonic_analysis > composite_files_from_workbench_harmonic_analysis", - "section": "composite_files_from_workbench_harmonic_analysis > composite_files_from_workbench_harmonic_analysis", - "text": "ansys.dpf.composites.data_sources.composite_files_from_workbench_harmonic_analysis(result_folder_modal, result_folder_harmonic)\n\nGet a ContinuousFiberCompositesFiles object for a harmonic analysis.\n\nParameters\n\nresult_folder_modal (str) – Result folder of the Modal solution.\nIn the Modal system, right-click the solution item in the Ansys Mechanical tree\nand select Open Solver Files Directory to obtain the result folder.\n\nresult_folder_harmonic (str) – Result folder of the Harmonic Response solution.\nIn the Harmonic Response system,\nright-click the solution item in the Ansys Mechanical tree\nand select Open Solver Files Directory to obtain the result folder.\n\nReturn type\n\nContinuousFiberCompositesFiles\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.remove", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.remove.html#ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.remove", + "title": "remove > remove > remove", + "section": "remove > remove", + "text": "CombinedFailureCriterion.remove(key)\n\nRemove a failure criterion.\n\nParameters\n\nkey (str) – Name of the failure criterion.\n\nReturn type\n\nFailureCriterionBase\n\nReturns\n\nRemoved failure criterion or None.\n\nExamples\n\n>>> combined_failure.remove(\"Max Stress\")\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.active.html#active", - "title": "active", - "section": "active", - "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_laminate_offset", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_laminate_offset.html#get_element_laminate_offset", + "title": "get_element_laminate_offset", + "section": "get_element_laminate_offset", + "text": "Get the laminate offset of an element.\nTHis method returns None if the element is not layered.\nelement_id (int) – Element ID or label.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nOptional[float64]\nget_element_laminate_offset\nNone\nint\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nOptional\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.active.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.active", - "title": "active > active > active", - "section": "active > active", - "text": "property VonMisesCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_laminate_offset", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_laminate_offset.html#ansys.dpf.composites.composite_model.CompositeModel.get_element_laminate_offset", + "title": "get_element_laminate_offset > get_element_laminate_offset > get_element_laminate_offset", + "section": "get_element_laminate_offset > get_element_laminate_offset", + "text": "CompositeModel.get_element_laminate_offset(element_id, composite_definition_label=None)\n\nGet the laminate offset of an element.\n\nTHis method returns None if the element is not layered.\n\nParameters\n\nelement_id (int) – Element ID or label.\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\n\nReturn type\n\nOptional[float64]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.html#layupmodelcontexttype", - "title": "LayupModelContextType", - "section": "LayupModelContextType", - "text": "Type of the lay-up information.\nLayupModelContextType.NOT_AVAILABLE\n\nLayupModelContextType.ACP\n\nLayupModelContextType.RST\n\nLayupModelContextType.MIXED\n\nLayupModelContextType\nLayupModelContextType.NOT_AVAILABLE\nLayupModelContextType.ACP\nLayupModelContextType.RST\nLayupModelContextType.MIXED" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.solver_material_id", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.solver_material_id.html#solver_material_id", + "title": "solver_material_id", + "section": "solver_material_id", + "text": "solver_material_id" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.solver_material_id", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.solver_material_id.html#ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.solver_material_id", + "title": "solver_material_id > solver_material_id > solver_material_id", + "section": "solver_material_id > solver_material_id", + "text": "MaterialMetadata.solver_material_id: int | None = None\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupModelContextType.html#ansys.dpf.composites.layup_info.LayupModelContextType", - "title": "LayupModelContextType > LayupModelContextType > LayupModelContextType", - "section": "LayupModelContextType > LayupModelContextType", - "text": "class ansys.dpf.composites.layup_info.LayupModelContextType(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nType of the lay-up information.\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nLayupModelContextType.NOT_AVAILABLE\n\n\n\nLayupModelContextType.ACP\n\n\n\nLayupModelContextType.RST\n\n\n\nLayupModelContextType.MIXED\n\n\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput", + "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.html#failureoutput", + "title": "FailureOutput", + "section": "FailureOutput", + "text": "Provides failure output types.\nThe enum value corresponds to the index in the fields container.\nFailureOutput.FAILURE_MODE\n\nFailureOutput.FAILURE_VALUE\n\nFailureOutput.MAX_LAYER_INDEX\n\nFailureOutput.FAILURE_MODE_REF_SURFACE\n\nFailureOutput.FAILURE_VALUE_REF_SURFACE\n\nFailureOutput.MAX_GLOBAL_LAYER_IN_STACK\n\nFailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT\n\nFailureOutput.MAX_SOLID_ELEMENT_ID\n\nFailureOutput\nFailureOutput.FAILURE_MODE\nFailureOutput.FAILURE_VALUE\nFailureOutput.MAX_LAYER_INDEX\nFailureOutput.FAILURE_MODE_REF_SURFACE\nFailureOutput.FAILURE_VALUE_REF_SURFACE\nFailureOutput.MAX_GLOBAL_LAYER_IN_STACK\nFailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT\nFailureOutput.MAX_SOLID_ELEMENT_ID" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.cfps", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.cfps.html#cfps", - "title": "cfps", - "section": "cfps", - "text": "Whether to consider inter-fiber strength reduction due to fiber parallel stresses.\nbool\ncfps\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput", + "href": "api/_autosummary/ansys.dpf.composites.constants.FailureOutput.html#ansys.dpf.composites.constants.FailureOutput", + "title": "FailureOutput > FailureOutput > FailureOutput", + "section": "FailureOutput > FailureOutput", + "text": "class ansys.dpf.composites.constants.FailureOutput(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nProvides failure output types.\n\nThe enum value corresponds to the index in the fields container.\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nFailureOutput.FAILURE_MODE\n\n\n\nFailureOutput.FAILURE_VALUE\n\n\n\nFailureOutput.MAX_LAYER_INDEX\n\n\n\nFailureOutput.FAILURE_MODE_REF_SURFACE\n\n\n\nFailureOutput.FAILURE_VALUE_REF_SURFACE\n\n\n\nFailureOutput.MAX_GLOBAL_LAYER_IN_STACK\n\n\n\nFailureOutput.MAX_LOCAL_LAYER_IN_ELEMENT\n\n\n\nFailureOutput.MAX_SOLID_ELEMENT_ID\n\n\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.cfps", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.cfps.html#ansys.dpf.composites.failure_criteria.PuckCriterion.cfps", - "title": "cfps > cfps > cfps", - "section": "cfps > cfps", - "text": "property PuckCriterion.cfps: bool\n\nWhether to consider inter-fiber strength reduction due to fiber parallel stresses.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hm", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hm.html#hm", + "title": "hm", + "section": "hm", + "text": "Whether to activate the failure evaluation regarding matrix failure.\nbool\nhm\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_interface_weakening_factor", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_interface_weakening_factor.html#puck_constants_interface_weakening_factor", - "title": "Puck_Constants_interface_weakening_factor", - "section": "Puck_Constants_interface_weakening_factor", - "text": "Puck_Constants_interface_weakening_factor" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hm", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.hm.html#ansys.dpf.composites.failure_criteria.HashinCriterion.hm", + "title": "hm > hm > hm", + "section": "hm > hm", + "text": "property HashinCriterion.hm: bool\n\nWhether to activate the failure evaluation regarding matrix failure.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_interface_weakening_factor", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_interface_weakening_factor.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_interface_weakening_factor", - "title": "Puck_Constants_interface_weakening_factor > Puck_Constants_interface_weakening_factor > Puck_Constants_interface_weakening_factor", - "section": "Puck_Constants_interface_weakening_factor > Puck_Constants_interface_weakening_factor", - "text": "MaterialProperty.Puck_Constants_interface_weakening_factor: str = 'interface_weakening_factor_puck_constants'\n\n" + "objectID": "examples/gallery_examples/006_filter_composite_data_example", + "href": "examples/gallery_examples/006_filter_composite_data_example.html#filter-result-data-by-different-criteria", + "title": "Filter result data by different criteria", + "section": "Filter result data by different criteria", + "text": "This example shows how data filtering can be used for custom postprocessing of\nlayered composites. You can filter strains and stresses by material, layer, or\nanalysis ply. Filtering by analysis ply is implemented on the server side and\nexposed with the get_ply_wise_data() function. In this case, the data is\nfiltered (and reduced) on the server side and only the resulting field is returned\nto the client. This is the recommended way to filter data if possible.\nFor more complex filtering, the data is transferred to the client side and filtered\nusing numpy functionality.\nThe examples show filtering data by layer, spot, and node, as well as material\nor analysis ply ID. To learn more about how layered result data is organized,\nsee select_indices.\nWhen using a Workbench project,\nuse the composite_files_from_workbench_harmonic_analysis()\nmethod to obtain the input files.\nFilter result data by different criteria\nget_ply_wise_data()\ncomposite_files_from_workbench_harmonic_analysis()" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.html#elementinfo", - "title": "ElementInfo", - "section": "ElementInfo", - "text": "Provides lay-up information for an element.\nUse the ElementInfoProvider class to obtain the\nElementInfo class for an element.\nid (int) – Element ID or label.\nn_layers (int) – Number of layers. For non-layered elements, the value is 1.\nn_corner_nodes (int) – Number of corner nodes (without midside nodes).\nn_spots (int) – Number of spots (through-the-thickness integration points) per layer.\nelement_type (int) – APDL element type. For example, 181 for layered shells.\ndpf_material_ids (numpy.ndarray[Any, numpy.dtype[numpy.int64]]) – List of DPF material IDs for all layers.\nis_shell (bool) – Whether the element is a shell element.\nnumber_of_nodes_per_spot_plane (int) – Number of nodes per output plane. The value is equal\nto n_corner_nodes for shell elements and n_corner_nodes\ndivided by two for layered solid elements. The value is equal to -1\nfor non-layered elements.\nElementInfo.id\n\nElementInfo.n_layers\n\nElementInfo.n_corner_nodes\n\nElementInfo.n_spots\n\nElementInfo.is_layered\n\nElementInfo.element_type\n\nElementInfo.dpf_material_ids\n\nElementInfo.is_shell\n\nElementInfo.number_of_nodes_per_spot_plane\n\nElementInfo\nElementInfoProvider\nElementInfo\n1\n181\nn_corner_nodes\nn_corner_nodes\n-1\nElementInfo.id\nElementInfo.n_layers\nElementInfo.n_corner_nodes\nElementInfo.n_spots\nElementInfo.is_layered\nElementInfo.element_type\nElementInfo.dpf_material_ids\nElementInfo.is_shell\nElementInfo.number_of_nodes_per_spot_plane" + "objectID": "examples/gallery_examples/006_filter_composite_data_example", + "href": "examples/gallery_examples/006_filter_composite_data_example.html#set-up-analysis", + "title": "Filter result data by different criteria > Set up analysis", + "section": "Set up analysis", + "text": "Setting up the analysis consists of importing dependencies, connecting to the\nDPF server, and retrieving the example files.\nImport dependencies.\nStart a DPF server and copy the example files into the current working directory.\nSet up analysis" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.html#ansys.dpf.composites.layup_info.ElementInfo", - "title": "ElementInfo > ElementInfo > ElementInfo", - "section": "ElementInfo > ElementInfo", - "text": "class ansys.dpf.composites.layup_info.ElementInfo(id, n_layers, n_corner_nodes, n_spots, is_layered, element_type, dpf_material_ids, is_shell, number_of_nodes_per_spot_plane)\n\nProvides lay-up information for an element.\n\nUse the ElementInfoProvider class to obtain the\nElementInfo class for an element.\n\nParameters\n\nid (int) – Element ID or label.\n\nn_layers (int) – Number of layers. For non-layered elements, the value is 1.\n\nn_corner_nodes (int) – Number of corner nodes (without midside nodes).\n\nn_spots (int) – Number of spots (through-the-thickness integration points) per layer.\n\nelement_type (int) – APDL element type. For example, 181 for layered shells.\n\ndpf_material_ids (numpy.ndarray[Any, numpy.dtype[numpy.int64]]) – List of DPF material IDs for all layers.\n\nis_shell (bool) – Whether the element is a shell element.\n\nnumber_of_nodes_per_spot_plane (int) – Number of nodes per output plane. The value is equal\nto n_corner_nodes for shell elements and n_corner_nodes\ndivided by two for layered solid elements. The value is equal to -1\nfor non-layered elements.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nElementInfo.id\n\n\n\nElementInfo.n_layers\n\n\n\nElementInfo.n_corner_nodes\n\n\n\nElementInfo.n_spots\n\n\n\nElementInfo.is_layered\n\n\n\nElementInfo.element_type\n\n\n\nElementInfo.dpf_material_ids\n\n\n\nElementInfo.is_shell\n\n\n\nElementInfo.number_of_nodes_per_spot_plane\n\n\n\n" + "objectID": "examples/gallery_examples/006_filter_composite_data_example", + "href": "examples/gallery_examples/006_filter_composite_data_example.html#set-up-model", + "title": "Filter result data by different criteria > Set up model", + "section": "Set up model", + "text": "Set up the composite model.\nSet up model" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zt", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zt.html#stress_limits_zt", - "title": "Stress_Limits_Zt", - "section": "Stress_Limits_Zt", - "text": "Stress_Limits_Zt" + "objectID": "examples/gallery_examples/006_filter_composite_data_example", + "href": "examples/gallery_examples/006_filter_composite_data_example.html#get-result-data", + "title": "Filter result data by different criteria > Get result data", + "section": "Get result data", + "text": "Get the stress field. By default, the stress operator returns the stresses in global coordinates.\nTo get the stresses in the material coordinate system, the bool_rotate_to_global\ninput is set to False.\nGet result data\nbool_rotate_to_global\nFalse" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zt", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zt.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zt", - "title": "Stress_Limits_Zt > Stress_Limits_Zt > Stress_Limits_Zt", - "section": "Stress_Limits_Zt > Stress_Limits_Zt", - "text": "MaterialProperty.Stress_Limits_Zt: str = 'stress_tensile_z_direction'\n\n" + "objectID": "examples/gallery_examples/006_filter_composite_data_example", + "href": "examples/gallery_examples/006_filter_composite_data_example.html#filter-data-by-analysis-ply", + "title": "Filter result data by different criteria > Filter data by analysis ply", + "section": "Filter data by analysis ply", + "text": "List all available analysis plies.\nThe easiest way to filter data by analysis ply is to use the get_ply_wise_data() function.\nThis function supports different reduction strategies such as computing the average,\nmaximum, or minimum over the spot locations.\nIt also supports selecting a specific spot (TOP, MID, BOT) directly.\nThis example selects the maximum value over all spots for each node and then requests\nthe elemental location, which implies averaging over all nodes in an element.\nUsing the get_ply_wise_data() function has the advantage that all the averaging\nand filtering is done on the server side.\nThe results can also be requested in global coordinates. This example gets the stress values in\nthe global coordinate system, selects the top spot of a selected ply, and averages the values\nover neighbouring nodes to get nodal results.\nFilter data by analysis ply\nget_ply_wise_data()\nget_ply_wise_data()" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.LAMINATE_OFFSET", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.LAMINATE_OFFSET.html#laminate_offset", - "title": "LAMINATE_OFFSET", - "section": "LAMINATE_OFFSET", - "text": "LAMINATE_OFFSET" + "objectID": "examples/gallery_examples/006_filter_composite_data_example", + "href": "examples/gallery_examples/006_filter_composite_data_example.html#generic-client-side-filtering", + "title": "Filter result data by different criteria > Generic client-side filtering", + "section": "Generic client-side filtering", + "text": "This example shows how to filter data by layer, spot, and node using the generic filtering on\nthe client side.\nThis code plots stress values in the material direction for the first node and top spot.\nGet element information for all elements and show the first one as an example.\nGet filtered data\nGeneric client-side filtering" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.LAMINATE_OFFSET", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.LayupProperty.LAMINATE_OFFSET.html#ansys.dpf.composites.layup_info.LayupProperty.LAMINATE_OFFSET", - "title": "LAMINATE_OFFSET > LAMINATE_OFFSET > LAMINATE_OFFSET", - "section": "LAMINATE_OFFSET > LAMINATE_OFFSET", - "text": "LayupProperty.LAMINATE_OFFSET = 3\n\n" + "objectID": "examples/gallery_examples/006_filter_composite_data_example", + "href": "examples/gallery_examples/006_filter_composite_data_example.html#filter-by-material", + "title": "Filter result data by different criteria > Filter by material", + "section": "Filter by material", + "text": "Loop over all elements and get the maximum stress in the material direction\nfor all plies that have a specific UD material.\nFilter by material" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pf.html#pf", - "title": "pf", - "section": "pf", - "text": "Whether to activate the failure evaluation regarding fiber failure.\nbool\npf\nbool" + "objectID": "examples/gallery_examples/006_filter_composite_data_example", + "href": "examples/gallery_examples/006_filter_composite_data_example.html#filter-by-analysis-ply-on-the-client-side", + "title": "Filter result data by different criteria > Filter by analysis ply on the client side", + "section": "Filter by analysis ply on the client side", + "text": "Loop over all elements that contain a given ply and plot the maximum stress value\nin the material direction in this ply.\nTotal running time of the script: (0 minutes 4.636 seconds)\nDownload Jupyter notebook: 006_filter_composite_data_example.ipynb\nDownload Python source code: 006_filter_composite_data_example.py\nDownload zipped: 006_filter_composite_data_example.zip\nGallery generated by Sphinx-Gallery\nFilter by analysis ply on the client side\nDownload Jupyter notebook: 006_filter_composite_data_example.ipynb\nDownload Python source code: 006_filter_composite_data_example.py\nDownload zipped: 006_filter_composite_data_example.zip" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pf.html#ansys.dpf.composites.failure_criteria.PuckCriterion.pf", - "title": "pf > pf > pf", - "section": "pf > pf", - "text": "property PuckCriterion.pf: bool\n\nWhether to activate the failure evaluation regarding fiber failure.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isupper", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isupper.html#isupper", + "title": "isupper", + "section": "isupper", + "text": "Return True if the string is an uppercase string, False otherwise.\nA string is uppercase if all cased characters in the string are uppercase and\nthere is at least one cased character in the string.\nisupper" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.elements", - "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.elements.html#elements", - "title": "elements", - "section": "elements", - "text": "elements" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isupper", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isupper.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isupper", + "title": "isupper > isupper > isupper", + "section": "isupper > isupper", + "text": "FailureMeasureEnum.isupper(/)\n\nReturn True if the string is an uppercase string, False otherwise.\n\nA string is uppercase if all cased characters in the string are uppercase and\nthere is at least one cased character in the string.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.elements", - "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.elements.html#ansys.dpf.composites.composite_scope.CompositeScope.elements", - "title": "elements > elements > elements", - "section": "elements > elements", - "text": "CompositeScope.elements: Sequence[int] | None = None\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.af", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.af.html#af", + "title": "af", + "section": "af", + "text": "af" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.na", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.na.html#na", - "title": "na", - "section": "na", - "text": "na" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.af", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.af.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.af", + "title": "af > af > af", + "section": "af > af", + "text": "FailureModeEnum.af = 1203\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.na", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.na.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.na", - "title": "na > na > na", - "section": "na > na", - "text": "FailureModeEnum.na = 9999\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cft", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cft.html#wf_cft", + "title": "wf_cft", + "section": "wf_cft", + "text": "Weighting factor of fiber failure due to tension (cft).\nfloat\nwf_cft\nfloat" }, { - "objectID": "index", - "href": "index.html#pydpf---composites", - "title": "PyDPF - Composites", - "section": "PyDPF - Composites", - "text": "PyDPF - Composites enables the post-processing of composite structures based on\nAnsys DPF and the DPF Composites plugin. It implements\nclasses on top of DPF Composites operators and data accessors for short\nfiber and layered composites (layered shell and solid elements). This module\ncan be used to postprocess fiber reinforced plastics and layered composites, and\nto implement custom failure criteria and computation.\nContains installation instructions and a simple\nexample to create a failure plot from a Workbench project.\nDemonstrates the use of PyDPF - Composites for various workflows.\nDescribes the public Python classes, methods, and functions.\nProvides developer installation and usage information.\nThe minimum set of inputs to run a postprocessing for composites is the result files of an\nMAPDL solution and a material file (MATML) which was generated by Engineering Data.\nLay-up files from ACP are optional and only required for some advanced operations. Refer to\nLimitations.\nPyDPF - Composites" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cft", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cft.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cft", + "title": "wf_cft > wf_cft > wf_cft", + "section": "wf_cft > wf_cft", + "text": "property CuntzeCriterion.wf_cft: float\n\nWeighting factor of fiber failure due to tension (cft).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "index", - "href": "index.html#key-features", - "title": "PyDPF - Composites > Key features", - "section": "Key features", - "text": "Here are some key features of PyDPF - Composites:\nPostprocessing of layered shell and solid elements. MAPDL models as well as models preprocessed with ACP are supported.\nFailure criteria evaluation as shown in Composite failure analysis.\nA SamplingPoint class for extracting and visualizing a result over the entire thickness of a laminate as shown in\nSampling point.\nA ResultDefinition class for configuring combined failure criteria and scopes.\nAccessors for getting layered properties such as plies and materials as shown in\nLayered properties\nand Material properties and custom failure criterion.\nInterface to implement custom failure criteria and analysis as shown in\nMaterial properties and custom failure criterion.\nPostprocessing of homogeneous elements.\nKey features\nSamplingPoint\nResultDefinition" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.combined_failure_criterion", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.combined_failure_criterion.html#combined_failure_criterion", + "title": "combined_failure_criterion", + "section": "combined_failure_criterion", + "text": "Configuration of the failure criteria such as maximum stress, puck, and wrinkling.\nCombinedFailureCriterion\ncombined_failure_criterion\nCombinedFailureCriterion" }, { - "objectID": "index", - "href": "index.html#limitations", - "title": "PyDPF - Composites > Limitations", - "section": "Limitations", - "text": "Only the Mechanical APDL solver is supported.\nThe post-processing of expanded cyclic symmetry models is not implemented.\nThe following operators and features are only supported if the model was\npreprocessed with ACP and if the corresponding lay-up definition file is passed to the CompositeModel class.\nThe evaluation of the failure criteria for sandwich\n(FaceSheetWrinklingCriterion,\nShearCrimpingCriterion)\nfor solid elements. Layered shell elements are always supported.\nThe computation of interlaminar normal stresses (s3) for layered shell elements.\nWithout ACP layup definitions, s3 is always zero. This also affects 3D failure criteria which use s3,\nsuch as Puck 3D. This limitation does not affect (layered) solid elements.\nThe support of variable materials and material fields. Without ACP, only the\ntemperature is considered for the evaluation of variable material properties.\nGlobal plies, and scoping by plies. Layer-wise post-processing is always supported.\nPlotting results on the reference surface of a laminate.\nNote: MAPDL models that have not been preprocessed with ACP can be converted. For more\ninformation, see Import of Legacy Mechanical APDL Composite Models in the Ansys Help.\nLimitations\nCompositeModel\nFaceSheetWrinklingCriterion\nShearCrimpingCriterion" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.combined_failure_criterion", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.combined_failure_criterion.html#ansys.dpf.composites.result_definition.ResultDefinition.combined_failure_criterion", + "title": "combined_failure_criterion > combined_failure_criterion > combined_failure_criterion", + "section": "combined_failure_criterion > combined_failure_criterion", + "text": "property ResultDefinition.combined_failure_criterion: CombinedFailureCriterion\n\nConfiguration of the failure criteria such as maximum stress, puck, and wrinkling.\n\nReturn type\n\nCombinedFailureCriterion\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.html#hoffmancriterion", - "title": "HoffmanCriterion", - "section": "HoffmanCriterion", - "text": "Defines the Hoffman failure criterion for orthotropic reinforced materials.\nwf (float, default: 1.0) – Weighting factor of this failure criterion.\ndim (int, default: 2) – Specifies which formulation of the failure criterion is used.\nHoffmanCriterion.to_dict()\n\nHoffmanCriterion.to_json()\n\nHoffmanCriterion.active\nThe failure criterion is suppressed if active is False.\nHoffmanCriterion.dim\nSpecifies which formulation of the failure criterion is used.\nHoffmanCriterion.name\nName of the failure criterion.\nHoffmanCriterion.wf\nWeighting factor of this failure criterion.\nHoffmanCriterion\nfloat\n1.0\nint\n2\nHoffmanCriterion.to_dict\nHoffmanCriterion.to_json\nHoffmanCriterion.active\nHoffmanCriterion.dim\nHoffmanCriterion.name\nHoffmanCriterion.wf" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cfc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cfc.html#cfc", + "title": "cfc", + "section": "cfc", + "text": "cfc" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.html#ansys.dpf.composites.failure_criteria.HoffmanCriterion", - "title": "HoffmanCriterion > HoffmanCriterion > HoffmanCriterion", - "section": "HoffmanCriterion > HoffmanCriterion", - "text": "class ansys.dpf.composites.failure_criteria.HoffmanCriterion(*, active=True, wf=1.0, dim=2)\n\nDefines the Hoffman failure criterion for orthotropic reinforced materials.\n\nParameters\n\nwf (float, default: 1.0) – Weighting factor of this failure criterion.\n\ndim (int, default: 2) – Specifies which formulation of the failure criterion is used.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nHoffmanCriterion.to_dict()\n\n\n\nHoffmanCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nHoffmanCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nHoffmanCriterion.dim\n\nSpecifies which formulation of the failure criterion is used.\n\nHoffmanCriterion.name\n\nName of the failure criterion.\n\nHoffmanCriterion.wf\n\nWeighting factor of this failure criterion.\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cfc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cfc.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.cfc", + "title": "cfc > cfc > cfc", + "section": "cfc > cfc", + "text": "FailureModeEnum.cfc = 1002\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.svm", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.svm.html#svm", - "title": "svm", - "section": "svm", - "text": "svm" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.name.html#name", + "title": "name", + "section": "name", + "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.svm", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.svm.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.svm", - "title": "svm > svm > svm", - "section": "svm > svm", - "text": "FailureModeEnum.svm = 202\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.name.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.name", + "title": "name > name > name", + "section": "name > name", + "text": "property VonMisesCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kc.html#kc", - "title": "kc", - "section": "kc", - "text": "Weighting factor of the core material for evaluation of the maximum allowable load. The default is 1.\nfloat\nkc\n1\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ns", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ns.html#ns", + "title": "ns", + "section": "ns", + "text": "ns" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kc.html#ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kc", - "title": "kc > kc > kc", - "section": "kc > kc", - "text": "property ShearCrimpingCriterion.kc: float\n\nWeighting factor of the core material for evaluation of the maximum allowable load. The default is 1.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ns", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.ns.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.ns", + "title": "ns > ns > ns", + "section": "ns > ns", + "text": "FailureModeEnum.ns = 9998\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_neg", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_neg.html#puck_constants_p_22_neg", - "title": "Puck_Constants_p_22_neg", - "section": "Puck_Constants_p_22_neg", - "text": "Puck_Constants_p_22_neg" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.dim", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.dim.html#dim", + "title": "dim", + "section": "dim", + "text": "Whether the 2D or 3D formulation of the criterion is used.\nint\ndim\nint" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_neg", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_neg.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Puck_Constants_p_22_neg", - "title": "Puck_Constants_p_22_neg > Puck_Constants_p_22_neg > Puck_Constants_p_22_neg", - "section": "Puck_Constants_p_22_neg > Puck_Constants_p_22_neg", - "text": "MaterialProperty.Puck_Constants_p_22_neg: str = 'compressive_inclination_yz_puck_constants'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.dim", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.dim.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.dim", + "title": "dim > dim > dim", + "section": "dim > dim", + "text": "property CuntzeCriterion.dim: int\n\nWhether the 2D or 3D formulation of the criterion is used.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxy", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxy.html#stress_limits_sxy", - "title": "Stress_Limits_Sxy", - "section": "Stress_Limits_Sxy", - "text": "Stress_Limits_Sxy" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cfc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cfc.html#wf_cfc", + "title": "wf_cfc", + "section": "wf_cfc", + "text": "Weighting factor of fiber failure due to compression (cfc).\nfloat\nwf_cfc\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxy", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxy.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Sxy", - "title": "Stress_Limits_Sxy > Stress_Limits_Sxy > Stress_Limits_Sxy", - "section": "Stress_Limits_Sxy > Stress_Limits_Sxy", - "text": "MaterialProperty.Stress_Limits_Sxy: str = 'stress_shear_xy'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cfc", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cfc.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cfc", + "title": "wf_cfc > wf_cfc > wf_cfc", + "section": "wf_cfc > wf_cfc", + "text": "property CuntzeCriterion.wf_cfc: float\n\nWeighting factor of fiber failure due to compression (cfc).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.to_dict.html#to_dict", - "title": "to_dict", - "section": "to_dict", - "text": "Get the result definition in a dictionary representation.\ndict[str, Any]\nto_dict\ndict\nstr\nAny" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.eval_ins", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.eval_ins.html#eval_ins", + "title": "eval_ins", + "section": "eval_ins", + "text": "Whether to consider interlaminar normal stresses (s3) and compute them for layered shells.\nbool\neval_ins\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.to_dict.html#ansys.dpf.composites.result_definition.ResultDefinition.to_dict", - "title": "to_dict > to_dict > to_dict", - "section": "to_dict > to_dict", - "text": "ResultDefinition.to_dict()\n\nGet the result definition in a dictionary representation.\n\nReturn type\n\ndict[str, Any]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.eval_ins", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.VonMisesCriterion.eval_ins.html#ansys.dpf.composites.failure_criteria.VonMisesCriterion.eval_ins", + "title": "eval_ins > eval_ins > eval_ins", + "section": "eval_ins > eval_ins", + "text": "property VonMisesCriterion.eval_ins: bool\n\nWhether to consider interlaminar normal stresses (s3) and compute them for layered shells.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.to_json.html#to_json", + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.to_json", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.to_json.html#to_json", "title": "to_json", "section": "to_json", - "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" + "text": "Convert the dictionary representation of the result definition to a JSON dictionary.\nstr\nto_json\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.to_json", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.to_json.html#ansys.dpf.composites.failure_criteria.HashinCriterion.to_json", + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.to_json", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.to_json.html#ansys.dpf.composites.result_definition.ResultDefinition.to_json", "title": "to_json > to_json > to_json", "section": "to_json > to_json", - "text": "HashinCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" + "text": "ResultDefinition.to_json()\n\nConvert the dictionary representation of the result definition to a JSON dictionary.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.data_sources", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.data_sources.html#data_sources", - "title": "data_sources", - "section": "data_sources", - "text": "Composite data sources.\nCompositeDataSources\ndata_sources\nCompositeDataSources" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.html#materialmetadata", + "title": "MaterialMetadata", + "section": "MaterialMetadata", + "text": "Material metadata such as name and ply type.\ndpf_material_id (int) – Material index in the DPF materials container.\nmaterial_name (str) – Name of the material. Is empty if the name is not available.\nply_type (str | None) – Ply type. One of regular, woven, honeycomb_core,\nisotropic_homogeneous_core, orthotropic_homogeneous_core,\nisotropic, adhesive, undefined. Regular stands for uni-directional.\nNone if the DPF server older than 2025 R1 pre 0 (9.0).\nsolver_material_id (int | None) – Material index of the solver.\nNone if DPF server older than 2024 R1 pre 0 (8.0).\nMaterialMetadata.dpf_material_id\n\nMaterialMetadata.material_name\n\nMaterialMetadata.ply_type\n\nMaterialMetadata.solver_material_id\n\nMaterialMetadata\nMaterialMetadata.dpf_material_id\nMaterialMetadata.material_name\nMaterialMetadata.ply_type\nMaterialMetadata.solver_material_id" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.data_sources", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.data_sources.html#ansys.dpf.composites.composite_model.CompositeModel.data_sources", - "title": "data_sources > data_sources > data_sources", - "section": "data_sources > data_sources", - "text": "property CompositeModel.data_sources: CompositeDataSources\n\nComposite data sources.\n\nReturn type\n\nCompositeDataSources\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialMetadata.html#ansys.dpf.composites.layup_info.material_properties.MaterialMetadata", + "title": "MaterialMetadata > MaterialMetadata > MaterialMetadata", + "section": "MaterialMetadata > MaterialMetadata", + "text": "class ansys.dpf.composites.layup_info.material_properties.MaterialMetadata(dpf_material_id=0, material_name='', ply_type=None, solver_material_id=None)\n\nMaterial metadata such as name and ply type.\n\nParameters\n\ndpf_material_id (int) – Material index in the DPF materials container.\n\nmaterial_name (str) – Name of the material. Is empty if the name is not available.\n\nply_type (str | None) – Ply type. One of regular, woven, honeycomb_core,\nisotropic_homogeneous_core, orthotropic_homogeneous_core,\nisotropic, adhesive, undefined. Regular stands for uni-directional.\nNone if the DPF server older than 2025 R1 pre 0 (9.0).\n\nsolver_material_id (int | None) – Material index of the solver.\nNone if DPF server older than 2024 R1 pre 0 (8.0).\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nMaterialMetadata.dpf_material_id\n\n\n\nMaterialMetadata.material_name\n\n\n\nMaterialMetadata.ply_type\n\n\n\nMaterialMetadata.solver_material_id\n\n\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.mode", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.mode.html#mode", - "title": "mode", - "section": "mode", - "text": "mode" + "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.AVG", + "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.AVG.html#avg", + "title": "AVG", + "section": "AVG", + "text": "AVG" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.mode", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.FailureResult.mode.html#ansys.dpf.composites.sampling_point.FailureResult.mode", - "title": "mode > mode > mode", - "section": "mode > mode", - "text": "FailureResult.mode: str\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.AVG", + "href": "api/_autosummary/ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.AVG.html#ansys.dpf.composites.ply_wise_data.SpotReductionStrategy.AVG", + "title": "AVG > AVG > AVG", + "section": "AVG > AVG", + "text": "SpotReductionStrategy.AVG = 'AVG'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_dict.html#to_dict", - "title": "to_dict", - "section": "to_dict", - "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu12", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu12.html#engineering_constants_nu12", + "title": "Engineering_Constants_nu12", + "section": "Engineering_Constants_nu12", + "text": "Engineering_Constants_nu12" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_dict", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.HoffmanCriterion.to_dict", - "title": "to_dict > to_dict > to_dict", - "section": "to_dict > to_dict", - "text": "HoffmanCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu12", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu12.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_nu12", + "title": "Engineering_Constants_nu12 > Engineering_Constants_nu12 > Engineering_Constants_nu12", + "section": "Engineering_Constants_nu12 > Engineering_Constants_nu12", + "text": "MaterialProperty.Engineering_Constants_nu12: str = 'poisson_ratio_xy'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p22_pos", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p22_pos.html#p22_pos", - "title": "p22_pos", - "section": "p22_pos", - "text": "Global inclination factor of the fracture plane \\perp \\perp for tension.\nfloat\np22_pos\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s13", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s13.html#wf_s13", + "title": "wf_s13", + "section": "wf_s13", + "text": "Weighting factor of the failure mode s13.\nfloat\nwf_s13\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p22_pos", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p22_pos.html#ansys.dpf.composites.failure_criteria.PuckCriterion.p22_pos", - "title": "p22_pos > p22_pos > p22_pos", - "section": "p22_pos > p22_pos", - "text": "property PuckCriterion.p22_pos: float\n\nGlobal inclination factor of the fracture plane \\perp \\perp for tension.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s13", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s13.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s13", + "title": "wf_s13 > wf_s13 > wf_s13", + "section": "wf_s13 > wf_s13", + "text": "property MaxStressCriterion.wf_s13: float\n\nWeighting factor of the failure mode s13.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.evaluate_failure_criteria", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.evaluate_failure_criteria.html#evaluate_failure_criteria", - "title": "evaluate_failure_criteria", - "section": "evaluate_failure_criteria", - "text": "Get a fields container with the evaluated failure criteria.\nThe fields container contains the maximum per element if the measure\nis FailureMeasureEnum.INVERSE_RESERVE_FACTOR and the minimum per element\nif the measure is FailureMeasureEnum.MARGIN_OF_SAFETY or\nFailureMeasureEnum.RESERVE_FACTOR.\ncombined_criterion (CombinedFailureCriterion) – Combined failure criterion to evaluate.\ncomposite_scope (Optional[CompositeScope], default: None) – Composite scope on which to evaluate the failure criteria. If empty, the criteria\nis evaluated on the full model. If the time is not set, the last time or\nfrequency in the result file is used.\nmeasure (FailureMeasureEnum, default: ) – Failure measure to evaluate.\nwrite_data_for_full_element_scope (bool, default: True) – Whether each element in the element scope is to get a\n(potentially zero) failure value, even elements that are not\npart of composite_scope.plies. If no element scope is\nspecified (composite_scope.elements), a (potentially zero)\nfailure value is written for all elements.\nmax_chunk_size (int, default: 50000) – A higher value results in more memory consumption, but faster evaluation.For some special element types such as beams,\nwrite_data_for_full_element_scope=True is not supported.\nA higher value results in more memory consumption, but faster evaluation.\nFor some special element types such as beams,\nwrite_data_for_full_element_scope=True is not supported.\nFieldsContainer\nevaluate_failure_criteria\nFailureMeasureEnum.INVERSE_RESERVE_FACTOR\nFailureMeasureEnum.MARGIN_OF_SAFETY\nFailureMeasureEnum.RESERVE_FACTOR\nCombinedFailureCriterion\nOptional\nCompositeScope\nNone\nFailureMeasureEnum\n\nbool\nTrue\ncomposite_scope.plies\ncomposite_scope.elements\nint\n50000\nwrite_data_for_full_element_scope=True\nFieldsContainer" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_dict.html#to_dict", + "title": "to_dict", + "section": "to_dict", + "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.evaluate_failure_criteria", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.evaluate_failure_criteria.html#ansys.dpf.composites.composite_model.CompositeModel.evaluate_failure_criteria", - "title": "evaluate_failure_criteria > evaluate_failure_criteria > evaluate_failure_criteria", - "section": "evaluate_failure_criteria > evaluate_failure_criteria", - "text": "CompositeModel.evaluate_failure_criteria(combined_criterion, composite_scope=None, measure=FailureMeasureEnum.INVERSE_RESERVE_FACTOR, write_data_for_full_element_scope=True, max_chunk_size=50000)\n\nGet a fields container with the evaluated failure criteria.\n\nThe fields container contains the maximum per element if the measure\nis FailureMeasureEnum.INVERSE_RESERVE_FACTOR and the minimum per element\nif the measure is FailureMeasureEnum.MARGIN_OF_SAFETY or\nFailureMeasureEnum.RESERVE_FACTOR.\n\nParameters\n\ncombined_criterion (CombinedFailureCriterion) – Combined failure criterion to evaluate.\n\ncomposite_scope (Optional[CompositeScope], default: None) – Composite scope on which to evaluate the failure criteria. If empty, the criteria\nis evaluated on the full model. If the time is not set, the last time or\nfrequency in the result file is used.\n\nmeasure (FailureMeasureEnum, default: ) – Failure measure to evaluate.\n\nwrite_data_for_full_element_scope (bool, default: True) – Whether each element in the element scope is to get a\n(potentially zero) failure value, even elements that are not\npart of composite_scope.plies. If no element scope is\nspecified (composite_scope.elements), a (potentially zero)\nfailure value is written for all elements.\n\nmax_chunk_size (int, default: 50000) – A higher value results in more memory consumption, but faster evaluation.For some special element types such as beams,\nwrite_data_for_full_element_scope=True is not supported.\n\nReturn type\n\nFieldsContainer\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.to_dict", + "title": "to_dict > to_dict > to_dict", + "section": "to_dict > to_dict", + "text": "MaxStressCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.sc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.sc.html#sc", - "title": "sc", - "section": "sc", - "text": "sc" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_dict.html#to_dict", + "title": "to_dict", + "section": "to_dict", + "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.sc", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.sc.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.sc", - "title": "sc > sc > sc", - "section": "sc > sc", - "text": "FailureModeEnum.sc = 330\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.to_dict", + "title": "to_dict > to_dict > to_dict", + "section": "to_dict > to_dict", + "text": "CuntzeCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_container_helper_op", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_container_helper_op.html#material_container_helper_op", - "title": "material_container_helper_op", - "section": "material_container_helper_op", - "text": "Get material container helper operator.\nThis operator can be used to access metadata of the materials.\nReturn value is None if the server version does not support this operator.\nThe minimum version is 2024 R1-pre0 (7.1).\nOperator\nmaterial_container_helper_op\nOperator" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.get_element_info_provider", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.get_element_info_provider.html#get_element_info_provider", + "title": "get_element_info_provider", + "section": "get_element_info_provider", + "text": "Get ElementInfoProvider Object.\nmesh (MeshedRegion)\nstream_provider_or_data_source (Operator | DataSources) – dpf stream provider or dpf data source\nmaterial_provider (Optional[Operator], default: None) – DPF operator that provides material information.\nno_bounds_checks (bool, default: False) – Disable bounds checks. Improves\nperformance but can result in cryptic error messages\nElementInfoProvider\nEither a data_source or a stream_provider is required\nget_element_info_provider\nElementInfoProvider\nMeshedRegion\nOperator\nDataSources\nOptional\nOperator\nNone\nbool\nFalse" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_container_helper_op", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_container_helper_op.html#ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_container_helper_op", - "title": "material_container_helper_op > material_container_helper_op > material_container_helper_op", - "section": "material_container_helper_op > material_container_helper_op", - "text": "property MaterialOperators.material_container_helper_op: Operator\n\nGet material container helper operator.\n\nThis operator can be used to access metadata of the materials.\nReturn value is None if the server version does not support this operator.\nThe minimum version is 2024 R1-pre0 (7.1).\n\nReturn type\n\nOperator\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.get_element_info_provider", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.get_element_info_provider.html#ansys.dpf.composites.layup_info.get_element_info_provider", + "title": "get_element_info_provider > get_element_info_provider > get_element_info_provider", + "section": "get_element_info_provider > get_element_info_provider", + "text": "ansys.dpf.composites.layup_info.get_element_info_provider(mesh, stream_provider_or_data_source, material_provider=None, no_bounds_checks=False)\n\nGet ElementInfoProvider Object.\n\nParameters\n\nmesh (MeshedRegion)\n\nstream_provider_or_data_source (Operator | DataSources) – dpf stream provider or dpf data source\n\nmaterial_provider (Optional[Operator], default: None) – DPF operator that provides material information.\n\nno_bounds_checks (bool, default: False) – Disable bounds checks. Improves\nperformance but can result in cryptic error messages\n\nReturn type\n\nElementInfoProvider\n\nNotes\n\nEither a data_source or a stream_provider is required\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R12", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R12.html#hill_yield_criterion_r12", - "title": "Hill_Yield_Criterion_R12", - "section": "Hill_Yield_Criterion_R12", - "text": "Hill_Yield_Criterion_R12" + "objectID": "api/composite_model", + "href": "api/composite_model.html#composite-model", + "title": "Composite model", + "section": "Composite model", + "text": "CompositeModel(composite_files, server[, ...])\nProvides access to the basic composite postprocessing functionality.\nComposite model\nCompositeModel" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R12", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R12.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R12", - "title": "Hill_Yield_Criterion_R12 > Hill_Yield_Criterion_R12 > Hill_Yield_Criterion_R12", - "section": "Hill_Yield_Criterion_R12 > Hill_Yield_Criterion_R12", - "text": "MaterialProperty.Hill_Yield_Criterion_R12: str = 'yield_stress_ratio_xy_hill_criterion'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E2", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E2.html#engineering_constants_e2", + "title": "Engineering_Constants_E2", + "section": "Engineering_Constants_E2", + "text": "Engineering_Constants_E2" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.active.html#active", - "title": "active", - "section": "active", - "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E2", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E2.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E2", + "title": "Engineering_Constants_E2 > Engineering_Constants_E2 > Engineering_Constants_E2", + "section": "Engineering_Constants_E2 > Engineering_Constants_E2", + "text": "MaterialProperty.Engineering_Constants_E2: str = 'young_modulus_y_direction'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.active.html#ansys.dpf.composites.failure_criteria.CoreFailureCriterion.active", - "title": "active > active > active", - "section": "active > active", - "text": "property CoreFailureCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.b32", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.b32.html#b32", + "title": "b32", + "section": "b32", + "text": "Out-of-plane shear friction coefficient. The default is 1.3805. The value depends on the fracture plane angle.\nfloat\nb32\n1.3805\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.active.html#active", - "title": "active", - "section": "active", - "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.b32", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.b32.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.b32", + "title": "b32 > b32 > b32", + "section": "b32 > b32", + "text": "property CuntzeCriterion.b32: float\n\nOut-of-plane shear friction coefficient. The default is 1.3805. The value depends on the fracture plane angle.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.active.html#ansys.dpf.composites.failure_criteria.HashinCriterion.active", - "title": "active > active > active", - "section": "active > active", - "text": "property HashinCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_rst_streams_provider", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_rst_streams_provider.html#get_rst_streams_provider", + "title": "get_rst_streams_provider", + "section": "get_rst_streams_provider", + "text": "Get the streams provider of the loaded result file.\nOperator\nget_rst_streams_provider\nOperator" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rjust", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rjust.html#rjust", - "title": "rjust", - "section": "rjust", - "text": "Return a right-justified string of length width.\nPadding is done using the specified fill character (default is a space).\nrjust" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_rst_streams_provider", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_rst_streams_provider.html#ansys.dpf.composites.composite_model.CompositeModel.get_rst_streams_provider", + "title": "get_rst_streams_provider > get_rst_streams_provider > get_rst_streams_provider", + "section": "get_rst_streams_provider > get_rst_streams_provider", + "text": "CompositeModel.get_rst_streams_provider()\n\nGet the streams provider of the loaded result file.\n\nReturn type\n\nOperator\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rjust", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rjust.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.rjust", - "title": "rjust > rjust > rjust", - "section": "rjust > rjust", - "text": "FailureMeasureEnum.rjust(width, fillchar=' ', /)\n\nReturn a right-justified string of length width.\n\nPadding is done using the specified fill character (default is a space).\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.measure", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.measure.html#measure", + "title": "measure", + "section": "measure", + "text": "Return type of the failure values.\nSupported types are \"inverse_reserve_factor\", \"safety_factor\",\nand \"safety_margin\".\nstr\nmeasure\n\"inverse_reserve_factor\"\n\"safety_factor\"\n\"safety_margin\"\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kf.html#kf", - "title": "kf", - "section": "kf", - "text": "Weighting factor of the face sheets for evaluation of the maximum allowable load. The default is 0 so the face sheet does not contribute to the allowable load. This property is valid for thin face sheets.\nfloat\nkf\n0\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.measure", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinition.measure.html#ansys.dpf.composites.result_definition.ResultDefinition.measure", + "title": "measure > measure > measure", + "section": "measure > measure", + "text": "property ResultDefinition.measure: str\n\nReturn type of the failure values.\n\nSupported types are \"inverse_reserve_factor\", \"safety_factor\",\nand \"safety_margin\".\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kf.html#ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.kf", - "title": "kf > kf > kf", - "section": "kf > kf", - "text": "property ShearCrimpingCriterion.kf: float\n\nWeighting factor of the face sheets for evaluation of the maximum allowable load. The default is 0 so the face sheet does not contribute to the allowable load. This property is valid for thin face sheets.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.wf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.wf.html#wf", + "title": "wf", + "section": "wf", + "text": "Weighting factor of the failure mode (cs).\nfloat\nwf\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Spot", - "href": "api/_autosummary/ansys.dpf.composites.constants.Spot.html#spot", - "title": "Spot", - "section": "Spot", - "text": "Implements an interface to access the spots of the results of layered elements.\nSpot.BOTTOM\n\nSpot.MIDDLE\n\nSpot.TOP\n\nSpot\nSpot.BOTTOM\nSpot.MIDDLE\nSpot.TOP" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.wf", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CoreFailureCriterion.wf.html#ansys.dpf.composites.failure_criteria.CoreFailureCriterion.wf", + "title": "wf > wf > wf", + "section": "wf > wf", + "text": "property CoreFailureCriterion.wf: float\n\nWeighting factor of the failure mode (cs).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Spot", - "href": "api/_autosummary/ansys.dpf.composites.constants.Spot.html#ansys.dpf.composites.constants.Spot", - "title": "Spot > Spot > Spot", - "section": "Spot > Spot", - "text": "class ansys.dpf.composites.constants.Spot(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n\nImplements an interface to access the spots of the results of layered elements.\n\n!! processed by numpydoc !!\n\nAttributes\n\n\n\n\n\n\n\nSpot.BOTTOM\n\n\n\nSpot.MIDDLE\n\n\n\nSpot.TOP\n\n\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_indices", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_indices.html#get_indices", + "title": "get_indices", + "section": "get_indices", + "text": "Get the indices of the selected spots (interfaces) for each ply.\nThe indices are sorted from bottom to top.\nFor instance, this method can be used to access the stresses at the bottom of each ply.\nspots (Collection[Spot], default: (, , )) – Collection of spots. Only the indices of the bottom interfaces of plies\nare returned if [Spot.BOTTOM] is set.\nSequence[int]\nget_indices\nCollection\nSpot\n(, , )\n[Spot.BOTTOM]\nSequence\nint" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_support_provider", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_support_provider.html#material_support_provider", - "title": "material_support_provider", - "section": "material_support_provider", - "text": "Get material_support_provider.\nOperator\nmaterial_support_provider\nOperator" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_indices", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_indices.html#ansys.dpf.composites.sampling_point.SamplingPoint.get_indices", + "title": "get_indices > get_indices > get_indices", + "section": "get_indices > get_indices", + "text": "SamplingPoint.get_indices(spots=(Spot.BOTTOM, Spot.MIDDLE, Spot.TOP))\n\nGet the indices of the selected spots (interfaces) for each ply.\n\nThe indices are sorted from bottom to top.\nFor instance, this method can be used to access the stresses at the bottom of each ply.\n\nParameters\n\nspots (Collection[Spot], default: (, , )) – Collection of spots. Only the indices of the bottom interfaces of plies\nare returned if [Spot.BOTTOM] is set.\n\nExamples\n\n>>> ply_top_indices = sampling_point.get_indices([Spot.TOP])\n\nReturn type\n\nSequence[int]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_support_provider", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_support_provider.html#ansys.dpf.composites.layup_info.material_operators.MaterialOperators.material_support_provider", - "title": "material_support_provider > material_support_provider > material_support_provider", - "section": "material_support_provider > material_support_provider", - "text": "property MaterialOperators.material_support_provider: Operator\n\nGet material_support_provider.\n\nReturn type\n\nOperator\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2.html#s2", + "title": "s2", + "section": "s2", + "text": "s2" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.wf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.wf.html#wf", - "title": "wf", - "section": "wf", - "text": "Weighting factor of the failure mode (wb or wt).\nfloat\nwf\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s2.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s2", + "title": "s2 > s2 > s2", + "section": "s2 > s2", + "text": "FailureModeEnum.s2 = 220\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.wf", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.wf.html#ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.wf", - "title": "wf > wf > wf", - "section": "wf > wf", - "text": "property ShearCrimpingCriterion.wf: float\n\nWeighting factor of the failure mode (wb or wt).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3.html#s3", + "title": "s3", + "section": "s3", + "text": "s3" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.server_helpers.load_composites_plugin", - "href": "api/_autosummary/ansys.dpf.composites.server_helpers.load_composites_plugin.html#load_composites_plugin", - "title": "load_composites_plugin", - "section": "load_composites_plugin", - "text": "Load composites plugins and its dependencies.\nserver (BaseServer)\nansys_path (Optional[str], default: None) – Ansys root path, for example C:\\Program Files\\ANSYS Inc\\v232.\nIf None, it is assumed that all the plugins and their dependencies\nare found in the PATH/LD_LIBRARY_PATH. If ansys_path\nis set, the composite_operators and\nAns.Dpf.EngineeringData plugins are loaded from their location\nin the installer.\nNone\nload_composites_plugin\nBaseServer\nOptional\nstr\nNone\nNone" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.s3.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.s3", + "title": "s3 > s3 > s3", + "section": "s3 > s3", + "text": "FailureModeEnum.s3 = 230\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.server_helpers.load_composites_plugin", - "href": "api/_autosummary/ansys.dpf.composites.server_helpers.load_composites_plugin.html#ansys.dpf.composites.server_helpers.load_composites_plugin", - "title": "load_composites_plugin > load_composites_plugin > load_composites_plugin", - "section": "load_composites_plugin > load_composites_plugin", - "text": "ansys.dpf.composites.server_helpers.load_composites_plugin(server, ansys_path=None)\n\nLoad composites plugins and its dependencies.\n\nParameters\n\nserver (BaseServer)\n\nansys_path (Optional[str], default: None) – Ansys root path, for example C:\\Program Files\\ANSYS Inc\\v232.\nIf None, it is assumed that all the plugins and their dependencies\nare found in the PATH/LD_LIBRARY_PATH. If ansys_path\nis set, the composite_operators and\nAns.Dpf.EngineeringData plugins are loaded from their location\nin the installer.\n\nReturn type\n\nNone\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.startswith", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.startswith.html#startswith", + "title": "startswith", + "section": "startswith", + "text": "Return True if the string starts with the specified prefix, False otherwise.\nA string or a tuple of strings to try.\nOptional start position. Default: start of the string.\nOptional stop position. Default: end of the string.\nstartswith" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.html#larccriterion", - "title": "LaRCCriterion", - "section": "LaRCCriterion", - "text": "Defines the LaRC failure criterion for UD reinforced materials.\nlft (bool, default: True) – Whether to activate the failure evaluation regarding tension in fiber direction.\nlfc (bool, default: True) – Whether to activate the failure evaluation regarding compression in fiber direction.\nlmt (bool, default: True) – Whether to activate the failure evaluation of the matrix due to tension.\nlmc (bool, default: True) – Whether to activate the failure evaluation of the matrix due to compression.\ndim (int, default: 2) – Whether the 2D or 3D formulation of the criterion is used. 2D is equivalent to LaRC03, and 3D is equivalent to LaRC04.\nwf_lft (float, default: 1.0) – Weighting factor of fiber failure due to tension (lft).\nwf_lfc (float, default: 1.0) – Weighting factor of fiber failure due to compression (lfc).\nwf_lmt (float, default: 1.0) – Weighting factor of matrix failure due to tension (lmt).\nwf_lmc (float, default: 1.0) – Weighting factor of matrix failure due to compression (lmc).\nLaRCCriterion.to_dict()\n\nLaRCCriterion.to_json()\n\nLaRCCriterion.active\nThe failure criterion is suppressed if active is False.\nLaRCCriterion.dim\nWhether the 2D or 3D formulation of the criterion is used.\nLaRCCriterion.lfc\nWhether to activate the failure evaluation regarding compression in fiber direction.\nLaRCCriterion.lft\nWhether to activate the failure evaluation regarding tension in fiber direction.\nLaRCCriterion.lmc\nWhether to activate the failure evaluation of the matrix due to compression.\nLaRCCriterion.lmt\nWhether to activate the failure evaluation of the matrix due to tension.\nLaRCCriterion.name\nName of the failure criterion.\nLaRCCriterion.wf_lfc\nWeighting factor of fiber failure due to compression (lfc).\nLaRCCriterion.wf_lft\nWeighting factor of fiber failure due to tension (lft).\nLaRCCriterion.wf_lmc\nWeighting factor of matrix failure due to compression (lmc).\nLaRCCriterion.wf_lmt\nWeighting factor of matrix failure due to tension (lmt).\nLaRCCriterion\nbool\nTrue\nbool\nTrue\nbool\nTrue\nbool\nTrue\nint\n2\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nLaRCCriterion.to_dict\nLaRCCriterion.to_json\nLaRCCriterion.active\nLaRCCriterion.dim\nLaRCCriterion.lfc\nLaRCCriterion.lft\nLaRCCriterion.lmc\nLaRCCriterion.lmt\nLaRCCriterion.name\nLaRCCriterion.wf_lfc\nLaRCCriterion.wf_lft\nLaRCCriterion.wf_lmc\nLaRCCriterion.wf_lmt" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.startswith", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.startswith.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.startswith", + "title": "startswith > startswith > startswith", + "section": "startswith > startswith", + "text": "FailureMeasureEnum.startswith(prefix, [start, [end]], /)\n\nReturn True if the string starts with the specified prefix, False otherwise.\n\nprefix\n\nA string or a tuple of strings to try.\n\nstart\n\nOptional start position. Default: start of the string.\n\nend\n\nOptional stop position. Default: end of the string.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.html#ansys.dpf.composites.failure_criteria.LaRCCriterion", - "title": "LaRCCriterion > LaRCCriterion > LaRCCriterion", - "section": "LaRCCriterion > LaRCCriterion", - "text": "class ansys.dpf.composites.failure_criteria.LaRCCriterion(*, lft=True, lfc=True, lmt=True, lmc=True, dim=2, wf_lft=1.0, wf_lfc=1.0, wf_lmt=1.0, wf_lmc=1.0)\n\nDefines the LaRC failure criterion for UD reinforced materials.\n\nParameters\n\nlft (bool, default: True) – Whether to activate the failure evaluation regarding tension in fiber direction.\n\nlfc (bool, default: True) – Whether to activate the failure evaluation regarding compression in fiber direction.\n\nlmt (bool, default: True) – Whether to activate the failure evaluation of the matrix due to tension.\n\nlmc (bool, default: True) – Whether to activate the failure evaluation of the matrix due to compression.\n\ndim (int, default: 2) – Whether the 2D or 3D formulation of the criterion is used. 2D is equivalent to LaRC03, and 3D is equivalent to LaRC04.\n\nwf_lft (float, default: 1.0) – Weighting factor of fiber failure due to tension (lft).\n\nwf_lfc (float, default: 1.0) – Weighting factor of fiber failure due to compression (lfc).\n\nwf_lmt (float, default: 1.0) – Weighting factor of matrix failure due to tension (lmt).\n\nwf_lmc (float, default: 1.0) – Weighting factor of matrix failure due to compression (lmc).\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nLaRCCriterion.to_dict()\n\n\n\nLaRCCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nLaRCCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nLaRCCriterion.dim\n\nWhether the 2D or 3D formulation of the criterion is used.\n\nLaRCCriterion.lfc\n\nWhether to activate the failure evaluation regarding compression in fiber direction.\n\nLaRCCriterion.lft\n\nWhether to activate the failure evaluation regarding tension in fiber direction.\n\nLaRCCriterion.lmc\n\nWhether to activate the failure evaluation of the matrix due to compression.\n\nLaRCCriterion.lmt\n\nWhether to activate the failure evaluation of the matrix due to tension.\n\nLaRCCriterion.name\n\nName of the failure criterion.\n\nLaRCCriterion.wf_lfc\n\nWeighting factor of fiber failure due to compression (lfc).\n\nLaRCCriterion.wf_lft\n\nWeighting factor of fiber failure due to tension (lft).\n\nLaRCCriterion.wf_lmc\n\nWeighting factor of matrix failure due to compression (lmc).\n\nLaRCCriterion.wf_lmt\n\nWeighting factor of matrix failure due to tension (lmt).\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR11", + "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR11.html#tensor11", + "title": "TENSOR11", + "section": "TENSOR11", + "text": "TENSOR11" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lft", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lft.html#wf_lft", - "title": "wf_lft", - "section": "wf_lft", - "text": "Weighting factor of fiber failure due to tension (lft).\nfloat\nwf_lft\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR11", + "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR11.html#ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR11", + "title": "TENSOR11 > TENSOR11 > TENSOR11", + "section": "TENSOR11 > TENSOR11", + "text": "Sym3x3TensorComponent.TENSOR11 = 0\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lft", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lft.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.wf_lft", - "title": "wf_lft > wf_lft > wf_lft", - "section": "wf_lft > wf_lft", - "text": "property LaRCCriterion.wf_lft: float\n\nWeighting factor of fiber failure due to tension (lft).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1.html#e1", + "title": "e1", + "section": "e1", + "text": "e1" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.definition", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.definition.html#definition", - "title": "definition", - "section": "definition", - "text": "definition" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e1", + "title": "e1 > e1 > e1", + "section": "e1 > e1", + "text": "FailureModeEnum.e1 = 110\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.definition", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDefinitionFiles.definition.html#ansys.dpf.composites.data_sources.CompositeDefinitionFiles.definition", - "title": "definition > definition > definition", - "section": "definition > definition", - "text": "CompositeDefinitionFiles.definition: str | PathLike[str]\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isprintable", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isprintable.html#isprintable", + "title": "isprintable", + "section": "isprintable", + "text": "Return True if the string is printable, False otherwise.\nA string is printable if all of its characters are considered printable in\nrepr() or if it is empty.\nisprintable" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aZ", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aZ.html#thermal_expansion_coefficients_az", - "title": "Thermal_Expansion_Coefficients_aZ", - "section": "Thermal_Expansion_Coefficients_aZ", - "text": "Thermal_Expansion_Coefficients_aZ" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isprintable", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isprintable.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isprintable", + "title": "isprintable > isprintable > isprintable", + "section": "isprintable > isprintable", + "text": "FailureMeasureEnum.isprintable(/)\n\nReturn True if the string is printable, False otherwise.\n\nA string is printable if all of its characters are considered printable in\nrepr() or if it is empty.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aZ", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aZ.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Expansion_Coefficients_aZ", - "title": "Thermal_Expansion_Coefficients_aZ > Thermal_Expansion_Coefficients_aZ > Thermal_Expansion_Coefficients_aZ", - "section": "Thermal_Expansion_Coefficients_aZ > Thermal_Expansion_Coefficients_aZ", - "text": "MaterialProperty.Thermal_Expansion_Coefficients_aZ: str = 'coefficient_thermal_expansion_z'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.active.html#active", + "title": "active", + "section": "active", + "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.html#materialoperators", - "title": "MaterialOperators", - "section": "MaterialOperators", - "text": "Provides the container for material-related operators.\nmaterial_support_provider (Operator) – The material support provider takes care of mapping the materials in the RST file to\nthe materials in the composite definitions.\nThe material support contains all the materials from the RST file. Currently\nthe output of this operator cannot be inspected in Python.\nmaterial_provider (Operator) – Outputs the MaterialsContainer, which can be used to\nevaluate material properties. This container cannot be\nqueried in Python, but it can be passed to other DPF operators\nthat evaluate the properties.\nresult_info_provider (Operator) – Provides the ResultInfo object.\nMaterialOperators.material_container_helper_op\nGet material container helper operator.\nMaterialOperators.material_provider\nGet material_provider.\nMaterialOperators.material_support_provider\nGet material_support_provider.\nMaterialOperators.result_info_provider\nGet result_info_provider.\nMaterialOperators\nOperator\nOperator\nMaterialsContainer\nOperator\nResultInfo\nMaterialOperators.material_container_helper_op\nMaterialOperators.material_provider\nMaterialOperators.material_support_provider\nMaterialOperators.result_info_provider" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.active.html#ansys.dpf.composites.failure_criteria.PuckCriterion.active", + "title": "active > active > active", + "section": "active > active", + "text": "property PuckCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_operators.MaterialOperators.html#ansys.dpf.composites.layup_info.material_operators.MaterialOperators", - "title": "MaterialOperators > MaterialOperators > MaterialOperators", - "section": "MaterialOperators > MaterialOperators", - "text": "class ansys.dpf.composites.layup_info.material_operators.MaterialOperators(material_provider, material_support_provider, result_info_provider)\n\nProvides the container for material-related operators.\n\nParameters\n\nmaterial_support_provider (Operator) – The material support provider takes care of mapping the materials in the RST file to\nthe materials in the composite definitions.\nThe material support contains all the materials from the RST file. Currently\nthe output of this operator cannot be inspected in Python.\n\nmaterial_provider (Operator) – Outputs the MaterialsContainer, which can be used to\nevaluate material properties. This container cannot be\nqueried in Python, but it can be passed to other DPF operators\nthat evaluate the properties.\n\nresult_info_provider (Operator) – Provides the ResultInfo object.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nMaterialOperators.material_container_helper_op\n\nGet material container helper operator.\n\nMaterialOperators.material_provider\n\nGet material_provider.\n\nMaterialOperators.material_support_provider\n\nGet material_support_provider.\n\nMaterialOperators.result_info_provider\n\nGet result_info_provider.\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.to_json.html#to_json", + "title": "to_json", + "section": "to_json", + "text": "str\nthe string representation of the object as JSON.\nIt can be used for the result definition of the DPF Composites Failure Operator.\nto_json\nstr" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pd", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pd.html#wf_pd", - "title": "wf_pd", - "section": "wf_pd", - "text": "Weighting factor of the delamination failure (pd) mode.\nfloat\nwf_pd\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.to_json", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.to_json.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.to_json", + "title": "to_json > to_json > to_json", + "section": "to_json > to_json", + "text": "LaRCCriterion.to_json()\n\nReturn type\n\nstr\n\nReturns\n\nthe string representation of the object as JSON.\n\nIt can be used for the result definition of the DPF Composites Failure Operator.\n\n!! processed by numpydoc !!" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K3", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K3.html#thermal_conductivity_k3", + "title": "Thermal_Conductivity_K3", + "section": "Thermal_Conductivity_K3", + "text": "Thermal_Conductivity_K3" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pd", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pd.html#ansys.dpf.composites.failure_criteria.PuckCriterion.wf_pd", - "title": "wf_pd > wf_pd > wf_pd", - "section": "wf_pd > wf_pd", - "text": "property PuckCriterion.wf_pd: float\n\nWeighting factor of the delamination failure (pd) mode.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K3", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K3.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Thermal_Conductivity_K3", + "title": "Thermal_Conductivity_K3 > Thermal_Conductivity_K3 > Thermal_Conductivity_K3", + "section": "Thermal_Conductivity_K3 > Thermal_Conductivity_K3", + "text": "MaterialProperty.Thermal_Conductivity_K3: str = 'thermal_conductivity_z_direction'\n\n" }, { - "objectID": "examples/gallery_examples/099_dpf_composite_failure_workflow", - "href": "examples/gallery_examples/099_dpf_composite_failure_workflow.html#dpf-composite-failure-workflow", - "title": "DPF composite failure workflow", - "section": "DPF composite failure workflow", - "text": "This example shows how to use the native DPF Python interface to configure\nand run the composite failure evaluator. It connects the different DPF\noperators that are needed to evaluate composite failure criteria.\nFor simple use cases, using the composite failure operator or\ncomposite sampling point operator is preferable. For examples,\nsee sphx_glr_examples_gallery_examples_001_failure_operator_example.py\nand sphx_glr_examples_gallery_examples_002_sampling_point_example.py.\nAdditionally, sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py\nshows how helper functions can be used to obtain composite result data.\nDPF composite failure workflow" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.name.html#name", + "title": "name", + "section": "name", + "text": "Name of the combined failure criterion.\nstr\nname\nstr" }, { - "objectID": "examples/gallery_examples/099_dpf_composite_failure_workflow", - "href": "examples/gallery_examples/099_dpf_composite_failure_workflow.html#set-up-analysis", - "title": "DPF composite failure workflow > Set up analysis", - "section": "Set up analysis", - "text": "Setting up the analysis consists of loading Ansys libraries, configuring\nthe combined failure criterion, connecting to the DPF server, and\npreparing files.\nLoad Ansys libraries.\nConfigure the combined failure criterion.\nStart a DPF server and prepare files\nSet up analysis" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.name", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.name.html#ansys.dpf.composites.failure_criteria.CombinedFailureCriterion.name", + "title": "name > name > name", + "section": "name > name", + "text": "property CombinedFailureCriterion.name: str\n\nName of the combined failure criterion.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/099_dpf_composite_failure_workflow", - "href": "examples/gallery_examples/099_dpf_composite_failure_workflow.html#initialize-dpf-model-and-data-sources", - "title": "DPF composite failure workflow > Initialize DPF model and data sources", - "section": "Initialize DPF model and data sources", - "text": "Initialize the DPF model and the data sources.\nInitialize DPF model and data sources" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p21_pos", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p21_pos.html#p21_pos", + "title": "p21_pos", + "section": "p21_pos", + "text": "Global inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for tension.\nfloat\np21_pos\nfloat" }, { - "objectID": "examples/gallery_examples/099_dpf_composite_failure_workflow", - "href": "examples/gallery_examples/099_dpf_composite_failure_workflow.html#set-up-providers", - "title": "DPF composite failure workflow > Set up providers", - "section": "Set up providers", - "text": "Set up the mesh provider.\nSet up the material support provider.\nThe material support provider takes care of mapping the materials in the RST file to\nthe materials in the composite definitions.\nThe material support contains all materials from the RST file.\nSet up the result information provider, which gets\nthe unit system from the RST file.\nSet up the material provider\nThe material provider combines the material support in the engineering data\nXML file and the unit system. Its output can be used to evaluate material\nproperties.\nSet up the lay-up provider, which reads the composite definition file\nand enriches the mesh with the composite lay-up information.\nSet up providers" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p21_pos", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.p21_pos.html#ansys.dpf.composites.failure_criteria.PuckCriterion.p21_pos", + "title": "p21_pos > p21_pos > p21_pos", + "section": "p21_pos > p21_pos", + "text": "property PuckCriterion.p21_pos: float\n\nGlobal inclination factor in the \\sigma_1 - \\tau_{12} plane at \\sigma_2 = 0 for tension.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/099_dpf_composite_failure_workflow", - "href": "examples/gallery_examples/099_dpf_composite_failure_workflow.html#set-up-result-operators", - "title": "DPF composite failure workflow > Set up result operators", - "section": "Set up result operators", - "text": "Set up result operators for strains and stresses.\nrotate_to_global is False because the postprocessing engine expects the\nresults to be in the element coordinate system (material coordinate system).\nSet up result operators\nrotate_to_global\nFalse" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pma", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pma.html#pma", + "title": "pma", + "section": "pma", + "text": "Whether to activate the failure evaluation regarding matrix failure due to tension.\nbool\npma\nbool" }, { - "objectID": "examples/gallery_examples/099_dpf_composite_failure_workflow", - "href": "examples/gallery_examples/099_dpf_composite_failure_workflow.html#set-up-failure-evaluator", - "title": "DPF composite failure workflow > Set up failure evaluator", - "section": "Set up failure evaluator", - "text": "Set up the failure evaluator, which combines the results and\nevaluates all failure criteria. The output contains the\nmaximum failure criteria for each integration point.\nSet up failure evaluator" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pma", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.PuckCriterion.pma.html#ansys.dpf.composites.failure_criteria.PuckCriterion.pma", + "title": "pma > pma > pma", + "section": "pma > pma", + "text": "property PuckCriterion.pma: bool\n\nWhether to activate the failure evaluation regarding matrix failure due to tension.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/099_dpf_composite_failure_workflow", - "href": "examples/gallery_examples/099_dpf_composite_failure_workflow.html#compute-and-plot-failure-criteria", - "title": "DPF composite failure workflow > Compute and plot failure criteria", - "section": "Compute and plot failure criteria", - "text": "Use the output of the multiple failure criteria operator to\ncompute the minimum and maximum failure criteria for each element.\nPlot the maximum and minimum values.\nTotal running time of the script: (0 minutes 4.414 seconds)\nDownload Jupyter notebook: 099_dpf_composite_failure_workflow.ipynb\nDownload Python source code: 099_dpf_composite_failure_workflow.py\nDownload zipped: 099_dpf_composite_failure_workflow.zip\nGallery generated by Sphinx-Gallery\nCompute and plot failure criteria\nDownload Jupyter notebook: 099_dpf_composite_failure_workflow.ipynb\nDownload Python source code: 099_dpf_composite_failure_workflow.py\nDownload zipped: 099_dpf_composite_failure_workflow.zip" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isascii", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isascii.html#isascii", + "title": "isascii", + "section": "isascii", + "text": "Return True if all characters in the string are ASCII, False otherwise.\nASCII characters have code points in the range U+0000-U+007F.\nEmpty string is ASCII too.\nisascii" }, { - "objectID": "contribute", - "href": "contribute.html#contribute", - "title": "Contribute", - "section": "Contribute", - "text": "Contribute" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isascii", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isascii.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isascii", + "title": "isascii > isascii > isascii", + "section": "isascii > isascii", + "text": "FailureMeasureEnum.isascii(/)\n\nReturn True if all characters in the string are ASCII, False otherwise.\n\nASCII characters have code points in the range U+0000-U+007F.\nEmpty string is ASCII too.\n\n!! processed by numpydoc !!" }, { - "objectID": "contribute", - "href": "contribute.html#install-in-development-mode", - "title": "Contribute > Install in development mode", - "section": "Install in development mode", - "text": "Installing PyDPF - Composites in development mode allows\nyou to modify the source and enhance it.\nBefore attempting to contribute to PyDPF - Composites, ensure that you are thoroughly\nfamiliar with the PyAnsys Developer’s Guide.\nClone the repository:\nInstall dependencies:\nPyDPF - Composites uses Poetry\nto manage the development environment.\nCreate a virtual environment and install the package with the\ndevelopment dependencies:\nActivate the virtual environment:\nInstall in development mode" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope", + "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.html#compositescope", + "title": "CompositeScope", + "section": "CompositeScope", + "text": "Provides the composite scope.\nThis class defines which part of the model and solution step are selected.\nelements (collections.abc.Sequence[int] | None) – List of elements.\nplies (collections.abc.Sequence[str] | None) – List of plies.\ntime (float | None) – Time or frequency. You can use the\nCompositeModel.get_result_times_or_frequencies() method\nto list the solution steps.\nnamed_selections (collections.abc.Sequence[str] | None) – List of element sets.\nUse composite_model.get_mesh().available_named_selections to list\nall named selections.\nIf more than one scope (elements, named_selections and plies)\nis set, then the final element scope is the intersection\nof the defined parameters. All elements are selected if no parameter is set.\nCompositeScope.elements\n\nCompositeScope.named_selections\n\nCompositeScope.plies\n\nCompositeScope.time\n\nCompositeScope\nCompositeModel.get_result_times_or_frequencies()\nelements\nnamed_selections\nplies\nCompositeScope.elements\nCompositeScope.named_selections\nCompositeScope.plies\nCompositeScope.time" }, { - "objectID": "contribute", - "href": "contribute.html#test", - "title": "Contribute > Test", - "section": "Test", - "text": "There are different ways to run the PyDPF - Composites tests, depending on how the DPF\nserver is started.\nRun tests with a Docker container:\nFollow the steps in Getting the DPF server Docker image to get\nand run the DPF docker image. Run the tests with the following command\nRun tests with a DPF server started from the Ansys installer. The Ansys version must\nbe 2023 R2 or later.\nRun tests with a Docker container from Github (Ansys Internal only):\nTest" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope", + "href": "api/_autosummary/ansys.dpf.composites.composite_scope.CompositeScope.html#ansys.dpf.composites.composite_scope.CompositeScope", + "title": "CompositeScope > CompositeScope > CompositeScope", + "section": "CompositeScope > CompositeScope", + "text": "class ansys.dpf.composites.composite_scope.CompositeScope(elements=None, plies=None, time=None, named_selections=None)\n\nProvides the composite scope.\n\nThis class defines which part of the model and solution step are selected.\n\nParameters\n\nelements (collections.abc.Sequence[int] | None) – List of elements.\n\nplies (collections.abc.Sequence[str] | None) – List of plies.\n\ntime (float | None) – Time or frequency. You can use the\nCompositeModel.get_result_times_or_frequencies() method\nto list the solution steps.\n\nnamed_selections (collections.abc.Sequence[str] | None) – List of element sets.\nUse composite_model.get_mesh().available_named_selections to list\nall named selections.\n\nNotes\n\nIf more than one scope (elements, named_selections and plies)\nis set, then the final element scope is the intersection\nof the defined parameters. All elements are selected if no parameter is set.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nCompositeScope.elements\n\n\n\nCompositeScope.named_selections\n\n\n\nCompositeScope.plies\n\n\n\nCompositeScope.time\n\n\n\n" }, { - "objectID": "contribute", - "href": "contribute.html#build-documentation", - "title": "Contribute > Build documentation", - "section": "Build documentation", - "text": "Follow the description in Getting the DPF server Docker image image to get\nand run the dpf docker image.\nOn Windows, build the documentation with:\nOn Linux, build the documentation with:\nAnsys internal only: Build the docs with the latest container from Github:\nBuild documentation" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.active.html#active", + "title": "active", + "section": "active", + "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" }, { - "objectID": "contribute", - "href": "contribute.html#run-style-checks", - "title": "Contribute > Run style checks", - "section": "Run style checks", - "text": "The style checks use pre-commit and can be run through tox:\nThe style checks can also be configured to run automatically before each git commit:\nRun style checks\ngit commit" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.active.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.active", + "title": "active > active > active", + "section": "active > active", + "text": "property CuntzeCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "contribute", - "href": "contribute.html#view-documentation", - "title": "Contribute > View documentation", - "section": "View documentation", - "text": "Documentation for the latest stable release of PyDPF - Composites is hosted at\nPyDPF - Composites Documentation.\nIn the upper right corner of the documentation’s title bar, there is an option\nfor switching from viewing the documentation for the latest stable release\nto viewing the documentation for the development version or previously\nreleased versions.\nView documentation" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.results", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.results.html#results", + "title": "results", + "section": "results", + "text": "Results of the sampling point results as a JSON dictionary.\nAny\nresults\nAny" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmA", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmA.html#cma", - "title": "cmA", - "section": "cmA", - "text": "cmA" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.results", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.results.html#ansys.dpf.composites.sampling_point.SamplingPoint.results", + "title": "results > results > results", + "section": "results > results", + "text": "property SamplingPoint.results: Any\n\nResults of the sampling point results as a JSON dictionary.\n\nReturn type\n\nAny\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmA", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.cmA.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.cmA", - "title": "cmA > cmA > cmA", - "section": "cmA > cmA", - "text": "FailureModeEnum.cmA = 1003\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_dict.html#to_dict", + "title": "to_dict", + "section": "to_dict", + "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_constant_property_dict", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_constant_property_dict.html#get_constant_property_dict", - "title": "get_constant_property_dict", - "section": "get_constant_property_dict", - "text": "Get a dictionary with constant properties.\nReturns a dictionary with dpf_material_id as the key and\na dictionary with the requested properties as the value. Only constant properties\nare supported. Variable properties are evaluated at their\ndefault values.\nThis method can be slow to evaluate and should not\nbe called in a loop.\nmaterial_properties (Collection[MaterialProperty]) – List of the requested material properties.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nThe dictionary only contains the materials of the analysis plies defined\nin the specified composite definition.\ndict[int64, dict[MaterialProperty, float]]\nget_constant_property_dict\ndpf_material_id\nCollection\nMaterialProperty\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\ndict\nint64\ndict\nMaterialProperty\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.TsaiHillCriterion.to_dict", + "title": "to_dict > to_dict > to_dict", + "section": "to_dict > to_dict", + "text": "TsaiHillCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_constant_property_dict", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_constant_property_dict.html#ansys.dpf.composites.composite_model.CompositeModel.get_constant_property_dict", - "title": "get_constant_property_dict > get_constant_property_dict > get_constant_property_dict", - "section": "get_constant_property_dict > get_constant_property_dict", - "text": "CompositeModel.get_constant_property_dict(material_properties, composite_definition_label=None)\n\nGet a dictionary with constant properties.\n\nReturns a dictionary with dpf_material_id as the key and\na dictionary with the requested properties as the value. Only constant properties\nare supported. Variable properties are evaluated at their\ndefault values.\n\nThis method can be slow to evaluate and should not\nbe called in a loop.\n\nParameters\n\nmaterial_properties (Collection[MaterialProperty]) – List of the requested material properties.\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nThe dictionary only contains the materials of the analysis plies defined\nin the specified composite definition.\n\nReturn type\n\ndict[int64, dict[MaterialProperty, float]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.to_dict.html#to_dict", + "title": "to_dict", + "section": "to_dict", + "text": "dict[str, Any]\na dict with all properties.\nto_dict\ndict\nstr\nAny" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_result_plots", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_result_plots.html#get_result_plots", - "title": "get_result_plots", - "section": "get_result_plots", - "text": "Generate a figure with a grid of axes (plot) for each selected result entity.\nstrain_components (Sequence[str], default: ('e1', 'e2', 'e3', 'e12', 'e13', 'e23')) – Strain entities of interest. Supported values are \"e1\", \"e2\",\n\"e3\", \"e12\", \"e13\", and \"e23\". The plot is skipped\nif the list is empty.\nstress_components (Sequence[str], default: ('s1', 's2', 's3', 's12', 's13', 's23')) – Stress entities of interest. Supported values are \"s1\", \"s2\",\n\"s3\", \"s12\", \"s13\", and \"s23\". The plot is skipped\nif the list is empty.\nfailure_components (Sequence[FailureMeasureEnum], default: (, , )) – Failure values of interest. Values supported are \"irf\", \"rf\",\nand \"mos\". The plot is skipped if the list is empty.\nshow_failure_modes (bool, default: False) – WHether to add the critical failure mode to the failure plot.\ncreate_laminate_plot (bool, default: True) – Whether to plot the stacking sequence of the laminate, including text information\nsuch as material, thickness, and angle.\ncore_scale_factor (float, default: 1.0) – Factor for scaling the thickness of core plies.\nspots (Collection[Spot], default: (, , )) – Spots (interfaces) to show results at.\nSamplingPointFigure\nget_result_plots\nSequence\nstr\n('e1', 'e2', 'e3', 'e12', 'e13', 'e23')\n\"e1\"\n\"e2\"\n\"e3\"\n\"e12\"\n\"e13\"\n\"e23\"\nSequence\nstr\n('s1', 's2', 's3', 's12', 's13', 's23')\n\"s1\"\n\"s2\"\n\"s3\"\n\"s12\"\n\"s13\"\n\"s23\"\nSequence\nFailureMeasureEnum\n(, , )\n\"irf\"\n\"rf\"\n\"mos\"\nbool\nFalse\nbool\nTrue\nfloat\n1.0\nCollection\nSpot\n(, , )\nSamplingPointFigure" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.to_dict", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.to_dict.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.to_dict", + "title": "to_dict > to_dict > to_dict", + "section": "to_dict > to_dict", + "text": "LaRCCriterion.to_dict()\n\nReturn type\n\ndict[str, Any]\n\nReturns\n\na dict with all properties.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_result_plots", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.get_result_plots.html#ansys.dpf.composites.sampling_point.SamplingPoint.get_result_plots", - "title": "get_result_plots > get_result_plots > get_result_plots", - "section": "get_result_plots > get_result_plots", - "text": "SamplingPoint.get_result_plots(strain_components=('e1', 'e2', 'e3', 'e12', 'e13', 'e23'), stress_components=('s1', 's2', 's3', 's12', 's13', 's23'), failure_components=(FailureMeasureEnum.INVERSE_RESERVE_FACTOR, FailureMeasureEnum.RESERVE_FACTOR, FailureMeasureEnum.MARGIN_OF_SAFETY), show_failure_modes=False, create_laminate_plot=True, core_scale_factor=1.0, spots=(Spot.BOTTOM, Spot.MIDDLE, Spot.TOP))\n\nGenerate a figure with a grid of axes (plot) for each selected result entity.\n\nParameters\n\nstrain_components (Sequence[str], default: ('e1', 'e2', 'e3', 'e12', 'e13', 'e23')) – Strain entities of interest. Supported values are \"e1\", \"e2\",\n\"e3\", \"e12\", \"e13\", and \"e23\". The plot is skipped\nif the list is empty.\n\nstress_components (Sequence[str], default: ('s1', 's2', 's3', 's12', 's13', 's23')) – Stress entities of interest. Supported values are \"s1\", \"s2\",\n\"s3\", \"s12\", \"s13\", and \"s23\". The plot is skipped\nif the list is empty.\n\nfailure_components (Sequence[FailureMeasureEnum], default: (, , )) – Failure values of interest. Values supported are \"irf\", \"rf\",\nand \"mos\". The plot is skipped if the list is empty.\n\nshow_failure_modes (bool, default: False) – WHether to add the critical failure mode to the failure plot.\n\ncreate_laminate_plot (bool, default: True) – Whether to plot the stacking sequence of the laminate, including text information\nsuch as material, thickness, and angle.\n\ncore_scale_factor (float, default: 1.0) – Factor for scaling the thickness of core plies.\n\nspots (Collection[Spot], default: (, , )) – Spots (interfaces) to show results at.\n\nExamples\n\n>>> figure, axes = sampling_point.get_result_plots()\n\nReturn type\n\nSamplingPointFigure\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.dim", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.dim.html#dim", + "title": "dim", + "section": "dim", + "text": "Whether the 2D or 3D formulation of the criterion is used. The latter one also supports the failure mode delamination.\nint\ndim\nint" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.get_composites_data_sources", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.get_composites_data_sources.html#get_composites_data_sources", - "title": "get_composites_data_sources", - "section": "get_composites_data_sources", - "text": "Create DPF data sources from a ContinuousFiberCompositeFiles object.\ncontinuous_composite_files (ContinuousFiberCompositesFiles)\nCompositeDataSources\nget_composites_data_sources\nContinuousFiberCompositeFiles\nContinuousFiberCompositesFiles\nCompositeDataSources" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.dim", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.HashinCriterion.dim.html#ansys.dpf.composites.failure_criteria.HashinCriterion.dim", + "title": "dim > dim > dim", + "section": "dim > dim", + "text": "property HashinCriterion.dim: int\n\nWhether the 2D or 3D formulation of the criterion is used. The latter one also supports the failure mode delamination.\n\nReturn type\n\nint\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.get_composites_data_sources", - "href": "api/_autosummary/ansys.dpf.composites.data_sources.get_composites_data_sources.html#ansys.dpf.composites.data_sources.get_composites_data_sources", - "title": "get_composites_data_sources > get_composites_data_sources > get_composites_data_sources", - "section": "get_composites_data_sources > get_composites_data_sources", - "text": "ansys.dpf.composites.data_sources.get_composites_data_sources(continuous_composite_files)\n\nCreate DPF data sources from a ContinuousFiberCompositeFiles object.\n\nParameters\n\ncontinuous_composite_files (ContinuousFiberCompositesFiles)\n\nReturn type\n\nCompositeDataSources\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e2", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e2.html#wf_e2", + "title": "wf_e2", + "section": "wf_e2", + "text": "Weighting factor of the failure mode e2.\nfloat\nwf_e2\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s3", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s3.html#wf_s3", - "title": "wf_s3", - "section": "wf_s3", - "text": "Weighting factor of the failure mode s3.\nfloat\nwf_s3\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e2", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e2.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.wf_e2", + "title": "wf_e2 > wf_e2 > wf_e2", + "section": "wf_e2 > wf_e2", + "text": "property MaxStrainCriterion.wf_e2: float\n\nWeighting factor of the failure mode e2.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s3", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s3.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion.wf_s3", - "title": "wf_s3 > wf_s3 > wf_s3", - "section": "wf_s3 > wf_s3", - "text": "property MaxStressCriterion.wf_s3: float\n\nWeighting factor of the failure mode s3.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1c", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1c.html#e1c", + "title": "e1c", + "section": "e1c", + "text": "e1c" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.ply_scope", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.ply_scope.html#ply_scope", - "title": "ply_scope", - "section": "ply_scope", - "text": "ply_scope" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1c", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e1c.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e1c", + "title": "e1c > e1c > e1c", + "section": "e1c > e1c", + "text": "FailureModeEnum.e1c = 112\n\n" + }, + { + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zc", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zc.html#stress_limits_zc", + "title": "Stress_Limits_Zc", + "section": "Stress_Limits_Zc", + "text": "Stress_Limits_Zc" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.ply_scope", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.ply_scope.html#ansys.dpf.composites.result_definition.ResultDefinitionScope.ply_scope", - "title": "ply_scope > ply_scope > ply_scope", - "section": "ply_scope > ply_scope", - "text": "ResultDefinitionScope.ply_scope: Sequence[str]\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zc", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zc.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Zc", + "title": "Stress_Limits_Zc > Stress_Limits_Zc > Stress_Limits_Zc", + "section": "Stress_Limits_Zc > Stress_Limits_Zc", + "text": "MaterialProperty.Stress_Limits_Zc: str = 'stress_compressive_z_direction'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR33", - "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR33.html#tensor33", - "title": "TENSOR33", - "section": "TENSOR33", - "text": "TENSOR33" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.engineering_data", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.engineering_data.html#engineering_data", + "title": "engineering_data", + "section": "engineering_data", + "text": "engineering_data" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR33", - "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR33.html#ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR33", - "title": "TENSOR33 > TENSOR33 > TENSOR33", - "section": "TENSOR33 > TENSOR33", - "text": "Sym3x3TensorComponent.TENSOR33 = 2\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.engineering_data", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.engineering_data.html#ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.engineering_data", + "title": "engineering_data > engineering_data > engineering_data", + "section": "engineering_data > engineering_data", + "text": "ShortFiberCompositesFiles.engineering_data: str | PathLike[str]\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e23", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e23.html#e23", - "title": "e23", - "section": "e23", - "text": "e23" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.files_are_local", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.files_are_local.html#files_are_local", + "title": "files_are_local", + "section": "files_are_local", + "text": "files_are_local" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e23", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e23.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e23", - "title": "e23 > e23 > e23", - "section": "e23 > e23", - "text": "FailureModeEnum.e23 = 160\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.files_are_local", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.files_are_local.html#ansys.dpf.composites.data_sources.ContinuousFiberCompositesFiles.files_are_local", + "title": "files_are_local > files_are_local > files_are_local", + "section": "files_are_local > files_are_local", + "text": "ContinuousFiberCompositesFiles.files_are_local: bool = True\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2t", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2t.html#e2t", - "title": "e2t", - "section": "e2t", - "text": "e2t" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E.html#engineering_constants_e", + "title": "Engineering_Constants_E", + "section": "Engineering_Constants_E", + "text": "Engineering_Constants_E" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2t", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.e2t.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.e2t", - "title": "e2t > e2t > e2t", - "section": "e2t > e2t", - "text": "FailureModeEnum.e2t = 121\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Engineering_Constants_E", + "title": "Engineering_Constants_E > Engineering_Constants_E > Engineering_Constants_E", + "section": "Engineering_Constants_E > Engineering_Constants_E", + "text": "MaterialProperty.Engineering_Constants_E: str = 'young_modulus'\n\n" }, { - "objectID": "api/server_helpers", - "href": "api/server_helpers.html#server-helpers", - "title": "Server helpers", - "section": "Server helpers", - "text": "load_composites_plugin(server[, ansys_path])\nLoad composites plugins and its dependencies.\nconnect_to_or_start_server([port, ip, ...])\nConnect to or start a DPF server with the DPF Composites plugin loaded.\nupload_continuous_fiber_composite_files_to_server(...)\nUpload continuous fiber composites files to server.\nupload_short_fiber_composite_files_to_server(...)\nUpload short fiber composites files to server.\nServer helpers\nload_composites_plugin\nconnect_to_or_start_server\nupload_continuous_fiber_composite_files_to_server\nupload_short_fiber_composite_files_to_server" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmB", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmB.html#pmb", + "title": "pmB", + "section": "pmB", + "text": "pmB" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cma", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cma.html#cma", - "title": "cma", - "section": "cma", - "text": "Activates the failure evaluation of the matrix due to tension.\nbool\ncma\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmB", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmB.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.pmB", + "title": "pmB > pmB > pmB", + "section": "pmB > pmB", + "text": "FailureModeEnum.pmB = 803\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cma", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.cma.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.cma", - "title": "cma > cma > cma", - "section": "cma > cma", - "text": "property CuntzeCriterion.cma: bool\n\nActivates the failure evaluation of the matrix due to tension.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.active.html#active", + "title": "active", + "section": "active", + "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_rst_streams_provider", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_rst_streams_provider.html#get_rst_streams_provider", - "title": "get_rst_streams_provider", - "section": "get_rst_streams_provider", - "text": "Get the streams provider of the loaded result file.\nOperator\nget_rst_streams_provider\nOperator" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.active", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.active.html#ansys.dpf.composites.failure_criteria.ShearCrimpingCriterion.active", + "title": "active > active > active", + "section": "active > active", + "text": "property ShearCrimpingCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_rst_streams_provider", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_rst_streams_provider.html#ansys.dpf.composites.composite_model.CompositeModel.get_rst_streams_provider", - "title": "get_rst_streams_provider > get_rst_streams_provider > get_rst_streams_provider", - "section": "get_rst_streams_provider > get_rst_streams_provider", - "text": "CompositeModel.get_rst_streams_provider()\n\nGet the streams provider of the loaded result file.\n\nReturn type\n\nOperator\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.dsdat", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.dsdat.html#dsdat", + "title": "dsdat", + "section": "dsdat", + "text": "dsdat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isdigit", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isdigit.html#isdigit", - "title": "isdigit", - "section": "isdigit", - "text": "Return True if the string is a digit string, False otherwise.\nA string is a digit string if all characters in the string are digits and there\nis at least one character in the string.\nisdigit" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.dsdat", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.dsdat.html#ansys.dpf.composites.data_sources.ShortFiberCompositesFiles.dsdat", + "title": "dsdat > dsdat > dsdat", + "section": "dsdat > dsdat", + "text": "ShortFiberCompositesFiles.dsdat: str | PathLike[str]\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isdigit", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isdigit.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isdigit", - "title": "isdigit > isdigit > isdigit", - "section": "isdigit > isdigit", - "text": "FailureMeasureEnum.isdigit(/)\n\nReturn True if the string is a digit string, False otherwise.\n\nA string is a digit string if all characters in the string are digits and there\nis at least one character in the string.\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R23", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R23.html#hill_yield_criterion_r23", + "title": "Hill_Yield_Criterion_R23", + "section": "Hill_Yield_Criterion_R23", + "text": "Hill_Yield_Criterion_R23" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.html#samplingpoint", - "title": "SamplingPoint", - "section": "SamplingPoint", - "text": "Implements the Sampling Point object that wraps the DPF sampling point operator.\nUse CompositeModel.get_sampling_point() to get a sampling point object.\nThis class provides for plotting the lay-up and results at a certain point of the\nlayered structure. The results, including analysis_plies, e1, s12, and\nfailure_modes, are always from the bottom to the top of the laminate (along\nthe element normal direction). Postprocessing results such as e1 are returned\nas flat arrays where self.spots_per_ply can be used to compute the index for\na certain ply.\nThe results of layered elements are stored per integration point. A layered shell element\nhas a number of in-plane integration points (depending on the integration scheme) and\ntypically three integration points through the thickness. The through-the-thickness\nintegration points are called spots. They are typically at the BOTTOM, MIDDLE,\nand TOP of the layer. This notation is used here to identify the corresponding data.\nThe SamplingPoint class returns three results per layer (one for each spot) because\nthe results of the in-plane integration points are interpolated to the centroid of the element.\nThe following table shows an example of a laminate with three layers. So a result, such as\ns1 has nine values, three for each ply.\nLayer\nIndex\nSpot\nLayer 3\n8\n7\n6\nTOP of Layer 3\nMIDDLE of Layer 3\nBOTTOM of Layer 3\nLayer 2\n5\n4\n3\nTOP of Layer 2\nMIDDLE of Layer 2\nBOTTOM of Layer 2\nLayer 1\n2\n1\n0\nTOP of Layer 1\nMIDDLE of Layer 1\nBOTTOM of Layer 1\nThe get_indices and get_offsets_by_spots methods simplify the indexing and\nfiltering of the data.\nSamplingPoint.add_ply_sequence_to_plot(axes)\nAdd the stacking (ply and text) to an axis or plot.\nSamplingPoint.add_results_to_plot(axes, ...)\nAdd results (strain, stress, or failure values) to an Axes object.\nSamplingPoint.get_indices([spots])\nGet the indices of the selected spots (interfaces) for each ply.\nSamplingPoint.get_offsets_by_spots([spots, ...])\nAccess the y coordinates of the selected spots (interfaces) for each ply.\nSamplingPoint.get_ply_wise_critical_failures()\nGet the critical failure value and modes per ply.\nSamplingPoint.get_polar_plot([components])\nCreate a standard polar plot to visualize the polar properties of the laminate.\nSamplingPoint.get_result_plots([...])\nGenerate a figure with a grid of axes (plot) for each selected result entity.\nSamplingPoint.analysis_plies\nList of analysis plies from the bottom to the top.\nSamplingPoint.e1\nStrains in the material 1 direction of each ply.\nSamplingPoint.e12\nIn-plane shear strains e12 of each ply.\nSamplingPoint.e13\nOut-of-plane shear strains e13 of each ply.\nSamplingPoint.e2\nStrains in the material 2 direction of each ply.\nSamplingPoint.e23\nOut-of-plane shear strains e23 of each ply.\nSamplingPoint.e3\nStrains in the material 3 direction of each ply.\nSamplingPoint.element_id\nElement label for sampling the laminate.\nSamplingPoint.failure_modes\nCritical failure mode of each ply.\nSamplingPoint.inverse_reserve_factor\nCritical inverse reserve factor of each ply.\nSamplingPoint.is_uptodate\nTrue if the Sampling Point is up-to-date.\nSamplingPoint.margin_of_safety\nLowest margin of safety of each ply.\nSamplingPoint.name\nName of the object.\nSamplingPoint.number_of_plies\nNumber of plies.\nSamplingPoint.offsets\nZ coordinates for each interface and ply.\nSamplingPoint.polar_properties_E1\nPolar property E1 of the laminate.\nSamplingPoint.polar_properties_E2\nPolar property E2 of the laminate.\nSamplingPoint.polar_properties_G12\nPolar property G12 of the laminate.\nSamplingPoint.reserve_factor\nLowest reserve factor of each ply.\nSamplingPoint.results\nResults of the sampling point results as a JSON dictionary.\nSamplingPoint.s1\nStresses in the material 1 direction of each ply.\nSamplingPoint.s12\nIn-plane shear stresses s12 of each ply.\nSamplingPoint.s13\nOut-of-plane shear stresses s13 of each ply.\nSamplingPoint.s2\nStresses in the material 2 direction of each ply.\nSamplingPoint.s23\nOut-of-plane shear stresses s23 of each ply.\nSamplingPoint.s3\nStresses in the material 3 direction of each ply.\nSamplingPoint.spots_per_ply\nNumber of through-the-thickness integration points per ply.\nSamplingPoint\nSampling Point\nCompositeModel.get_sampling_point()\nanalysis_plies\ne1\ns12\nfailure_modes\ne1\nself.spots_per_ply\nBOTTOM\nMIDDLE\nTOP\nSamplingPoint\ns1\nSamplingPoint.add_ply_sequence_to_plot\nSamplingPoint.add_results_to_plot\nAxes\nSamplingPoint.get_indices\nSamplingPoint.get_offsets_by_spots\nSamplingPoint.get_ply_wise_critical_failures\nSamplingPoint.get_polar_plot\nSamplingPoint.get_result_plots\nSamplingPoint.analysis_plies\nSamplingPoint.e1\nSamplingPoint.e12\nSamplingPoint.e13\nSamplingPoint.e2\nSamplingPoint.e23\nSamplingPoint.e3\nSamplingPoint.element_id\nSamplingPoint.failure_modes\nSamplingPoint.inverse_reserve_factor\nSamplingPoint.is_uptodate\nSamplingPoint.margin_of_safety\nSamplingPoint.name\nSamplingPoint.number_of_plies\nSamplingPoint.offsets\nSamplingPoint.polar_properties_E1\nSamplingPoint.polar_properties_E2\nSamplingPoint.polar_properties_G12\nSamplingPoint.reserve_factor\nSamplingPoint.results\nSamplingPoint.s1\nSamplingPoint.s12\nSamplingPoint.s13\nSamplingPoint.s2\nSamplingPoint.s23\nSamplingPoint.s3\nSamplingPoint.spots_per_ply" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R23", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R23.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R23", + "title": "Hill_Yield_Criterion_R23 > Hill_Yield_Criterion_R23 > Hill_Yield_Criterion_R23", + "section": "Hill_Yield_Criterion_R23 > Hill_Yield_Criterion_R23", + "text": "MaterialProperty.Hill_Yield_Criterion_R23: str = 'yield_stress_ratio_yz_hill_criterion'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.html#ansys.dpf.composites.sampling_point.SamplingPoint", - "title": "SamplingPoint > SamplingPoint > SamplingPoint", - "section": "SamplingPoint > SamplingPoint", - "text": "class ansys.dpf.composites.sampling_point.SamplingPoint(*args, **kwargs)\n\nImplements the Sampling Point object that wraps the DPF sampling point operator.\n\nUse CompositeModel.get_sampling_point() to get a sampling point object.\nThis class provides for plotting the lay-up and results at a certain point of the\nlayered structure. The results, including analysis_plies, e1, s12, and\nfailure_modes, are always from the bottom to the top of the laminate (along\nthe element normal direction). Postprocessing results such as e1 are returned\nas flat arrays where self.spots_per_ply can be used to compute the index for\na certain ply.\n\nNotes\n\nThe results of layered elements are stored per integration point. A layered shell element\nhas a number of in-plane integration points (depending on the integration scheme) and\ntypically three integration points through the thickness. The through-the-thickness\nintegration points are called spots. They are typically at the BOTTOM, MIDDLE,\nand TOP of the layer. This notation is used here to identify the corresponding data.\n\nThe SamplingPoint class returns three results per layer (one for each spot) because\nthe results of the in-plane integration points are interpolated to the centroid of the element.\nThe following table shows an example of a laminate with three layers. So a result, such as\ns1 has nine values, three for each ply.\n\n\n\n\n\n\n\nLayer\n\nIndex\n\nSpot\n\nLayer 3\n\n8\n\n7\n\n6\n\nTOP of Layer 3\n\nMIDDLE of Layer 3\n\nBOTTOM of Layer 3\n\nLayer 2\n\n5\n\n4\n\n3\n\nTOP of Layer 2\n\nMIDDLE of Layer 2\n\nBOTTOM of Layer 2\n\nLayer 1\n\n2\n\n1\n\n0\n\nTOP of Layer 1\n\nMIDDLE of Layer 1\n\nBOTTOM of Layer 1\n\nThe get_indices and get_offsets_by_spots methods simplify the indexing and\nfiltering of the data.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nSamplingPoint.add_ply_sequence_to_plot(axes)\n\nAdd the stacking (ply and text) to an axis or plot.\n\nSamplingPoint.add_results_to_plot(axes, ...)\n\nAdd results (strain, stress, or failure values) to an Axes object.\n\nSamplingPoint.get_indices([spots])\n\nGet the indices of the selected spots (interfaces) for each ply.\n\nSamplingPoint.get_offsets_by_spots([spots, ...])\n\nAccess the y coordinates of the selected spots (interfaces) for each ply.\n\nSamplingPoint.get_ply_wise_critical_failures()\n\nGet the critical failure value and modes per ply.\n\nSamplingPoint.get_polar_plot([components])\n\nCreate a standard polar plot to visualize the polar properties of the laminate.\n\nSamplingPoint.get_result_plots([...])\n\nGenerate a figure with a grid of axes (plot) for each selected result entity.\n\n\n\nAttributes\n\n\n\n\n\n\n\nSamplingPoint.analysis_plies\n\nList of analysis plies from the bottom to the top.\n\nSamplingPoint.e1\n\nStrains in the material 1 direction of each ply.\n\nSamplingPoint.e12\n\nIn-plane shear strains e12 of each ply.\n\nSamplingPoint.e13\n\nOut-of-plane shear strains e13 of each ply.\n\nSamplingPoint.e2\n\nStrains in the material 2 direction of each ply.\n\nSamplingPoint.e23\n\nOut-of-plane shear strains e23 of each ply.\n\nSamplingPoint.e3\n\nStrains in the material 3 direction of each ply.\n\nSamplingPoint.element_id\n\nElement label for sampling the laminate.\n\nSamplingPoint.failure_modes\n\nCritical failure mode of each ply.\n\nSamplingPoint.inverse_reserve_factor\n\nCritical inverse reserve factor of each ply.\n\nSamplingPoint.is_uptodate\n\nTrue if the Sampling Point is up-to-date.\n\nSamplingPoint.margin_of_safety\n\nLowest margin of safety of each ply.\n\nSamplingPoint.name\n\nName of the object.\n\nSamplingPoint.number_of_plies\n\nNumber of plies.\n\nSamplingPoint.offsets\n\nZ coordinates for each interface and ply.\n\nSamplingPoint.polar_properties_E1\n\nPolar property E1 of the laminate.\n\nSamplingPoint.polar_properties_E2\n\nPolar property E2 of the laminate.\n\nSamplingPoint.polar_properties_G12\n\nPolar property G12 of the laminate.\n\nSamplingPoint.reserve_factor\n\nLowest reserve factor of each ply.\n\nSamplingPoint.results\n\nResults of the sampling point results as a JSON dictionary.\n\nSamplingPoint.s1\n\nStresses in the material 1 direction of each ply.\n\nSamplingPoint.s12\n\nIn-plane shear stresses s12 of each ply.\n\nSamplingPoint.s13\n\nOut-of-plane shear stresses s13 of each ply.\n\nSamplingPoint.s2\n\nStresses in the material 2 direction of each ply.\n\nSamplingPoint.s23\n\nOut-of-plane shear stresses s23 of each ply.\n\nSamplingPoint.s3\n\nStresses in the material 3 direction of each ply.\n\nSamplingPoint.spots_per_ply\n\nNumber of through-the-thickness integration points per ply.\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.lower", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.lower.html#lower", + "title": "lower", + "section": "lower", + "text": "Return a copy of the string converted to lowercase.\nlower" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_info", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_info.html#get_element_info", - "title": "get_element_info", - "section": "get_element_info", - "text": "Get element information for an element ID.\nThis method returns None if the element type is not supported.\nelement_id (int) – Element ID or label.\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\nOptional[ElementInfo]\nget_element_info\nNone\nint\nOptional\nstr\nNone\nContinuousFiberCompositesFiles.composite\nCompositeModel\nOptional\nElementInfo" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.lower", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.lower.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.lower", + "title": "lower > lower > lower", + "section": "lower > lower", + "text": "FailureMeasureEnum.lower(/)\n\nReturn a copy of the string converted to lowercase.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_info", - "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.get_element_info.html#ansys.dpf.composites.composite_model.CompositeModel.get_element_info", - "title": "get_element_info > get_element_info > get_element_info", - "section": "get_element_info > get_element_info", - "text": "CompositeModel.get_element_info(element_id, composite_definition_label=None)\n\nGet element information for an element ID.\n\nThis method returns None if the element type is not supported.\n\nParameters\n\nelement_id (int) – Element ID or label.\n\ncomposite_definition_label (Optional[str], default: None) – Label of the composite definition, which is the\ndictionary key in the ContinuousFiberCompositesFiles.composite\nattribute. This parameter is only required for assemblies.\nSee the note about assemblies in the description for the CompositeModel class.\n\nReturn type\n\nOptional[ElementInfo]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.translate", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.translate.html#translate", + "title": "translate", + "section": "translate", + "text": "Replace each character in the string using the given translation table.\nTranslation table, which must be a mapping of Unicode ordinals to\nUnicode ordinals, strings, or None.\nThe table must implement lookup/indexing via __getitem__, for instance a\ndictionary or list. If this operation raises LookupError, the character is\nleft untouched. Characters mapped to None are deleted.\ntranslate" }, { - "objectID": "examples/gallery_examples/012_fatigue_example", - "href": "examples/gallery_examples/012_fatigue_example.html#evaluate-fatigue-for-a-composite-plate", - "title": "Evaluate fatigue for a composite plate", - "section": "Evaluate fatigue for a composite plate", - "text": "This example shows how to evaluate fatigue for a flat plate.\nIt shows how you can use PyPDF Composites to select specific layers and define a custom\ncombination method. For this example, the custom combination method is stress in fibre\ndirection.\nA random load time series is created. Taking into account that the load is assumed\nproportional, rainflow counting is applied to the load time series.\nLoad ranges are then applied on the stress combination method, and damage is evaluated\nby using a dummy S-N curve.\nBe aware that the fatpack package is not developed by Ansys, so it is the responsibility\nof the user to verify that it works as expected. For more information, see the\nfatpack package,\nWhen using a Workbench project,\nuse the composite_files_from_workbench_harmonic_analysis()\nmethod to obtain the input files.\nEvaluate fatigue for a composite plate\ncomposite_files_from_workbench_harmonic_analysis()" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.translate", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.translate.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.translate", + "title": "translate > translate > translate", + "section": "translate > translate", + "text": "FailureMeasureEnum.translate(table, /)\n\nReplace each character in the string using the given translation table.\n\ntable\n\nTranslation table, which must be a mapping of Unicode ordinals to\nUnicode ordinals, strings, or None.\n\nThe table must implement lookup/indexing via __getitem__, for instance a\ndictionary or list. If this operation raises LookupError, the character is\nleft untouched. Characters mapped to None are deleted.\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/012_fatigue_example", - "href": "examples/gallery_examples/012_fatigue_example.html#set-up-analysis", - "title": "Evaluate fatigue for a composite plate > Set up analysis", - "section": "Set up analysis", - "text": "Setting up the analysis consists of loading the required modules, connecting to the\nDPF server, and retrieving the example files.\nLoad Ansys libraries and numpy, matplotlib and fatpack\nStart a DPF server and copy the example files into the current working directory.\nCreate a composite model\nSet up analysis" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.inverse_reserve_factor", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.inverse_reserve_factor.html#inverse_reserve_factor", + "title": "inverse_reserve_factor", + "section": "inverse_reserve_factor", + "text": "Critical inverse reserve factor of each ply.\nndarray[Any, dtype[float64]]\ninverse_reserve_factor\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "examples/gallery_examples/012_fatigue_example", - "href": "examples/gallery_examples/012_fatigue_example.html#read-stresses-and-define-a-specific-layer-and-a-component-of-stress-tensor", - "title": "Evaluate fatigue for a composite plate > Read stresses and define a specific layer and a component of stress tensor", - "section": "Read stresses and define a specific layer and a component of stress tensor", - "text": "Read stresses\nSelect layer P1L1__ModelingPly.2\nSelect Sigma11 as the combination method\nRead stresses and define a specific layer and a component of stress tensor" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.inverse_reserve_factor", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.inverse_reserve_factor.html#ansys.dpf.composites.sampling_point.SamplingPoint.inverse_reserve_factor", + "title": "inverse_reserve_factor > inverse_reserve_factor > inverse_reserve_factor", + "section": "inverse_reserve_factor > inverse_reserve_factor", + "text": "property SamplingPoint.inverse_reserve_factor: ndarray[Any, dtype[float64]]\n\nCritical inverse reserve factor of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "examples/gallery_examples/012_fatigue_example", - "href": "examples/gallery_examples/012_fatigue_example.html#load-time-series-and-apply-rainflow-counting", - "title": "Evaluate fatigue for a composite plate > Load time series and apply rainflow counting", - "section": "Load time series and apply rainflow counting", - "text": "A random time series is created. Load is assumed proportional, so rainflow counting\ncan be directly done on the load time series to get the load ranges.\nNo mean stress correction is applied.\nFatpack package is used for doing the rainflow counting\nLoad time series and apply rainflow counting" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_1", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_1.html#larc_constants_fracture_toughness_mode_1", + "title": "Larc_Constants_fracture_toughness_mode_1", + "section": "Larc_Constants_fracture_toughness_mode_1", + "text": "Larc_Constants_fracture_toughness_mode_1" }, { - "objectID": "examples/gallery_examples/012_fatigue_example", - "href": "examples/gallery_examples/012_fatigue_example.html#s-n-curve", - "title": "Evaluate fatigue for a composite plate > S-N curve", - "section": "S-N curve", - "text": "A dummy S-N curve is created. Note that this curve is not based on any\nexperimental data. Sc is chosen to be twice the orthotropic stress limit in the fiber direction.\nand Nc is set to 1.\nS-N curve" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_1", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_1.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Larc_Constants_fracture_toughness_mode_1", + "title": "Larc_Constants_fracture_toughness_mode_1 > Larc_Constants_fracture_toughness_mode_1 > Larc_Constants_fracture_toughness_mode_1", + "section": "Larc_Constants_fracture_toughness_mode_1 > Larc_Constants_fracture_toughness_mode_1", + "text": "MaterialProperty.Larc_Constants_fracture_toughness_mode_1: str = 'longitudinal_friction_coefficient_larc_constants'\n\n" }, { - "objectID": "examples/gallery_examples/012_fatigue_example", - "href": "examples/gallery_examples/012_fatigue_example.html#damage-evaluation", - "title": "Evaluate fatigue for a composite plate > Damage evaluation", - "section": "Damage evaluation", - "text": "Stress S11 at time 1 and layer P1L1__ModelingPly.2 are read\nfor each load range. Its damage is evaluated using the dummy S-N curve.\nPlot damage\nDamage evaluation" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmC", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmC.html#pmc", + "title": "pmC", + "section": "pmC", + "text": "pmC" }, { - "objectID": "examples/gallery_examples/012_fatigue_example", - "href": "examples/gallery_examples/012_fatigue_example.html#identify-the-element-with-the-maximum-damage", - "title": "Evaluate fatigue for a composite plate > Identify the element with the maximum damage", - "section": "Identify the element with the maximum damage", - "text": "Total running time of the script: (0 minutes 3.564 seconds)\nDownload Jupyter notebook: 012_fatigue_example.ipynb\nDownload Python source code: 012_fatigue_example.py\nDownload zipped: 012_fatigue_example.zip\nGallery generated by Sphinx-Gallery\nIdentify the element with the maximum damage\nDownload Jupyter notebook: 012_fatigue_example.ipynb\nDownload Python source code: 012_fatigue_example.py\nDownload zipped: 012_fatigue_example.zip" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmC", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FailureModeEnum.pmC.html#ansys.dpf.composites.failure_criteria.FailureModeEnum.pmC", + "title": "pmC > pmC > pmC", + "section": "pmC > pmC", + "text": "FailureModeEnum.pmC = 804\n\n" }, - { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.html#maxstresscriterion", - "title": "MaxStressCriterion", - "section": "MaxStressCriterion", - "text": "Defines the maximum stress failure criterion for orthotropic reinforced materials.\ns1 (bool, default: True) – Whether to activate the failure evaluation regarding the stress in the material 1 direction.\ns2 (bool, default: True) – Whether to activate the failure evaluation regarding the stress in the material 2 direction.\ns3 (bool, default: False) – Whether to activate the failure evaluation regarding the stress in the material 3 direction (out-of-plane).\ns12 (bool, default: True) – Whether to activate the failure evaluation regarding the in-plane shear stress s12.\ns13 (bool, default: False) – Whether to activate the failure evaluation regarding the interlaminar shear stress s13.\ns23 (bool, default: False) – Whether to activate the failure evaluation regarding the interlaminar shear stress s23.\nwf_s1 (float, default: 1.0) – Weighting factor of the failure mode s1.\nwf_s2 (float, default: 1.0) – Weighting factor of the failure mode s2.\nwf_s3 (float, default: 1.0) – Weighting factor of the failure mode s3.\nwf_s12 (float, default: 1.0) – Weighting factor of the failure mode s12.\nwf_s13 (float, default: 1.0) – Weighting factor of the failure mode s13.\nwf_s23 (float, default: 1.0) – Weighting factor of the failure mode s23.\nMaxStressCriterion.to_dict()\n\nMaxStressCriterion.to_json()\n\nMaxStressCriterion.active\nThe failure criterion is suppressed if active is False.\nMaxStressCriterion.name\nName of the failure criterion.\nMaxStressCriterion.s1\nWhether to activate the failure evaluation regarding the stress in the material 1 direction.\nMaxStressCriterion.s12\nWhether to activate the failure evaluation regarding the in-plane shear stress s12.\nMaxStressCriterion.s13\nWhether to activate the failure evaluation regarding the interlaminar shear stress s13.\nMaxStressCriterion.s2\nWhether to activate the failure evaluation regarding the stress in the material 2 direction.\nMaxStressCriterion.s23\nWhether to activate the failure evaluation regarding the interlaminar shear stress s23.\nMaxStressCriterion.s3\nWhether to activate the failure evaluation regarding the stress in the material 3 direction (out-of-plane).\nMaxStressCriterion.wf_s1\nWeighting factor of the failure mode s1.\nMaxStressCriterion.wf_s12\nWeighting factor of the failure mode s12.\nMaxStressCriterion.wf_s13\nWeighting factor of the failure mode s13.\nMaxStressCriterion.wf_s2\nWeighting factor of the failure mode s2.\nMaxStressCriterion.wf_s23\nWeighting factor of the failure mode s23.\nMaxStressCriterion.wf_s3\nWeighting factor of the failure mode s3.\nMaxStressCriterion\nbool\nTrue\nbool\nTrue\nbool\nFalse\nbool\nTrue\nbool\nFalse\nbool\nFalse\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nfloat\n1.0\nMaxStressCriterion.to_dict\nMaxStressCriterion.to_json\nMaxStressCriterion.active\nMaxStressCriterion.name\nMaxStressCriterion.s1\nMaxStressCriterion.s12\nMaxStressCriterion.s13\nMaxStressCriterion.s2\nMaxStressCriterion.s23\nMaxStressCriterion.s3\nMaxStressCriterion.wf_s1\nMaxStressCriterion.wf_s12\nMaxStressCriterion.wf_s13\nMaxStressCriterion.wf_s2\nMaxStressCriterion.wf_s23\nMaxStressCriterion.wf_s3" + { + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZc", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZc.html#strain_limits_ezc", + "title": "Strain_Limits_eZc", + "section": "Strain_Limits_eZc", + "text": "Strain_Limits_eZc" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStressCriterion.html#ansys.dpf.composites.failure_criteria.MaxStressCriterion", - "title": "MaxStressCriterion > MaxStressCriterion > MaxStressCriterion", - "section": "MaxStressCriterion > MaxStressCriterion", - "text": "class ansys.dpf.composites.failure_criteria.MaxStressCriterion(*, s1=True, s2=True, s3=False, s12=True, s13=False, s23=False, wf_s1=1.0, wf_s2=1.0, wf_s3=1.0, wf_s12=1.0, wf_s13=1.0, wf_s23=1.0)\n\nDefines the maximum stress failure criterion for orthotropic reinforced materials.\n\nParameters\n\ns1 (bool, default: True) – Whether to activate the failure evaluation regarding the stress in the material 1 direction.\n\ns2 (bool, default: True) – Whether to activate the failure evaluation regarding the stress in the material 2 direction.\n\ns3 (bool, default: False) – Whether to activate the failure evaluation regarding the stress in the material 3 direction (out-of-plane).\n\ns12 (bool, default: True) – Whether to activate the failure evaluation regarding the in-plane shear stress s12.\n\ns13 (bool, default: False) – Whether to activate the failure evaluation regarding the interlaminar shear stress s13.\n\ns23 (bool, default: False) – Whether to activate the failure evaluation regarding the interlaminar shear stress s23.\n\nwf_s1 (float, default: 1.0) – Weighting factor of the failure mode s1.\n\nwf_s2 (float, default: 1.0) – Weighting factor of the failure mode s2.\n\nwf_s3 (float, default: 1.0) – Weighting factor of the failure mode s3.\n\nwf_s12 (float, default: 1.0) – Weighting factor of the failure mode s12.\n\nwf_s13 (float, default: 1.0) – Weighting factor of the failure mode s13.\n\nwf_s23 (float, default: 1.0) – Weighting factor of the failure mode s23.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nMaxStressCriterion.to_dict()\n\n\n\nMaxStressCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nMaxStressCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nMaxStressCriterion.name\n\nName of the failure criterion.\n\nMaxStressCriterion.s1\n\nWhether to activate the failure evaluation regarding the stress in the material 1 direction.\n\nMaxStressCriterion.s12\n\nWhether to activate the failure evaluation regarding the in-plane shear stress s12.\n\nMaxStressCriterion.s13\n\nWhether to activate the failure evaluation regarding the interlaminar shear stress s13.\n\nMaxStressCriterion.s2\n\nWhether to activate the failure evaluation regarding the stress in the material 2 direction.\n\nMaxStressCriterion.s23\n\nWhether to activate the failure evaluation regarding the interlaminar shear stress s23.\n\nMaxStressCriterion.s3\n\nWhether to activate the failure evaluation regarding the stress in the material 3 direction (out-of-plane).\n\nMaxStressCriterion.wf_s1\n\nWeighting factor of the failure mode s1.\n\nMaxStressCriterion.wf_s12\n\nWeighting factor of the failure mode s12.\n\nMaxStressCriterion.wf_s13\n\nWeighting factor of the failure mode s13.\n\nMaxStressCriterion.wf_s2\n\nWeighting factor of the failure mode s2.\n\nMaxStressCriterion.wf_s23\n\nWeighting factor of the failure mode s23.\n\nMaxStressCriterion.wf_s3\n\nWeighting factor of the failure mode s3.\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZc", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZc.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eZc", + "title": "Strain_Limits_eZc > Strain_Limits_eZc > Strain_Limits_eZc", + "section": "Strain_Limits_eZc > Strain_Limits_eZc", + "text": "MaterialProperty.Strain_Limits_eZc: str = 'strain_compressive_z_direction'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.format", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.format.html#format", - "title": "format", - "section": "format", - "text": "Return a formatted version of the string, using substitutions from args and kwargs.\nThe substitutions are identified by braces (‘{’ and ‘}’).\nformat" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rjust", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rjust.html#rjust", + "title": "rjust", + "section": "rjust", + "text": "Return a right-justified string of length width.\nPadding is done using the specified fill character (default is a space).\nrjust" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.format", - "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.format.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.format", - "title": "format > format > format", - "section": "format > format", - "text": "FailureMeasureEnum.format(*args, **kwargs)\n\nReturn a formatted version of the string, using substitutions from args and kwargs.\nThe substitutions are identified by braces (‘{’ and ‘}’).\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rjust", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.rjust.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.rjust", + "title": "rjust > rjust > rjust", + "section": "rjust > rjust", + "text": "FailureMeasureEnum.rjust(width, fillchar=' ', /)\n\nReturn a right-justified string of length width.\n\nPadding is done using the specified fill character (default is a space).\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfoProvider.get_element_info", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfoProvider.get_element_info.html#get_element_info", - "title": "get_element_info", - "section": "get_element_info", - "text": "Get ElementInfo for a given element id.\nelement_id (int) – Element Id/Label\nReturns None if element type is not supported\nOptional[ElementInfo]\nget_element_info\nElementInfo\nint" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.named_selection_scope", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.named_selection_scope.html#named_selection_scope", + "title": "named_selection_scope", + "section": "named_selection_scope", + "text": "Assembly files that define the mapping of the labels.\nThis attribute is needed if multiple parts are assembled in Workbench or\nMechanical to map the local element and node labels to the global labels.\nnamed_selection_scope" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfoProvider.get_element_info", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfoProvider.get_element_info.html#ansys.dpf.composites.layup_info.ElementInfoProvider.get_element_info", - "title": "get_element_info > get_element_info > get_element_info", - "section": "get_element_info > get_element_info", - "text": "ElementInfoProvider.get_element_info(element_id)\n\nGet ElementInfo for a given element id.\n\nParameters\n\nelement_id (int) – Element Id/Label\n\nReturns\n\nReturns None if element type is not supported\n\nReturn type\n\nOptional[ElementInfo]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.named_selection_scope", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.ResultDefinitionScope.named_selection_scope.html#ansys.dpf.composites.result_definition.ResultDefinitionScope.named_selection_scope", + "title": "named_selection_scope > named_selection_scope > named_selection_scope", + "section": "named_selection_scope > named_selection_scope", + "text": "ResultDefinitionScope.named_selection_scope: Sequence[str]\n\nAssembly files that define the mapping of the labels.\n\nThis attribute is needed if multiple parts are assembled in Workbench or\nMechanical to map the local element and node labels to the global labels.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR31", - "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR31.html#tensor31", - "title": "TENSOR31", - "section": "TENSOR31", - "text": "TENSOR31" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.offsets", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.offsets.html#offsets", + "title": "offsets", + "section": "offsets", + "text": "Z coordinates for each interface and ply.\nndarray[Any, dtype[float64]]\noffsets\nndarray\nAny\ndtype\nfloat64" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR31", - "href": "api/_autosummary/ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR31.html#ansys.dpf.composites.constants.Sym3x3TensorComponent.TENSOR31", - "title": "TENSOR31 > TENSOR31 > TENSOR31", - "section": "TENSOR31 > TENSOR31", - "text": "Sym3x3TensorComponent.TENSOR31 = 5\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.offsets", + "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.offsets.html#ansys.dpf.composites.sampling_point.SamplingPoint.offsets", + "title": "offsets > offsets > offsets", + "section": "offsets > offsets", + "text": "property SamplingPoint.offsets: ndarray[Any, dtype[float64]]\n\nZ coordinates for each interface and ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.id", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.id.html#id", - "title": "id", - "section": "id", - "text": "id" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxz", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxz.html#esxz", + "title": "eSxz", + "section": "eSxz", + "text": "Global strain limit in material direction 13.\nfloat\neSxz\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.id", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.ElementInfo.id.html#ansys.dpf.composites.layup_info.ElementInfo.id", - "title": "id > id > id", - "section": "id > id", - "text": "ElementInfo.id: int\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxz", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxz.html#ansys.dpf.composites.failure_criteria.MaxStrainCriterion.eSxz", + "title": "eSxz > eSxz > eSxz", + "section": "eSxz > eSxz", + "text": "property MaxStrainCriterion.eSxz: float\n\nGlobal strain limit in material direction 13.\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R11", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R11.html#hill_yield_criterion_r11", - "title": "Hill_Yield_Criterion_R11", - "section": "Hill_Yield_Criterion_R11", - "text": "Hill_Yield_Criterion_R11" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_metadata", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_metadata.html#material_metadata", + "title": "material_metadata", + "section": "material_metadata", + "text": "DPF material ID to metadata map of the materials.\nThis data can be used to filter analysis plies\nor element layers by ply type, material name etc.\nNote: ply type is only available in DPF server version 9.0 (2025 R1 pre0) and later.\ndict[int, MaterialMetadata]\nmaterial_metadata\ndict\nint\nMaterialMetadata" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R11", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R11.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Hill_Yield_Criterion_R11", - "title": "Hill_Yield_Criterion_R11 > Hill_Yield_Criterion_R11 > Hill_Yield_Criterion_R11", - "section": "Hill_Yield_Criterion_R11 > Hill_Yield_Criterion_R11", - "text": "MaterialProperty.Hill_Yield_Criterion_R11: str = 'yield_stress_ratio_x_hill_criterion'\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_metadata", + "href": "api/_autosummary/ansys.dpf.composites.composite_model.CompositeModel.material_metadata.html#ansys.dpf.composites.composite_model.CompositeModel.material_metadata", + "title": "material_metadata > material_metadata > material_metadata", + "section": "material_metadata > material_metadata", + "text": "property CompositeModel.material_metadata: dict[int, MaterialMetadata]\n\nDPF material ID to metadata map of the materials.\n\nThis data can be used to filter analysis plies\nor element layers by ply type, material name etc.\n\nNote: ply type is only available in DPF server version 9.0 (2025 R1 pre0) and later.\n\nReturn type\n\ndict[int, MaterialMetadata]\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_G12", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_G12.html#polar_properties_g12", - "title": "polar_properties_G12", - "section": "polar_properties_G12", - "text": "Polar property G12 of the laminate.\nndarray[Any, dtype[float64]]\npolar_properties_G12\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isdigit", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isdigit.html#isdigit", + "title": "isdigit", + "section": "isdigit", + "text": "Return True if the string is a digit string, False otherwise.\nA string is a digit string if all characters in the string are digits and there\nis at least one character in the string.\nisdigit" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_G12", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_G12.html#ansys.dpf.composites.sampling_point.SamplingPoint.polar_properties_G12", - "title": "polar_properties_G12 > polar_properties_G12 > polar_properties_G12", - "section": "polar_properties_G12 > polar_properties_G12", - "text": "property SamplingPoint.polar_properties_G12: ndarray[Any, dtype[float64]]\n\nPolar property G12 of the laminate.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isdigit", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.isdigit.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.isdigit", + "title": "isdigit > isdigit > isdigit", + "section": "isdigit > isdigit", + "text": "FailureMeasureEnum.isdigit(/)\n\nReturn True if the string is a digit string, False otherwise.\n\nA string is a digit string if all characters in the string are digits and there\nis at least one character in the string.\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.html#analysisplyinfoprovider", - "title": "AnalysisPlyInfoProvider", - "section": "AnalysisPlyInfoProvider", - "text": "AnalysisPlyInfoProvider. Can be used to compute the layer indices of a given analysis ply.\nmesh (MeshedRegion) – DPF MeshedRegion with lay-up information.\nname (str) – Analysis Ply Name\nAnalysisPlyInfoProvider.get_layer_index_by_element_id(...)\nGet the layer index for the analysis ply in a given element.\nAnalysisPlyInfoProvider.ply_element_ids()\nReturn list of element labels of the analysis ply.\nAnalysisPlyInfoProvider\nMeshedRegion\nstr\nAnalysisPlyInfoProvider.get_layer_index_by_element_id\nAnalysisPlyInfoProvider.ply_element_ids" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxy", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxy.html#strain_limits_esxy", + "title": "Strain_Limits_eSxy", + "section": "Strain_Limits_eSxy", + "text": "Strain_Limits_eSxy" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider", - "href": "api/_autosummary/ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider.html#ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider", - "title": "AnalysisPlyInfoProvider > AnalysisPlyInfoProvider > AnalysisPlyInfoProvider", - "section": "AnalysisPlyInfoProvider > AnalysisPlyInfoProvider", - "text": "class ansys.dpf.composites.layup_info.AnalysisPlyInfoProvider(mesh, name)\n\nAnalysisPlyInfoProvider. Can be used to compute the layer indices of a given analysis ply.\n\nParameters\n\nmesh (MeshedRegion) – DPF MeshedRegion with lay-up information.\n\nname (str) – Analysis Ply Name\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nAnalysisPlyInfoProvider.get_layer_index_by_element_id(...)\n\nGet the layer index for the analysis ply in a given element.\n\nAnalysisPlyInfoProvider.ply_element_ids()\n\nReturn list of element labels of the analysis ply.\n\n" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxy", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxy.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Strain_Limits_eSxy", + "title": "Strain_Limits_eSxy > Strain_Limits_eSxy > Strain_Limits_eSxy", + "section": "Strain_Limits_eSxy > Strain_Limits_eSxy", + "text": "MaterialProperty.Strain_Limits_eSxy: str = 'strain_shear_xy'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.active.html#active", - "title": "active", - "section": "active", - "text": "The failure criterion is suppressed if active is False.\nbool\nactive\nbool" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.html#facesheetwrinklingcriterion", + "title": "FaceSheetWrinklingCriterion", + "section": "FaceSheetWrinklingCriterion", + "text": "Defines the face sheet wrinkling criterion for sandwiches (laminate with cores).\nhomogeneous_core_coeff (float, default: 0.5) – Wrinkling coefficient (reduction factor) for homogeneous core materials.\nhoneycomb_core_coeff (float, default: 0.33) – Wrinkling coefficient (reduction factor) for honeycombs. The default is 0.33.\nwf (float, default: 1.0) – Weighting factor of the failure mode (wb or wt). The default is 0.5.\nFaceSheetWrinklingCriterion.to_dict()\n\nFaceSheetWrinklingCriterion.to_json()\n\nFaceSheetWrinklingCriterion.active\nThe failure criterion is suppressed if active is False.\nFaceSheetWrinklingCriterion.homogeneous_core_coeff\nWrinkling coefficient (reduction factor) for homogeneous core materials.\nFaceSheetWrinklingCriterion.honeycomb_core_coeff\nWrinkling coefficient (reduction factor) for honeycombs.\nFaceSheetWrinklingCriterion.name\nName of the failure criterion.\nFaceSheetWrinklingCriterion.wf\nWeighting factor of the failure mode (wb or wt).\nFaceSheetWrinklingCriterion\nfloat\n0.5\nfloat\n0.33\n0.33\nfloat\n1.0\n0.5\nFaceSheetWrinklingCriterion.to_dict\nFaceSheetWrinklingCriterion.to_json\nFaceSheetWrinklingCriterion.active\nFaceSheetWrinklingCriterion.homogeneous_core_coeff\nFaceSheetWrinklingCriterion.honeycomb_core_coeff\nFaceSheetWrinklingCriterion.name\nFaceSheetWrinklingCriterion.wf" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.active", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.active.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.active", - "title": "active > active > active", - "section": "active > active", - "text": "property CuntzeCriterion.active: bool\n\nThe failure criterion is suppressed if active is False.\n\nReturn type\n\nbool\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion", + "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion.html#ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion", + "title": "FaceSheetWrinklingCriterion > FaceSheetWrinklingCriterion > FaceSheetWrinklingCriterion", + "section": "FaceSheetWrinklingCriterion > FaceSheetWrinklingCriterion", + "text": "class ansys.dpf.composites.failure_criteria.FaceSheetWrinklingCriterion(*, homogeneous_core_coeff=0.5, honeycomb_core_coeff=0.33, wf=1.0)\n\nDefines the face sheet wrinkling criterion for sandwiches (laminate with cores).\n\nParameters\n\nhomogeneous_core_coeff (float, default: 0.5) – Wrinkling coefficient (reduction factor) for homogeneous core materials.\n\nhoneycomb_core_coeff (float, default: 0.33) – Wrinkling coefficient (reduction factor) for honeycombs. The default is 0.33.\n\nwf (float, default: 1.0) – Weighting factor of the failure mode (wb or wt). The default is 0.5.\n\n!! processed by numpydoc !!\n\nMethods\n\n\n\n\n\n\n\nFaceSheetWrinklingCriterion.to_dict()\n\n\n\nFaceSheetWrinklingCriterion.to_json()\n\n\n\n\n\nAttributes\n\n\n\n\n\n\n\nFaceSheetWrinklingCriterion.active\n\nThe failure criterion is suppressed if active is False.\n\nFaceSheetWrinklingCriterion.homogeneous_core_coeff\n\nWrinkling coefficient (reduction factor) for homogeneous core materials.\n\nFaceSheetWrinklingCriterion.honeycomb_core_coeff\n\nWrinkling coefficient (reduction factor) for honeycombs.\n\nFaceSheetWrinklingCriterion.name\n\nName of the failure criterion.\n\nFaceSheetWrinklingCriterion.wf\n\nWeighting factor of the failure mode (wb or wt).\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cma", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cma.html#wf_cma", - "title": "wf_cma", - "section": "wf_cma", - "text": "Weighting factor of matrix failure due to tension (cma).\nfloat\nwf_cma\nfloat" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.rst", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.rst.html#rst", + "title": "rst", + "section": "rst", + "text": "rst" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cma", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cma.html#ansys.dpf.composites.failure_criteria.CuntzeCriterion.wf_cma", - "title": "wf_cma > wf_cma > wf_cma", - "section": "wf_cma > wf_cma", - "text": "property CuntzeCriterion.wf_cma: float\n\nWeighting factor of matrix failure due to tension (cma).\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.rst", + "href": "api/_autosummary/ansys.dpf.composites.data_sources.CompositeDataSources.rst.html#ansys.dpf.composites.data_sources.CompositeDataSources.rst", + "title": "rst > rst > rst", + "section": "rst > rst", + "text": "CompositeDataSources.rst: DataSources\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.analysis_plies", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.analysis_plies.html#analysis_plies", - "title": "analysis_plies", - "section": "analysis_plies", - "text": "List of analysis plies from the bottom to the top.\nThis attribute returns a list of ply data, such as angle, thickness and material name,\nas a dictionary.\nSequence[Any]\nanalysis_plies\nSequence\nAny" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Syz", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Syz.html#stress_limits_syz", + "title": "Stress_Limits_Syz", + "section": "Stress_Limits_Syz", + "text": "Stress_Limits_Syz" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.analysis_plies", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.analysis_plies.html#ansys.dpf.composites.sampling_point.SamplingPoint.analysis_plies", - "title": "analysis_plies > analysis_plies > analysis_plies", - "section": "analysis_plies > analysis_plies", - "text": "property SamplingPoint.analysis_plies: Sequence[Any]\n\nList of analysis plies from the bottom to the top.\n\nThis attribute returns a list of ply data, such as angle, thickness and material name,\nas a dictionary.\n\nReturn type\n\nSequence[Any]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Syz", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Syz.html#ansys.dpf.composites.layup_info.material_properties.MaterialProperty.Stress_Limits_Syz", + "title": "Stress_Limits_Syz > Stress_Limits_Syz > Stress_Limits_Syz", + "section": "Stress_Limits_Syz > Stress_Limits_Syz", + "text": "MaterialProperty.Stress_Limits_Syz: str = 'stress_shear_yz'\n\n" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.inverse_reserve_factor", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.inverse_reserve_factor.html#inverse_reserve_factor", - "title": "inverse_reserve_factor", - "section": "inverse_reserve_factor", - "text": "Critical inverse reserve factor of each ply.\nndarray[Any, dtype[float64]]\ninverse_reserve_factor\nndarray\nAny\ndtype\nfloat64" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_constant_property", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_constant_property.html#get_constant_property", + "title": "get_constant_property", + "section": "get_constant_property", + "text": "Get a constant material property.\nOnly constant properties are supported. Variable properties are evaluated at their\ndefault values.\nmaterial_property (MaterialProperty) – Material property.\ndpf_material_id (int64) – DPF material ID.\nmaterials_provider (Operator) – DPF Materials provider operator. This value is available from the\nCompositeModel.material_operators attribute.\nunit_system (Union[UnitSystem, Operator])\nfloat\nget_constant_property\nMaterialProperty\nint64\nOperator\nCompositeModel.material_operators\nUnion\nUnitSystem\nOperator\nfloat" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.inverse_reserve_factor", - "href": "api/_autosummary/ansys.dpf.composites.sampling_point.SamplingPoint.inverse_reserve_factor.html#ansys.dpf.composites.sampling_point.SamplingPoint.inverse_reserve_factor", - "title": "inverse_reserve_factor > inverse_reserve_factor > inverse_reserve_factor", - "section": "inverse_reserve_factor > inverse_reserve_factor", - "text": "property SamplingPoint.inverse_reserve_factor: ndarray[Any, dtype[float64]]\n\nCritical inverse reserve factor of each ply.\n\nReturn type\n\nndarray[Any, dtype[float64]]\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_constant_property", + "href": "api/_autosummary/ansys.dpf.composites.layup_info.material_properties.get_constant_property.html#ansys.dpf.composites.layup_info.material_properties.get_constant_property", + "title": "get_constant_property > get_constant_property > get_constant_property", + "section": "get_constant_property > get_constant_property", + "text": "ansys.dpf.composites.layup_info.material_properties.get_constant_property(material_property, dpf_material_id, materials_provider, unit_system)\n\nGet a constant material property.\n\nOnly constant properties are supported. Variable properties are evaluated at their\ndefault values.\n\nParameters\n\nmaterial_property (MaterialProperty) – Material property.\n\ndpf_material_id (int64) – DPF material ID.\n\nmaterials_provider (Operator) – DPF Materials provider operator. This value is available from the\nCompositeModel.material_operators attribute.\n\nunit_system (Union[UnitSystem, Operator])\n\nReturn type\n\nfloat\n\n!! processed by numpydoc !!" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.name.html#name", - "title": "name", - "section": "name", - "text": "Name of the failure criterion. Read only.\nstr\nname\nstr" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.maketrans", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.maketrans.html#maketrans", + "title": "maketrans", + "section": "maketrans", + "text": "Return a translation table usable for str.translate().\nIf there is only one argument, it must be a dictionary mapping Unicode\nordinals (integers) or characters to Unicode ordinals, strings or None.\nCharacter keys will be then converted to ordinals.\nIf there are two arguments, they must be strings of equal length, and\nin the resulting dictionary, each character in x will be mapped to the\ncharacter at the same position in y. If there is a third argument, it\nmust be a string, whose characters will be mapped to None in the result.\nmaketrans" }, { - "objectID": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.name", - "href": "api/_autosummary/ansys.dpf.composites.failure_criteria.LaRCCriterion.name.html#ansys.dpf.composites.failure_criteria.LaRCCriterion.name", - "title": "name > name > name", - "section": "name > name", - "text": "property LaRCCriterion.name: str\n\nName of the failure criterion. Read only.\n\nReturn type\n\nstr\n\n!! processed by numpydoc !!" + "objectID": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.maketrans", + "href": "api/_autosummary/ansys.dpf.composites.result_definition.FailureMeasureEnum.maketrans.html#ansys.dpf.composites.result_definition.FailureMeasureEnum.maketrans", + "title": "maketrans > maketrans > maketrans", + "section": "maketrans > maketrans", + "text": "static FailureMeasureEnum.maketrans(x, y=, z=, /)\n\nReturn a translation table usable for str.translate().\n\nIf there is only one argument, it must be a dictionary mapping Unicode\nordinals (integers) or characters to Unicode ordinals, strings or None.\nCharacter keys will be then converted to ordinals.\nIf there are two arguments, they must be strings of equal length, and\nin the resulting dictionary, each character in x will be mapped to the\ncharacter at the same position in y. If there is a third argument, it\nmust be a string, whose characters will be mapped to None in the result.\n\n!! processed by numpydoc !!" } ] \ No newline at end of file diff --git a/version/dev/examples/gallery_examples/001_failure_operator_example.html b/version/dev/examples/gallery_examples/001_failure_operator_example.html index a4a6b8400..70a2bab18 100644 --- a/version/dev/examples/gallery_examples/001_failure_operator_example.html +++ b/version/dev/examples/gallery_examples/001_failure_operator_example.html @@ -637,7 +637,7 @@

Set up model and evaluate failuresTotal running time of the script: (0 minutes 11.642 seconds)

+

Total running time of the script: (0 minutes 12.061 seconds)

 -Stresses, Failures

Total running time of the script: (0 minutes 4.837 seconds)

+Stresses, Failures

Total running time of the script: (0 minutes 4.888 seconds)