Update spelling of PyDPF - Composites (#755)

See ansys/pydpf-composites#554

Author: greschd

doc/styles/config/vocabularies/ANSYS/accept.txt

@@ -11,3 +11,4 @@ API
 untrusted
 DPF
 2025R1
+PyDPF - Composites

examples/pymechanical_with_shim/embedded_workflow.py

@@ -40,10 +40,10 @@
     * Export composite definitions and material data from PyACP
     * Import lay-up and material in PyMechanical (imported plies)
     * Define boundary condition in PyMechanical
-    * Postprocess results with PyDPF Composites (using the materials file and the RST
+    * Postprocess results with PyDPF - Composites (using the materials file and the RST
       file generated by PyMechanical)
 
- The workflow currently uses a Docker container for PyACP and PyDPF Composites. For PyMechanical,
+ The workflow currently uses a Docker container for PyACP and PyDPF - Composites. For PyMechanical,
  the local installer is used. There is no known issue preventing you from using the PyMechanical
  container. This was just not yet implemented due to time restrictions.
 """

examples/use_cases/01-optimizing-ply-angles.py

@@ -233,7 +233,7 @@ def solve_cdb(*, mapdl, cdb_file, workdir):
 rst_file = solve_cdb(mapdl=mapdl, cdb_file=cdb_file_path, workdir=workdir)
 
 # %%
-# The ``get_max_irf()`` function uses PyDPF Composites to calculate the maximum
+# The ``get_max_irf()`` function uses PyDPF - Composites to calculate the maximum
 # inverse reserve factor (IRF) for a given RST, composite definitions,
 # or materials file.
 #

examples/workflows/01-pymapdl-workflow.py

@@ -27,7 +27,7 @@
 ================
 
 This example shows how to define a composite lay-up with PyACP, solve the resulting model with PyMAPDL, and
-run a failure analysis with PyDPF Composites.
+run a failure analysis with PyDPF - Composites.
 """
 
 # %%
@@ -38,8 +38,8 @@
 # boundary conditions. For more information on creating input files, see :ref:`input_file_for_pyacp`.
 # Then, you import the DAT file into PyACP to define the composite lay-up. Finally, you export the
 # resulting model from PyACP to PyMAPDL. Once the results are available, the RST file is loaded in
-# PyDPF Composites for analysis. The additional input files (``material.xml`` and
-# ``ACPCompositeDefinitions.h5``) can also be stored with PyACP and passed to PyDPF Composites.
+# PyDPF - Composites for analysis. The additional input files (``material.xml`` and
+# ``ACPCompositeDefinitions.h5``) can also be stored with PyACP and passed to PyDPF - Composites.
 
 # %%
 # Import modules
@@ -216,11 +216,11 @@
 mapdl.download(rstfile_name, str(WORKING_DIR))
 
 # %%
-# Postprocessing with PyDPF Composites
-# ------------------------------------
+# Postprocessing with PyDPF - Composites
+# --------------------------------------
 #
 # To postprocess the results, you must configure the imports, connect to the
-# PyDPF Composites server, and load its plugin.
+# PyDPF - Composites server, and load its plugin.
 
 from ansys.dpf.composites.composite_model import CompositeModel
 from ansys.dpf.composites.constants import FailureOutput

examples/workflows/02-advanced-pymapdl-workflow.py

@@ -27,13 +27,13 @@
 =========================
 
 This example shows how to define a composite lay-up with PyACP, solve the resulting
-model with PyMAPDL, and run a failure analysis with PyDPF Composites.
+model with PyMAPDL, and run a failure analysis with PyDPF - Composites.
 
 Begin with an MAPDL CDB file that contains the mesh, material data, and
 boundary conditions. Import the file to PyACP to define the lay-up, and then export the
 resulting model to PyMAPDL. Once the results are available, the RST file is loaded in
-PyDPF Composites for postprocessing. The additional input files (``material.xml``
-and ``ACPCompositeDefinitions.h5``) can also be stored with PyACP and passed to PyDPF Composites.
+PyDPF - Composites for postprocessing. The additional input files (``material.xml``
+and ``ACPCompositeDefinitions.h5``) can also be stored with PyACP and passed to PyDPF - Composites.
 
 """
 
@@ -292,7 +292,7 @@ def add_ply(mg, name, ply_material, angle, oss):
 # %%
 # Save the model as a CDB file for solving with PyMAPDL.
 model.export_analysis_model(working_dir_path / cdb_filename_out)
-# Export the shell lay-up and material file for PyDPF Composites.
+# Export the shell lay-up and material file for PyDPF - Composites.
 model.export_shell_composite_definitions(working_dir_path / composite_definition_h5_filename)
 model.export_materials(working_dir_path / matml_filename)
 
@@ -329,11 +329,11 @@ def add_ply(mg, name, ply_material, angle, oss):
 mapdl.download(rstfile_name, working_dir_path)
 
 # %%
-# Postprocessing with PyDPF Composites
-# ------------------------------------
+# Postprocessing with PyDPF - Composites
+# --------------------------------------
 #
 # To postprocess the results, you must configure the imports, connect to the
-# PyDPF Composites server, and load its plugin.
+# PyDPF - Composites server, and load its plugin.
 
 from ansys.dpf.composites.composite_model import CompositeModel
 from ansys.dpf.composites.constants import FailureOutput

examples/workflows/03-pymechanical-shell-workflow.py

@@ -37,7 +37,7 @@
 - Plies and materials are exported from ACP, and imported into Mechanical.
 - Boundary conditions are set in Mechanical.
 - The model is solved.
-- The results are post-processed in PyDPF Composites.
+- The results are post-processed in PyDPF - Composites.
 
 .. warning::
 
@@ -60,7 +60,7 @@
 import textwrap
 
 # %%
-# Import PyACP, PyMechanical, and PyDPF Composites.
+# Import PyACP, PyMechanical, and PyDPF - Composites.
 
 # isort: off
 import ansys.acp.core as pyacp
@@ -278,7 +278,7 @@
 # Postprocess results
 # -------------------
 #
-# Evaluate the failure criteria using the PyDPF Composites.
+# Evaluate the failure criteria using the PyDPF - Composites.
 
 
 max_strain = pydpf_composites.failure_criteria.MaxStrainCriterion()

examples/workflows/04-pymechanical-solid-workflow.py

@@ -39,7 +39,7 @@
 - Materials and plies are imported.
 - Boundary conditions are set.
 - The model is solved.
-- The results are post-processed in PyDPF Composites.
+- The results are post-processed in PyDPF - Composites.
 
 .. warning::
 
@@ -62,7 +62,7 @@
 import textwrap
 
 # %%
-# Import PyACP, PyMechanical, and PyDPF Composites.
+# Import PyACP, PyMechanical, and PyDPF - Composites.
 
 # isort: off
 
@@ -335,7 +335,7 @@
 # Postprocess results
 # -------------------
 #
-# Evaluate the failure criteria using the PyDPF Composites.
+# Evaluate the failure criteria using the PyDPF - Composites.
 
 max_strain = pydpf_composites.failure_criteria.MaxStrainCriterion()
 cfc = pydpf_composites.failure_criteria.CombinedFailureCriterion(

examples/workflows/05-pymechanical-to-cdb-workflow.py

@@ -30,7 +30,7 @@
 
 This example shows how to set up a workflow that uses PyMechanical to mesh the
 geometry and define the load case, PyACP to define a layup, PyMAPDL to solve the
-model, and PyDPF Composites to post-process the results.
+model, and PyDPF - Composites to post-process the results.
 
 This workflow does *not* suffer from the limitations of the PyACP to
 PyMechanical integration.
@@ -52,7 +52,7 @@
 import textwrap
 
 # %%
-# Import PyACP, PyMechanical, and PyDPF Composites.
+# Import PyACP, PyMechanical, and PyDPF - Composites.
 
 # isort: off
 import ansys.acp.core as pyacp
@@ -272,8 +272,8 @@
 mapdl.download(rstfile_name, working_dir_path)
 
 # %%
-# Postprocessing with PyDPF Composites
-# ------------------------------------
+# Postprocessing with PyDPF - Composites
+# --------------------------------------
 #
 # Specify the combined failure criterion.
 max_strain = pydpf_composites.failure_criteria.MaxStrainCriterion()

examples/workflows/06-cdb-to-pymechanical-workflow.py

@@ -30,7 +30,7 @@
 
 This example shows how to define a composite lay-up in PyACP based on a mesh
 from a CDB file, import the model into PyMechanical for defining the load and
-boundary conditions, and run a failure analysis with PyDPF Composites.
+boundary conditions, and run a failure analysis with PyDPF - Composites.
 
 .. warning::
 
@@ -54,7 +54,7 @@
 import textwrap
 
 # %%
-# Import PyACP, PyMechanical, and PyDPF Composites.
+# Import PyACP, PyMechanical, and PyDPF - Composites.
 
 # isort: off
 import ansys.acp.core as pyacp
@@ -281,7 +281,7 @@
 # Postprocess results
 # -------------------
 #
-# Evaluate the failure criteria using the PyDPF Composites.
+# Evaluate the failure criteria using the PyDPF - Composites.
 
 
 max_strain = pydpf_composites.failure_criteria.MaxStrainCriterion()

src/ansys/acp/core/dpf_integration_helpers.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-"""Helper functions for exchanging data between PyACP and PyDPF or PyDPF Composites."""
+"""Helper functions for exchanging data between PyACP and PyDPF or PyDPF - Composites."""
 
 import typing