Add submodule for material property sets

ansys · Feb 7, 2024 · 9a564a1 · 9a564a1
1 parent 1c61043
commit 9a564a1
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 153 deletions.
diff --git a/doc/source/api/material_property_sets.rst b/doc/source/api/material_property_sets.rst
@@ -1,8 +1,6 @@
 Material property sets
 ----------------------
 
-.. TODO: move these to a public module
-
 .. currentmodule:: ansys.acp.core
 
 .. autosummary::

diff --git a/examples/001_basic_flat_plate.py b/examples/001_basic_flat_plate.py
@@ -26,13 +26,12 @@
 # Import pyACP dependencies
 from ansys.acp.core import (
     ACPWorkflow,
-    ConstantEngineeringConstants,
-    ConstantStrainLimits,
     PlyType,
     example_helpers,
     get_composite_post_processing_files,
     get_dpf_unit_system,
     launch_acp,
+    material_property_sets,
     print_model,
 )
 
@@ -76,12 +75,12 @@
 # %%
 # Create an orthotropic material and fabric including strain limits, which are later
 # used to post-process the simulation.
-engineering_constants = ConstantEngineeringConstants(
+engineering_constants = material_property_sets.ConstantEngineeringConstants(
     E1=5e10, E2=1e10, E3=1e10, nu12=0.28, nu13=0.28, nu23=0.3, G12=5e9, G23=4e9, G31=4e9
 )
 
 strain_limit = 0.01
-strain_limits = ConstantStrainLimits(
+strain_limits = material_property_sets.ConstantStrainLimits(
     eXc=-strain_limit,
     eYc=-strain_limit,
     eZc=-strain_limit,

diff --git a/src/ansys/acp/core/__init__.py b/src/ansys/acp/core/__init__.py
@@ -5,7 +5,7 @@
 
 import importlib.metadata
 
-from . import example_helpers
+from . import example_helpers, material_property_sets
 from ._model_printer import get_model_tree, print_model
 from ._server import ACP, DirectLaunchConfig, DockerComposeLaunchConfig, LaunchMode, launch_acp
 from ._tree_objects import (
@@ -18,16 +18,6 @@
     BooleanSelectionRuleNodalData,
     CADComponent,
     CADGeometry,
-    ConstantDensity,
-    ConstantEngineeringConstants,
-    ConstantFabricFiberAngle,
-    ConstantLaRCConstants,
-    ConstantPuckConstants,
-    ConstantStrainLimits,
-    ConstantStressLimits,
-    ConstantTsaiWuConstants,
-    ConstantWovenCharacterization,
-    ConstantWovenStressLimits,
     CutoffMaterialType,
     CutoffRuleType,
     CutoffSelectionRule,
@@ -49,13 +39,11 @@
     Fabric,
     FabricWithAngle,
     FeFormat,
-    FieldVariable,
     GeometricalRuleType,
     GeometricalSelectionRule,
     GeometricalSelectionRuleElementalData,
     GeometricalSelectionRuleNodalData,
     IgnorableEntity,
-    InterpolationOptions,
     Lamina,
     LinkedSelectionRule,
     LookUpTable1D,
@@ -84,7 +72,6 @@
     ProductionPly,
     ProductionPlyElementalData,
     ProductionPlyNodalData,
-    PuckMaterialType,
     Rosette,
     RosetteSelectionMethod,
     ScalarData,
@@ -105,19 +92,9 @@
     TubeSelectionRuleElementalData,
     TubeSelectionRuleNodalData,
     UnitSystemType,
-    VariableDensity,
-    VariableEngineeringConstants,
-    VariableFabricFiberAngle,
-    VariableLaRCConstants,
     VariableOffsetSelectionRule,
     VariableOffsetSelectionRuleElementalData,
     VariableOffsetSelectionRuleNodalData,
-    VariablePuckConstants,
-    VariableStrainLimits,
-    VariableStressLimits,
-    VariableTsaiWuConstants,
-    VariableWovenCharacterization,
-    VariableWovenStressLimits,
     VectorData,
     VirtualGeometry,
     VirtualGeometryDimension,
@@ -140,16 +117,6 @@
     "BooleanSelectionRuleNodalData",
     "CADComponent",
     "CADGeometry",
-    "ConstantDensity",
-    "ConstantEngineeringConstants",
-    "ConstantFabricFiberAngle",
-    "ConstantLaRCConstants",
-    "ConstantPuckConstants",
-    "ConstantStrainLimits",
-    "ConstantStressLimits",
-    "ConstantTsaiWuConstants",
-    "ConstantWovenCharacterization",
-    "ConstantWovenStressLimits",
     "CutoffMaterialType",
     "CutoffRuleType",
     "CutoffSelectionRule",
@@ -174,7 +141,6 @@
     "Fabric",
     "FabricWithAngle",
     "FeFormat",
-    "FieldVariable",
     "GeometricalRuleType",
     "GeometricalSelectionRule",
     "GeometricalSelectionRuleElementalData",
@@ -183,7 +149,6 @@
     "get_dpf_unit_system",
     "get_model_tree",
     "IgnorableEntity",
-    "InterpolationOptions",
     "Lamina",
     "launch_acp",
     "LaunchMode",
@@ -195,6 +160,7 @@
     "LookUpTable3DInterpolationAlgorithm",
     "LookUpTableColumnValueType",
     "Material",
+    "material_property_sets",
     "Model",
     "ModelElementalData",
     "ModelingGroup",
@@ -215,7 +181,6 @@
     "ProductionPly",
     "ProductionPlyElementalData",
     "ProductionPlyNodalData",
-    "PuckMaterialType",
     "Rosette",
     "RosetteSelectionMethod",
     "ScalarData",
@@ -236,19 +201,9 @@
     "TubeSelectionRuleElementalData",
     "TubeSelectionRuleNodalData",
     "UnitSystemType",
-    "VariableDensity",
-    "VariableEngineeringConstants",
-    "VariableFabricFiberAngle",
-    "VariableLaRCConstants",
     "VariableOffsetSelectionRule",
     "VariableOffsetSelectionRuleElementalData",
     "VariableOffsetSelectionRuleNodalData",
-    "VariablePuckConstants",
-    "VariableStrainLimits",
-    "VariableStressLimits",
-    "VariableTsaiWuConstants",
-    "VariableWovenCharacterization",
-    "VariableWovenStressLimits",
     "VectorData",
     "VirtualGeometry",
     "VirtualGeometryDimension",

diff --git a/src/ansys/acp/core/_tree_objects/__init__.py b/src/ansys/acp/core/_tree_objects/__init__.py
@@ -55,32 +55,7 @@
 from .lookup_table_1d_column import LookUpTable1DColumn
 from .lookup_table_3d import LookUpTable3D
 from .lookup_table_3d_column import LookUpTable3DColumn
-from .material import (
-    ConstantDensity,
-    ConstantEngineeringConstants,
-    ConstantFabricFiberAngle,
-    ConstantLaRCConstants,
-    ConstantPuckConstants,
-    ConstantStrainLimits,
-    ConstantStressLimits,
-    ConstantTsaiWuConstants,
-    ConstantWovenCharacterization,
-    ConstantWovenStressLimits,
-    FieldVariable,
-    InterpolationOptions,
-    Material,
-    PuckMaterialType,
-    VariableDensity,
-    VariableEngineeringConstants,
-    VariableFabricFiberAngle,
-    VariableLaRCConstants,
-    VariablePuckConstants,
-    VariableStrainLimits,
-    VariableStressLimits,
-    VariableTsaiWuConstants,
-    VariableWovenCharacterization,
-    VariableWovenStressLimits,
-)
+from .material import Material
 from .model import FeFormat, IgnorableEntity, Model, ModelElementalData, ModelNodalData
 from .modeling_group import ModelingGroup
 from .modeling_ply import ModelingPly, ModelingPlyElementalData, ModelingPlyNodalData, TaperEdge
@@ -126,16 +101,6 @@
     "BooleanSelectionRuleNodalData",
     "CADComponent",
     "CADGeometry",
-    "ConstantDensity",
-    "ConstantEngineeringConstants",
-    "ConstantFabricFiberAngle",
-    "ConstantLaRCConstants",
-    "ConstantPuckConstants",
-    "ConstantStrainLimits",
-    "ConstantStressLimits",
-    "ConstantTsaiWuConstants",
-    "ConstantWovenCharacterization",
-    "ConstantWovenStressLimits",
     "CutoffMaterialType",
     "CutoffRuleType",
     "CutoffSelectionRule",
@@ -213,19 +178,9 @@
     "TubeSelectionRuleElementalData",
     "TubeSelectionRuleNodalData",
     "UnitSystemType",
-    "VariableDensity",
-    "VariableEngineeringConstants",
-    "VariableFabricFiberAngle",
-    "VariableLaRCConstants",
     "VariableOffsetSelectionRule",
     "VariableOffsetSelectionRuleElementalData",
     "VariableOffsetSelectionRuleNodalData",
-    "VariablePuckConstants",
-    "VariableStrainLimits",
-    "VariableStressLimits",
-    "VariableTsaiWuConstants",
-    "VariableWovenCharacterization",
-    "VariableWovenStressLimits",
     "VectorData",
     "VirtualGeometry",
     "VirtualGeometryDimension",

diff --git a/src/ansys/acp/core/_tree_objects/material/__init__.py b/src/ansys/acp/core/_tree_objects/material/__init__.py
@@ -1,54 +1,3 @@
 from .material import Material
-from .property_sets import (
-    ConstantDensity,
-    ConstantEngineeringConstants,
-    ConstantFabricFiberAngle,
-    ConstantLaRCConstants,
-    ConstantPuckConstants,
-    ConstantStrainLimits,
-    ConstantStressLimits,
-    ConstantTsaiWuConstants,
-    ConstantWovenCharacterization,
-    ConstantWovenStressLimits,
-    FieldVariable,
-    InterpolationOptions,
-    PuckMaterialType,
-    VariableDensity,
-    VariableEngineeringConstants,
-    VariableFabricFiberAngle,
-    VariableLaRCConstants,
-    VariablePuckConstants,
-    VariableStrainLimits,
-    VariableStressLimits,
-    VariableTsaiWuConstants,
-    VariableWovenCharacterization,
-    VariableWovenStressLimits,
-)
 
-__all__ = [
-    "ConstantDensity",
-    "ConstantEngineeringConstants",
-    "ConstantFabricFiberAngle",
-    "ConstantLaRCConstants",
-    "ConstantPuckConstants",
-    "ConstantStrainLimits",
-    "ConstantStressLimits",
-    "ConstantTsaiWuConstants",
-    "ConstantWovenCharacterization",
-    "ConstantWovenStressLimits",
-    "FieldVariable",
-    "InterpolationOptions",
-    "Material",
-    "property_sets",
-    "PuckMaterialType",
-    "VariableDensity",
-    "VariableEngineeringConstants",
-    "VariableFabricFiberAngle",
-    "VariableLaRCConstants",
-    "VariablePuckConstants",
-    "VariableStrainLimits",
-    "VariableStressLimits",
-    "VariableTsaiWuConstants",
-    "VariableWovenCharacterization",
-    "VariableWovenStressLimits",
-]
+__all__ = ["Material"]
diff --git a/src/ansys/acp/core/material_property_sets.py b/src/ansys/acp/core/material_property_sets.py
@@ -0,0 +1,54 @@
+"""Defines the property sets for materials."""
+
+from ._tree_objects.material.property_sets import (
+    ConstantDensity,
+    ConstantEngineeringConstants,
+    ConstantFabricFiberAngle,
+    ConstantLaRCConstants,
+    ConstantPuckConstants,
+    ConstantStrainLimits,
+    ConstantStressLimits,
+    ConstantTsaiWuConstants,
+    ConstantWovenCharacterization,
+    ConstantWovenStressLimits,
+    FieldVariable,
+    InterpolationOptions,
+    PuckMaterialType,
+    VariableDensity,
+    VariableEngineeringConstants,
+    VariableFabricFiberAngle,
+    VariableLaRCConstants,
+    VariablePuckConstants,
+    VariableStrainLimits,
+    VariableStressLimits,
+    VariableTsaiWuConstants,
+    VariableWovenCharacterization,
+    VariableWovenStressLimits,
+)
+
+__all__ = [
+    "ConstantDensity",
+    "ConstantEngineeringConstants",
+    "ConstantFabricFiberAngle",
+    "ConstantLaRCConstants",
+    "ConstantPuckConstants",
+    "ConstantStrainLimits",
+    "ConstantStressLimits",
+    "ConstantTsaiWuConstants",
+    "ConstantWovenCharacterization",
+    "ConstantWovenStressLimits",
+    "FieldVariable",
+    "InterpolationOptions",
+    "PuckMaterialType",
+    "VariableDensity",
+    "VariableEngineeringConstants",
+    "VariableFabricFiberAngle",
+    "VariableLaRCConstants",
+    "VariablePuckConstants",
+    "VariableStrainLimits",
+    "VariableStressLimits",
+    "VariableTsaiWuConstants",
+    "VariableWovenCharacterization",
+    "VariableWovenStressLimits",
+    "wrap_property_set",
+]
diff --git a/tests/unittests/test_material.py b/tests/unittests/test_material.py
@@ -5,7 +5,8 @@
 import numpy.testing as npt
 import pytest
 
-from ansys.acp.core import (
+from ansys.acp.core import PlyType
+from ansys.acp.core.material_property_sets import (
     ConstantDensity,
     ConstantEngineeringConstants,
     ConstantFabricFiberAngle,
@@ -18,7 +19,6 @@
     ConstantWovenStressLimits,
     FieldVariable,
     InterpolationOptions,
-    PlyType,
     VariableDensity,
     VariableEngineeringConstants,
     VariableStrainLimits,