Merge branch 'master' into dependabot/pip/requirements/ansys-sphinx-theme-1.2.0

Revathyvenugopal162 · web-flow · commit a1b1dcd96ca2 · 2024-11-10T18:37:11.000+01:00
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -61,6 +61,8 @@ body:
       label: Which DPF/Ansys version are you using?
       multiple: true
       options:
+       - 'DPF Server 2025.2.pre0'
+       - 'Ansys 2025 R1'
        - 'DPF Server 2025.1.pre0'
        - 'Ansys 2024 R2'
        - 'DPF Server 2024.2.pre1'
diff --git a/.github/workflows/ci_release.yml b/.github/workflows/ci_release.yml
@@ -73,22 +73,43 @@ jobs:
           name: ${{ steps.wheel.outputs.wheel_name }}
           path: dist/${{ steps.wheel.outputs.wheel_name }}
 
+  tests_3_9:
+    uses: ./.github/workflows/tests.yml
+    with:
+      ANSYS_VERSION: ${{ github.event.inputs.ansys_version || '251' }}
+      python_versions: '["3.9"]'
+      wheel: true
+      wheelhouse: true
+      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '.pre0' }}
+    secrets: inherit
+
   tests:
     uses: ./.github/workflows/tests.yml
     with:
       ANSYS_VERSION: ${{ github.event.inputs.ansys_version || '251' }}
-      python_versions: '["3.9", "3.10", "3.11"]'
-      wheel: ${{ matrix.python-version == '3.9' }}
+      python_versions: '["3.10", "3.11"]'
+      wheel: false
       wheelhouse: true
       standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '.pre0' }}
     secrets: inherit
 
+  tests_any_3_9:
+    uses: ./.github/workflows/tests.yml
+    with:
+      ANSYS_VERSION: ${{ github.event.inputs.ansys_version || '251' }}
+      python_versions: '["3.9"]'
+      wheel: true
+      wheelhouse: false
+      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '.pre0' }}
+      test_any: true
+    secrets: inherit
+
   tests_any:
     uses: ./.github/workflows/tests.yml
     with:
       ANSYS_VERSION: ${{ github.event.inputs.ansys_version || '251' }}
-      python_versions: '["3.9", "3.10", "3.11"]'
-      wheel: ${{ matrix.python-version == '3.9' }}
+      python_versions: '["3.10", "3.11"]'
+      wheel: false
       wheelhouse: false
       standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '.pre0' }}
       test_any: true
@@ -211,11 +232,11 @@ jobs:
   draft_release:
     name: "Draft Release"
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
-    needs: [style, tests, docs, examples, retro_232, retro_231, retro_222, docker_tests]
+    needs: [style, tests, tests_3_9, tests_any, tests_any_3_9, docs, examples, retro_232, retro_231, retro_222, docker_tests]
     runs-on: ubuntu-latest
     steps:
       - name: "Download artifacts"
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
 
       - name: "Display downloaded files"
         run: ls -R
diff --git a/.github/workflows/releaser.yml b/.github/workflows/releaser.yml
@@ -10,10 +10,6 @@ on:
         description: 'Release tag'
         default: 'latest'
         type: string
-      checkout_ref:
-        description: 'Ref to checkout for doc index (default to current branch)'
-        default: ''
-        type: string
 
 env:
   DOCUMENTATION_CNAME: 'dpf.docs.pyansys.com'
@@ -93,6 +89,8 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
           doc-artifact-name: HTML-doc-ansys-dpf-core.zip
           decompress-artifact: true
+          bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+          bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
 
   update_ansys_lab_examples:
     uses: ./.github/workflows/ansys_lab.yml
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -139,7 +139,7 @@ jobs:
           echo "wheel_name=${name[0]}" >> $GITHUB_OUTPUT
 
       - name: "Upload wheel to artifacts"
-        if: (inputs.wheel == 'true') && !(inputs.test_any && (matrix.os == 'ubuntu-latest') )
+        if: (inputs.wheel == 'true') && !( (inputs.test_any == 'true') && (matrix.os == 'ubuntu-latest') )
         uses: actions/upload-artifact@v4
         with:
           name: ${{ steps.wheel.outputs.wheel_name }}
diff --git a/examples/10-mesh_operations/13-nodes_in_local_coordinate_system.py b/examples/10-mesh_operations/13-nodes_in_local_coordinate_system.py
@@ -42,6 +42,7 @@
 # Import necessary modules
 from ansys.dpf import core as dpf
 from ansys.dpf.core import examples
+from ansys.dpf.gate.errors import DPFServerException
 
 
 ###############################################################################
@@ -59,7 +60,7 @@
     # Starting with DPF 2025.1.pre1
     cs = dpf.operators.result.coordinate_system()
     cs.inputs.data_sources.connect(model)
-except (KeyError, ansys.dpf.gate.errors.DPFServerException) as e:
+except (KeyError, DPFServerException) as e:
     # For previous DPF versions
     cs = model.operator(r"mapdl::rst::CS")
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -30,7 +30,7 @@ dependencies = [
     "google-api-python-client",
     "grpcio >=1.63.0",
     "importlib-metadata >=4.0",
-    "numpy<2",
+    "numpy",
     "packaging",
     "protobuf",
     "psutil",
diff --git a/requirements/requirements_docs.txt b/requirements/requirements_docs.txt
@@ -9,7 +9,7 @@ pytest-sphinx==0.6.3
 pyvista==0.44.1
 sphinx==7.1.0
 sphinx-copybutton==0.5.2
-sphinx-gallery==0.17.1
+sphinx-gallery==0.18.0
 sphinx-notfound-page==1.0.4
 sphinx-reredirects==0.1.3
 sphinx_design==0.6.1
diff --git a/requirements/requirements_install.txt b/requirements/requirements_install.txt
@@ -1,5 +1,5 @@
 importlib-metadata==8.5.0
-numpy==2.1.2
+numpy==2.1.3
 packaging==24.0
 psutil==6.1.0
-tqdm==4.66.1
+tqdm==4.67.0
diff --git a/src/ansys/dpf/core/_version.py b/src/ansys/dpf/core/_version.py
@@ -43,6 +43,7 @@ class ServerToAnsysVersion:
         "8.2": "2024R2",
         "9.0": "2025R1",
         "9.1": "2025R1",
+        "10.0": "2025R2",
     }
 
     def __getitem__(self, item):
diff --git a/src/ansys/dpf/core/custom_fields_container.py b/src/ansys/dpf/core/custom_fields_container.py
@@ -294,7 +294,7 @@ class BodyFieldsContainer(FieldsContainer):
     >>> model = dpf.Model(examples.download_all_kinds_of_complexity_modal())
     >>> fc = model.results.displacement.on_all_time_freqs.split_by_body.eval()
     >>> fc.get_mat_scoping().ids[3]
-    45
+    np.int32(45)
     >>> len(fc.get_fields_by_mat_id(45))
     45
     >>> f_time_2 = fc.get_field_by_mat_id(45, timeid=2)
diff --git a/src/ansys/dpf/core/cyclic_support.py b/src/ansys/dpf/core/cyclic_support.py
@@ -32,6 +32,7 @@
 
 from ansys.dpf.core import server as server_module
 from ansys.dpf.core.scoping import Scoping
+from ansys.dpf.core import field, property_field
 
 
 class CyclicSupport:
@@ -304,6 +305,74 @@ def expand_element_id(self, element_id, sectors=None, stage_num=0):
         )
         return Scoping(scoping=expanded_ids, server=self._server)
 
+    def cs(self) -> field.Field:
+        """Coordinate system of the cyclic support.
+
+        Examples
+        --------
+        >>> from ansys.dpf.core import Model
+        >>> from ansys.dpf.core import examples
+        >>> multi_stage = examples.download_multi_stage_cyclic_result()
+        >>> cyc_support = Model(multi_stage).metadata.result_info.cyclic_support
+        >>> cs = cyc_support.cs()
+
+        """
+
+        cs = self._api.cyclic_support_get_cs(self)
+        return field.Field(field=cs, server=self._server)
+
+    def low_high_map(self, stage_num: int = 0) -> property_field.PropertyField:
+        """Retrieve a property field containing node map from low to high
+        base sector of the given stage.
+
+        Parameters
+        ----------
+        stage_num:
+            Number of the stage required (from 0 to num_stages).
+
+        Returns
+        -------
+        low_high_map:
+            Node correspondence between low to high in the base sector of the given stage.
+
+        Examples
+        --------
+        >>> from ansys.dpf.core import Model
+        >>> from ansys.dpf.core import examples
+        >>> multi_stage = examples.download_multi_stage_cyclic_result()
+        >>> cyc_support = Model(multi_stage).metadata.result_info.cyclic_support
+        >>> low_high_map = cyc_support.low_high_map(0)
+
+        """
+        low_high_map = self._api.cyclic_support_get_low_high_map(self, stage_num)
+        return property_field.PropertyField(property_field=low_high_map, server=self._server)
+
+    def high_low_map(self, stage_num: int = 0) -> property_field.PropertyField:
+        """Retrieve a property field containing node map from high to low
+        base sector of the given stage.
+
+        Parameters
+        ----------
+        stage_num:
+            Number of the stage required (from 0 to num_stages).
+
+        Returns
+        -------
+        low_high_map:
+            Node correspondence between high to low in the base sector of the given stage.
+
+        Examples
+        --------
+        >>> from ansys.dpf.core import Model
+        >>> from ansys.dpf.core import examples
+        >>> multi_stage = examples.download_multi_stage_cyclic_result()
+        >>> cyc_support = Model(multi_stage).metadata.result_info.cyclic_support
+        >>> high_low_map = cyc_support.high_low_map(0)
+
+        """
+        high_low_map = self._api.cyclic_support_get_high_low_map(self, stage_num)
+        return property_field.PropertyField(property_field=high_low_map, server=self._server)
+
     def __del__(self):
         try:
             self._deleter_func[0](self._deleter_func[1](self))
diff --git a/src/ansys/dpf/core/model.py b/src/ansys/dpf/core/model.py
@@ -105,7 +105,7 @@ def metadata(self):
 
         >>> meshed_region = model.metadata.meshed_region
         >>> meshed_region.elements.scoping.ids[2]
-        759
+        np.int32(759)
 
         Get the data sources of the model.
 
diff --git a/src/ansys/dpf/core/nodes.py b/src/ansys/dpf/core/nodes.py
@@ -214,7 +214,7 @@ def scoping(self):
         >>> meshed_region = model.metadata.meshed_region
         >>> nodes = model.metadata.meshed_region.nodes
         >>> nodes.scoping.ids[2]
-        3
+        np.int32(3)
 
         """
         return self._mesh._get_scoping(loc=locations.nodal)
diff --git a/src/ansys/dpf/core/operator_specification.py b/src/ansys/dpf/core/operator_specification.py
@@ -349,7 +349,7 @@ def description(self) -> str:
         >>> from ansys.dpf import core as dpf
         >>> operator = dpf.operators.math.scale()
         >>> operator.specification.description
-        'Scales a field by a constant factor. This factor can be a scalar ...'
+        'Scales a field by a constant factor...'
         """
         if self._internal_obj is not None:
             return self._api.operator_specification_get_description(self)
diff --git a/src/ansys/dpf/gate/cyclic_support_grpcapi.py b/src/ansys/dpf/gate/cyclic_support_grpcapi.py
@@ -75,6 +75,16 @@ def cyclic_support_get_base_elements_scoping(support, i_stage):
         return getattr(CyclicSupportGRPCAPI.list(support),
                        "base_elements_scoping_"+str(i_stage)).get_ownership()
 
+    @staticmethod
+    def cyclic_support_get_low_high_map(support, i_stage):
+        return getattr(CyclicSupportGRPCAPI.list(support),
+                       "low_high_map_"+str(i_stage)).get_ownership()
+
+    @staticmethod
+    def cyclic_support_get_high_low_map(support, i_stage):
+        return getattr(CyclicSupportGRPCAPI.list(support),
+                       "high_low_map_"+str(i_stage)).get_ownership()
+
     @staticmethod
     def get_expanded_ids(support, request):
         return _get_stub(support._server).GetExpandedIds(request).expanded_ids
@@ -100,3 +110,19 @@ def cyclic_support_get_expanded_element_ids(support, baseElementId, i_stage, sec
         request = CyclicSupportGRPCAPI.init_get_expanded_ids(support, i_stage, sectorsScoping)
         request.element_id = baseElementId
         return CyclicSupportGRPCAPI.get_expanded_ids(support, request)
+
+    @staticmethod
+    def get_cs(support, request):
+        return _get_stub(support._server).GetCS(request).cs
+
+    @staticmethod
+    def init_get_cs(support):
+        from ansys.grpc.dpf import cyclic_support_pb2
+        request = cyclic_support_pb2.GetCSRequest()
+        request.support.CopyFrom(support._internal_obj)
+        return request
+
+    @staticmethod
+    def cyclic_support_get_cs(support):
+        request = CyclicSupportGRPCAPI.init_get_cs(support)
+        return CyclicSupportGRPCAPI.get_cs(support, request)
diff --git a/src/ansys/dpf/gatebin/Ans.Dpf.GrpcClient.dll b/src/ansys/dpf/gatebin/Ans.Dpf.GrpcClient.dll
diff --git a/src/ansys/dpf/gatebin/DPFClientAPI.dll b/src/ansys/dpf/gatebin/DPFClientAPI.dll
diff --git a/src/ansys/dpf/gatebin/libAns.Dpf.GrpcClient.so b/src/ansys/dpf/gatebin/libAns.Dpf.GrpcClient.so
diff --git a/src/ansys/dpf/gatebin/libDPFClientAPI.so b/src/ansys/dpf/gatebin/libDPFClientAPI.so
diff --git a/tests/test_cyclic_support.py b/tests/test_cyclic_support.py
@@ -24,6 +24,7 @@
 import weakref
 import numpy as np
 
+import conftest
 import pytest
 
 from ansys import dpf
@@ -171,6 +172,18 @@ def test_cyc_support_from_to_workflow(cyclic_lin_rst, server_type):
     assert len(exp.base_nodes_scoping().ids) == 32
 
 
+@pytest.mark.skipif(
+    not conftest.SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_8_2, reason="Requires DPF 8.2 or above."
+)
+def test_cyc_support_coordinate_system(cyclic_lin_rst):
+    data_sources = dpf.DataSources(cyclic_lin_rst)
+    model = dpf.Model(data_sources)
+    result_info = model.metadata.result_info
+    cyc_support = result_info.cyclic_support
+    exp = cyc_support.cs().scoping
+    assert np.allclose(exp.ids, [12])
+
+
 def test_cyc_support_multistage(cyclic_multistage):
     model = dpf.Model(cyclic_multistage)
     cyc_support = model.metadata.result_info.cyclic_support
@@ -185,6 +198,24 @@ def test_cyc_support_multistage(cyclic_multistage):
     assert np.allclose(cyc_support.sectors_set_for_expansion(stage_num=1).ids, list(range(0, 12)))
 
 
+@pytest.mark.skipif(
+    not conftest.SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_8_2, reason="Requires DPF 8.2 or above."
+)
+def test_cyc_support_multistage_low_high_map(cyclic_multistage):
+    model = dpf.Model(cyclic_multistage)
+    cyc_support = model.metadata.result_info.cyclic_support
+
+    high_low_map = cyc_support.high_low_map(0)
+    assert np.allclose(high_low_map.get_entity_data_by_id(1446), 1447)
+    assert np.allclose(high_low_map.get_entity_data_by_id(2946), 2948)
+    assert np.allclose(high_low_map.get_entity_data_by_id(1452), 1466)
+
+    low_high_map = cyc_support.low_high_map(1)
+    assert np.allclose(low_high_map.get_entity_data_by_id(995), 939)
+    assert np.allclose(low_high_map.get_entity_data_by_id(53), 54)
+    assert np.allclose(low_high_map.get_entity_data_by_id(70), 56)
+
+
 def test_delete_cyc_support(cyclic_lin_rst, server_type_legacy_grpc):
     data_sources = dpf.DataSources(cyclic_lin_rst, server=server_type_legacy_grpc)
     model = dpf.Model(data_sources, server=server_type_legacy_grpc)

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,7 @@ class ServerToAnsysVersion:`
`43`	`43`	`"8.2": "2024R2",`
`44`	`44`	`"9.0": "2025R1",`
`45`	`45`	`"9.1": "2025R1",`
	`46`	`+ "10.0": "2025R2",`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`def __getitem__(self, item):`
Original file line number	Diff line number	Diff line change
`@@ -294,7 +294,7 @@ class BodyFieldsContainer(FieldsContainer):`
`294`	`294`	`>>> model = dpf.Model(examples.download_all_kinds_of_complexity_modal())`
`295`	`295`	`>>> fc = model.results.displacement.on_all_time_freqs.split_by_body.eval()`
`296`	`296`	`>>> fc.get_mat_scoping().ids[3]`
`297`		`- 45`
	`297`	`+ np.int32(45)`
`298`	`298`	`>>> len(fc.get_fields_by_mat_id(45))`
`299`	`299`	`45`
`300`	`300`	`>>> f_time_2 = fc.get_field_by_mat_id(45, timeid=2)`