Rename DimensionType to PhysicalDimension

Author: greschd

doc/source/api/enum_types.rst

@@ -13,7 +13,7 @@ Enumeration data types
     CutOffGeometryOrientationType
     CutoffMaterialHandling
     CutoffRuleType
-    DimensionType
+    PhysicalDimension
     DrapingMaterialModel
     DrapingType
     DropoffMaterialHandling

examples/modeling_features/03-advanced-selection-rules.py

@@ -51,9 +51,9 @@
 # Import the PyACP dependencies.
 from ansys.acp.core import (
     BooleanOperationType,
-    DimensionType,
     EdgeSetType,
     LinkedSelectionRule,
+    PhysicalDimension,
     launch_acp,
 )
 from ansys.acp.core.extras import ExampleKeys, get_example_file
@@ -241,7 +241,7 @@
 # Create the offset column that defines the offsets from the edge.
 offsets_column = lookup_table.create_column(
     name="offset",
-    dimension_type=DimensionType.LENGTH,
+    physical_dimension=PhysicalDimension.LENGTH,
     data=np.array([0.00, 0.004, 0]),
 )
 

examples/modeling_features/04-layup-thickness-definitions.py

@@ -45,7 +45,7 @@
 
 # %%
 # Import the PyACP dependencies.
-from ansys.acp.core import DimensionType, ThicknessType, launch_acp
+from ansys.acp.core import PhysicalDimension, ThicknessType, launch_acp
 from ansys.acp.core.extras import ExampleKeys, get_example_file
 
 # sphinx_gallery_thumbnail_number = 2
@@ -166,7 +166,9 @@
 # Create the lookup table and add the coordinates and thickness data.
 lookup_table = model.create_lookup_table_3d()
 lookup_table.columns["Location"].data = points
-thickness_column = lookup_table.create_column(data=thickness, dimension_type=DimensionType.LENGTH)
+thickness_column = lookup_table.create_column(
+    data=thickness, physical_dimension=PhysicalDimension.LENGTH
+)
 
 # %%
 # Set the thickness type to ``FROM_TABLE`` and assign the thickness column.

examples/modeling_features/06-ply-direction-lookup-table.py

@@ -45,9 +45,9 @@
 # %%
 # Import the PyACP dependencies.
 from ansys.acp.core import (
-    DimensionType,
     DrapingType,
     LookUpTableColumnValueType,
+    PhysicalDimension,
     PlyType,
     RosetteSelectionMethod,
     get_directions_plotter,
@@ -147,7 +147,7 @@
 lookup_table.columns["Location"].data = points
 direction_column = lookup_table.create_column(
     data=directions,
-    dimension_type=DimensionType.DIMENSIONLESS,
+    physical_dimension=PhysicalDimension.DIMENSIONLESS,
     value_type=LookUpTableColumnValueType.DIRECTION,
 )
 
@@ -177,7 +177,7 @@
 correction_angle = np.arctan2(xx.ravel(), zz.ravel()) * 180 / np.pi
 angle_column_1 = lookup_table.create_column(
     data=correction_angle,
-    dimension_type=DimensionType.DIMENSIONLESS,
+    physical_dimension=PhysicalDimension.DIMENSIONLESS,
     value_type=LookUpTableColumnValueType.SCALAR,
 )
 
@@ -187,7 +187,7 @@
 transverse_correction_angle = correction_angle + shear_angle
 angle_column_2 = lookup_table.create_column(
     data=transverse_correction_angle,
-    dimension_type=DimensionType.DIMENSIONLESS,
+    physical_dimension=PhysicalDimension.DIMENSIONLESS,
     value_type=LookUpTableColumnValueType.SCALAR,
 )
 

src/ansys/acp/core/__init__.py

@@ -61,7 +61,6 @@
     CutoffRuleType,
     CutoffSelectionRule,
     CylindricalSelectionRule,
-    DimensionType,
     DrapingMaterialModel,
     DrapingType,
     DropoffMaterialHandling,
@@ -115,6 +114,7 @@
     OffsetType,
     OrientedSelectionSet,
     ParallelSelectionRule,
+    PhysicalDimension,
     PlyCutoffType,
     PlyGeometryExportFormat,
     PlyType,
@@ -179,9 +179,9 @@
     "CutoffRuleType",
     "CutoffSelectionRule",
     "CylindricalSelectionRule",
-    "DimensionType",
     "DirectLaunchConfig",
     "DockerComposeLaunchConfig",
+    "dpf_integration_helpers",
     "DrapingMaterialModel",
     "DrapingType",
     "DropoffMaterialHandling",
@@ -236,7 +236,7 @@
     "material_property_sets",
     "Material",
     "mechanical_integration_helpers",
-    "dpf_integration_helpers",
+    "mesh_data",
     "MeshImportType",
     "Model",
     "ModelingGroup",
@@ -245,9 +245,9 @@
     "OffsetType",
     "OrientedSelectionSet",
     "ParallelSelectionRule",
+    "PhysicalDimension",
     "PlyCutoffType",
     "PlyGeometryExportFormat",
-    "SolidModelOffsetDirectionType",
     "PlyType",
     "PrimaryPly",
     "print_model",
@@ -271,6 +271,7 @@
     "SolidModelExportFormat",
     "SolidModelExportSettings",
     "SolidModelImportFormat",
+    "SolidModelOffsetDirectionType",
     "SolidModelSkinExportFormat",
     "SphericalSelectionRule",
     "Stackup",
@@ -287,5 +288,4 @@
     "VariableOffsetSelectionRule",
     "VirtualGeometry",
     "VirtualGeometryDimension",
-    "mesh_data",
 ]

src/ansys/acp/core/_tree_objects/__init__.py

@@ -51,7 +51,6 @@
     CutOffGeometryOrientationType,
     CutoffMaterialHandling,
     CutoffRuleType,
-    DimensionType,
     DrapingMaterialModel,
     DrapingType,
     DropoffMaterialHandling,
@@ -72,6 +71,7 @@
     MeshImportType,
     NodalDataType,
     OffsetType,
+    PhysicalDimension,
     PlyCutoffType,
     PlyGeometryExportFormat,
     PlyType,
@@ -204,7 +204,6 @@
     "CylindricalSelectionRule",
     "CylindricalSelectionRuleElementalData",
     "CylindricalSelectionRuleNodalData",
-    "DimensionType",
     "DrapingMaterialModel",
     "DrapingType",
     "DropoffMaterialHandling",
@@ -268,14 +267,14 @@
     "ModelingPlyNodalData",
     "ModelNodalData",
     "NodalDataType",
-    "SolidModelOffsetDirectionType",
     "OffsetType",
     "OrientedSelectionSet",
     "OrientedSelectionSetElementalData",
     "OrientedSelectionSetNodalData",
     "ParallelSelectionRule",
     "ParallelSelectionRuleElementalData",
     "ParallelSelectionRuleNodalData",
+    "PhysicalDimension",
     "PlyCutoffType",
     "PlyGeometryExportFormat",
     "PlyType",
@@ -307,6 +306,7 @@
     "SolidModelExportSettings",
     "SolidModelImportFormat",
     "SolidModelNodalData",
+    "SolidModelOffsetDirectionType",
     "SolidModelSkinExportFormat",
     "SphericalSelectionRule",
     "SphericalSelectionRuleElementalData",

src/ansys/acp/core/_tree_objects/enums.py

@@ -53,7 +53,7 @@
     "CutOffGeometryOrientationType",
     "CutoffMaterialHandling",
     "CutoffRuleType",
-    "DimensionType",
+    "PhysicalDimension",
     "DrapingMaterialModel",
     "DrapingType",
     "DropoffMaterialHandling",
@@ -256,11 +256,11 @@
 )
 
 (
-    DimensionType,
-    dimension_type_to_pb,
-    dimension_type_from_pb,
+    PhysicalDimension,
+    physical_dimension_to_pb,
+    physical_dimension_from_pb,
 ) = wrap_to_string_enum(
-    "DimensionType",
+    "PhysicalDimension",
     unit_system_pb2.DimensionType,
     module=__name__,
     doc="Options for the dimension (time, length, currency, ...) of data.",

src/ansys/acp/core/_tree_objects/lookup_table_1d_column.py

@@ -30,7 +30,7 @@
 from ansys.api.acp.v0 import lookup_table_1d_column_pb2, lookup_table_1d_column_pb2_grpc
 
 from ._grpc_helpers.property_helper import mark_grpc_properties
-from .enums import DimensionType, LookUpTableColumnValueType
+from .enums import LookUpTableColumnValueType, PhysicalDimension
 from .lookup_table_column_base import LookUpTableColumnBase
 from .object_registry import register
 
@@ -49,7 +49,7 @@ class LookUpTable1DColumn(LookUpTableColumnBase):
         directional (three entries per row).
         Note that the ``value_type`` can only be set when constructing the
         column, and is read-only afterwards.
-    dimension_type :
+    physical_dimension :
         Dimensionality (such as time, length, force, ...) of the column data.
     data :
         The column data. The shape of the data must match the ``value_type``
@@ -69,10 +69,12 @@ def __init__(
         *,
         name: str = "LookUpTable1DColumn",
         value_type: LookUpTableColumnValueType = LookUpTableColumnValueType.SCALAR,
-        dimension_type: DimensionType = DimensionType.DIMENSIONLESS,
+        physical_dimension: PhysicalDimension = PhysicalDimension.DIMENSIONLESS,
         data: npt.NDArray[np.float64] | None = None,
     ):
-        super().__init__(name=name, value_type=value_type, dimension_type=dimension_type, data=data)
+        super().__init__(
+            name=name, value_type=value_type, physical_dimension=physical_dimension, data=data
+        )
 
     def _create_stub(self) -> lookup_table_1d_column_pb2_grpc.ObjectServiceStub:
         return lookup_table_1d_column_pb2_grpc.ObjectServiceStub(self._channel)

src/ansys/acp/core/_tree_objects/lookup_table_3d_column.py

@@ -30,7 +30,7 @@
 from ansys.api.acp.v0 import lookup_table_3d_column_pb2, lookup_table_3d_column_pb2_grpc
 
 from ._grpc_helpers.property_helper import mark_grpc_properties
-from .enums import DimensionType, LookUpTableColumnValueType
+from .enums import LookUpTableColumnValueType, PhysicalDimension
 from .lookup_table_column_base import LookUpTableColumnBase
 from .object_registry import register
 
@@ -49,7 +49,7 @@ class LookUpTable3DColumn(LookUpTableColumnBase):
         directional (three entries per row).
         Note that the ``value_type`` can only be set when constructing the
         column, and is read-only afterwards.
-    dimension_type :
+    physical_dimension :
         Dimensionality (such as time, length, force, ...) of the column data.
     data :
         The column data. The shape of the data must match the ``value_type``
@@ -69,10 +69,12 @@ def __init__(
         *,
         name: str = "LookUpTable3DColumn",
         value_type: LookUpTableColumnValueType = LookUpTableColumnValueType.SCALAR,
-        dimension_type: DimensionType = DimensionType.DIMENSIONLESS,
+        physical_dimension: PhysicalDimension = PhysicalDimension.DIMENSIONLESS,
         data: npt.NDArray[np.float64] | None = None,
     ):
-        super().__init__(name=name, value_type=value_type, dimension_type=dimension_type, data=data)
+        super().__init__(
+            name=name, value_type=value_type, physical_dimension=physical_dimension, data=data
+        )
 
     def _create_stub(self) -> lookup_table_3d_column_pb2_grpc.ObjectServiceStub:
         return lookup_table_3d_column_pb2_grpc.ObjectServiceStub(self._channel)

src/ansys/acp/core/_tree_objects/lookup_table_column_base.py

@@ -37,12 +37,12 @@
 )
 from .base import CreatableTreeObject, IdTreeObject
 from .enums import (
-    DimensionType,
     LookUpTableColumnValueType,
-    dimension_type_from_pb,
-    dimension_type_to_pb,
+    PhysicalDimension,
     lookup_table_column_value_type_from_pb,
     lookup_table_column_value_type_to_pb,
+    physical_dimension_from_pb,
+    physical_dimension_to_pb,
 )
 
 __all__ = ["LookUpTableColumnBase"]
@@ -59,7 +59,7 @@ class LookUpTableColumnBase(CreatableTreeObject, IdTreeObject):
         directional (three entries per row).
         Note that the ``value_type`` can only be set when constructing the
         column, and is read-only afterwards.
-    dimension_type :
+    physical_dimension :
         Dimensionality (such as time, length, force, ...) of the column data.
     data :
         The column data. The shape of the data must match the ``value_type``
@@ -74,7 +74,7 @@ def __init__(
         *,
         name: str,
         value_type: LookUpTableColumnValueType = LookUpTableColumnValueType.SCALAR,
-        dimension_type: DimensionType = DimensionType.DIMENSIONLESS,
+        physical_dimension: PhysicalDimension = PhysicalDimension.DIMENSIONLESS,
         data: npt.NDArray[np.float64] | None = None,
     ):
         super().__init__(name=name)
@@ -88,17 +88,17 @@ def __init__(
             self, value_type
         )
 
-        self.dimension_type = dimension_type
+        self.physical_dimension = physical_dimension
         if data is not None:
             self.data = data
 
     value_type = grpc_data_property_read_only(
         "properties.value_type", from_protobuf=lookup_table_column_value_type_from_pb
     )
-    dimension_type = grpc_data_property(
+    physical_dimension = grpc_data_property(
         "properties.dimension_type",
-        from_protobuf=dimension_type_from_pb,
-        to_protobuf=dimension_type_to_pb,
+        from_protobuf=physical_dimension_from_pb,
+        to_protobuf=physical_dimension_to_pb,
     )
     data: ReadWriteProperty[npt.NDArray[np.float64], npt.NDArray[np.float64]] = grpc_data_property(
         "properties.data",

tests/unittests/test_lookup_table_column.py

@@ -26,10 +26,10 @@
 import pytest
 
 from ansys.acp.core import (
-    DimensionType,
     LookUpTable1DColumn,
     LookUpTable3DColumn,
     LookUpTableColumnValueType,
+    PhysicalDimension,
 )
 
 from .common.tree_object_tester import (
@@ -115,7 +115,7 @@ class TestLookUpTableColumn(WithLockedMixin, TreeObjectTester):
     def default_properties(default_data):
         return {
             "value_type": LookUpTableColumnValueType.SCALAR,
-            "dimension_type": DimensionType.DIMENSIONLESS,
+            "physical_dimension": PhysicalDimension.DIMENSIONLESS,
             "data": default_data,
         }
 
@@ -128,9 +128,9 @@ def object_properties(column_data, column_value_type):
             read_write=[
                 ("name", "some_name"),
                 ("data", column_data),
-                ("dimension_type", DimensionType.TIME),
-                ("dimension_type", DimensionType.CURRENCY),
-                ("dimension_type", DimensionType.MASS),
+                ("physical_dimension", PhysicalDimension.TIME),
+                ("physical_dimension", PhysicalDimension.CURRENCY),
+                ("physical_dimension", PhysicalDimension.MASS),
             ],
             read_only=[
                 ("id", "some_id"),
@@ -141,7 +141,7 @@ def object_properties(column_data, column_value_type):
                 {
                     "name": "some_name",
                     "data": column_data,
-                    "dimension_type": DimensionType.TIME,
+                    "physical_dimension": PhysicalDimension.TIME,
                     "value_type": column_value_type,
                 }
             ],