Merged PR 337513: Mirror GitHub to TFS

Mirroring GitHub into TFS, bringing (among other things) InProcess by default of GitHub release 0.5.2.
Testing pipeline [here](https://tfs.ansys.com:8443/tfs/ANSYS_Development/DPF/_build/results?buildId=7372183&view=logs&s=77b07857-e3de-563a-962e-fe3f8174b54b&j=32ca9294-3ac1-524a-049d-49e4f25e2670). OK

Related work items: #692152

Author: PProfizi

LICENSE

@@ -1,4 +1,4 @@
-The MIT License
+MIT License
 
 Copyright (c) 2022 ANSYS, Inc. All rights reserved.
 

ansys/dpf/core/core.py

@@ -94,8 +94,14 @@ def upload_file_in_tmp_folder(file_path, new_file_name=None, server=None):
     --------
     >>> from ansys.dpf import core as dpf
     >>> from ansys.dpf.core import examples
-    >>> file_path = dpf.upload_file_in_tmp_folder(examples.static_rst)
-
+    >>> server = dpf.start_local_server(config=dpf.AvailableServerConfigs.GrpcServer,
+    ... as_global=False)
+    >>> file_path = dpf.upload_file_in_tmp_folder(examples.static_rst, server=server)
+
+    Notes
+    -----
+    Is not implemented for usage with type(server)=
+    :class:`ansys.dpf.core.server_types.InProcessServer`.
     """
     base = BaseService(server, load_operators=False)
     return base.upload_file_in_tmp_folder(file_path, new_file_name)
@@ -153,12 +159,17 @@ def download_file(server_file_path, to_client_file_path, server=None):
     --------
     >>> from ansys.dpf import core as dpf
     >>> from ansys.dpf.core import examples
-    >>> import os
-    >>> file_path = dpf.upload_file_in_tmp_folder(examples.static_rst)
-    >>> dpf.download_file(file_path, examples.static_rst)
+    >>> server = dpf.start_local_server(config=dpf.AvailableServerConfigs.GrpcServer,
+    ... as_global=False)
+    >>> file_path = dpf.upload_file_in_tmp_folder(examples.static_rst, server=server)
+    >>> dpf.download_file(file_path, examples.static_rst,  server=server)
     <BLANKLINE>
-    Downloading...
+    ...
 
+    Notes
+    -----
+    Is not implemented for usage with type(server)=
+    :class:`ansys.dpf.core.server_types.InProcessServer`.
     """
     base = BaseService(server, load_operators=False)
     return base.download_file(server_file_path, to_client_file_path)
@@ -385,7 +396,7 @@ def __generate_code(TARGET_PATH, filename, name, symbol):
 
             local_dir = os.path.dirname(os.path.abspath(__file__))
             LOCAL_PATH = os.path.join(local_dir, "operators")
-            if self._server().has_client():
+            if not self._server().local_server:
                 if self._server().os != 'posix' or (not self._server().os and os.name != 'posix'):
                     # send local generated code
                     TARGET_PATH = self.make_tmp_dir_server()

ansys/dpf/core/cyclic_support.py

@@ -191,7 +191,8 @@ def sectors_set_for_expansion(self, stage_num=0) -> Scoping:
         >>> from ansys.dpf.core import examples
         >>> multi_stage = examples.download_multi_stage_cyclic_result()
         >>> cyc_support = Model(multi_stage).metadata.result_info.cyclic_support
-        >>> print(cyc_support.sectors_set_for_expansion(stage_num=1).ids)
+        >>> sectors_scoping = cyc_support.sectors_set_for_expansion(stage_num=1)
+        >>> print(sectors_scoping.ids)
         [...0... 1... 2... 3... 4... 5... 6... 7... 8... 9... 10... 11]
 
         """
@@ -223,7 +224,8 @@ def expand_node_id(self, node_id, sectors=None, stage_num=0):
         >>> from ansys.dpf.core import examples
         >>> multi_stage = examples.download_multi_stage_cyclic_result()
         >>> cyc_support = Model(multi_stage).metadata.result_info.cyclic_support
-        >>> print(cyc_support.expand_node_id(1,stage_num=0).ids)
+        >>> expanded_scoping = cyc_support.expand_node_id(1,stage_num=0)
+        >>> print(expanded_scoping.ids)
         [...1... 3596... 5816... 8036... 10256... 12476]
 
         """
@@ -261,7 +263,8 @@ def expand_element_id(self, element_id, sectors=None, stage_num=0):
         >>> from ansys.dpf.core import examples
         >>> multi_stage = examples.download_multi_stage_cyclic_result()
         >>> cyc_support = Model(multi_stage).metadata.result_info.cyclic_support
-        >>> print(cyc_support.expand_element_id(1,stage_num=0).ids)
+        >>> expanded_scoping = cyc_support.expand_element_id(1,stage_num=0)
+        >>> print(expanded_scoping.ids)
         [...1... 1558... 2533... 3508... 4483... 5458]
 
         """

ansys/dpf/core/data_tree.py

@@ -223,6 +223,23 @@ def to_fill(self):
         """
         return _LocalDataTree(self)
 
+    def _serialize(self, path, operator):
+        from ansys.dpf import core
+        operator.inputs.data_tree.connect(self)
+        if path:
+            if self._server.local_server:
+                operator.inputs.path.connect(path)
+                operator.run()
+                return path
+            else:
+                directory = core.core.make_tmp_dir_server(self._server)
+                server_path = core.path_utilities.join(directory, "tmp.txt", server=self._server)
+                operator.inputs.path.connect(server_path)
+                operator.run()
+                return core.download_file(server_path, path, server=self._server)
+        else:
+            return operator.get_output(0, core.types.string)
+
     def write_to_txt(self, path=None):
         """
         Writes the data tree either as a file or as returned string in a text format.
@@ -246,21 +263,12 @@ def write_to_txt(self, path=None):
         >>> import os
         >>> data_tree.write_to_txt(os.path.join(tempfile.mkdtemp(), "data_tree.txt"))
         <BLANKLINE>
-        Downloading...
+        ...
 
         """
         from ansys.dpf.core.operators.serialization import data_tree_to_txt
-        from ansys.dpf import core
         op = data_tree_to_txt(server=self._server)
-        op.inputs.data_tree.connect(self)
-        if path:
-            directory = core.core.make_tmp_dir_server(self._server)
-            server_path = core.path_utilities.join(directory, "tmp.txt", server=self._server)
-            op.inputs.path.connect(server_path)
-            op.run()
-            return core.download_file(server_path, path)
-        else:
-            return op.get_output(0, core.types.string)
+        return self._serialize(path, op)
 
     def write_to_json(self, path=None):
         """
@@ -285,21 +293,26 @@ def write_to_json(self, path=None):
         >>> import os
         >>> data_tree.write_to_json(os.path.join(tempfile.mkdtemp(), "data_tree.json"))
         <BLANKLINE>
-        Downloading...
+        ...
 
         """
         from ansys.dpf.core.operators.serialization import data_tree_to_json
-        from ansys.dpf import core
         op = data_tree_to_json(server=self._server)
-        op.inputs.data_tree.connect(self)
+        return self._serialize(path, op)
+
+    @staticmethod
+    def _deserialize(path, txt, server, operator):
+        from ansys.dpf import core
         if path:
-            directory = core.core.make_tmp_dir_server(self._server)
-            server_path = core.path_utilities.join(directory, "tmp.txt", server=self._server)
-            op.inputs.path.connect(server_path)
-            op.run()
-            return core.download_file(server_path, path)
-        else:
-            return op.get_output(0, core.types.string)
+            server = server_module.get_or_create_server(server)
+            if server.local_server:
+                operator.inputs.string_or_path.connect(core.DataSources(path, server=server))
+            else:
+                server_path = core.upload_file_in_tmp_folder(path, server=server)
+                operator.inputs.string_or_path.connect(core.DataSources(server_path, server=server))
+        elif txt:
+            operator.inputs.string_or_path.connect(str(txt))
+        return operator.outputs.data_tree()
 
     @staticmethod
     def read_from_json(path=None, txt=None, server=None):
@@ -332,14 +345,8 @@ def read_from_json(path=None, txt=None, server=None):
 
         """
         from ansys.dpf.core.operators.serialization import json_to_data_tree
-        from ansys.dpf import core
         op = json_to_data_tree(server=server)
-        if path:
-            server_path = core.upload_file_in_tmp_folder(path, server=server)
-            op.inputs.string_or_path.connect(core.DataSources(server_path, server=server))
-        elif txt:
-            op.inputs.string_or_path.connect(str(txt))
-        return op.outputs.data_tree()
+        return DataTree._deserialize(path, txt, server, op)
 
     @staticmethod
     def read_from_txt(path=None, txt=None, server=None):
@@ -372,14 +379,8 @@ def read_from_txt(path=None, txt=None, server=None):
 
         """
         from ansys.dpf.core.operators.serialization import txt_to_data_tree
-        from ansys.dpf import core
         op = txt_to_data_tree(server=server)
-        if path:
-            server_path = core.upload_file_in_tmp_folder(path, server=server)
-            op.inputs.string_or_path.connect(core.DataSources(server_path, server=server))
-        elif txt:
-            op.inputs.string_or_path.connect(str(txt))
-        return op.outputs.data_tree()
+        return DataTree._deserialize(path, txt, server, op)
 
     def has(self, entry):
         """

ansys/dpf/core/dpf_operator.py

@@ -207,7 +207,7 @@ def connect(self, pin, inpt, pin_out=0):
         >>> max_fc_op.inputs.connect(disp_op.outputs)
         >>> max_field = max_fc_op.outputs.field_max()
         >>> max_field.data
-        array([[0.59428386, 0.00201751, 0.0006032 ]])
+        DPFArray([[0.59428386, 0.00201751, 0.0006032 ]]...
 
         """
         if inpt is self:

ansys/dpf/core/elements.py

@@ -578,8 +578,8 @@ def connectivities_field(self):
         >>> elements = model.metadata.meshed_region.elements
         >>> field = elements.connectivities_field
         >>> field.get_entity_data(1)
-        array([ 0, 11, 13, 25,  2,  9,  8,  3, 29, 58, 63, 32, 40, 52, 42, 37, 28,
-               55, 53, 43])
+        DPFArray([ 0, 11, 13, 25,  2,  9,  8,  3, 29, 58, 63, 32, 40, 52, 42, 37, 28,
+               55, 53, 43]...
 
         """
         return self._get_connectivities_field()

ansys/dpf/core/examples/downloads.py

@@ -452,7 +452,7 @@ def download_example_asme_result() -> str:
 
 def download_crankshaft() -> str:
     """Download the result file of an example of a crankshaft
-    under load simulation and return the download path.
+    under load and return the download path.
 
     Examples files are downloaded to a persistent cache to avoid
     re-downloading the same file twice.
@@ -472,4 +472,28 @@ def download_crankshaft() -> str:
     'C:/Users/user/AppData/local/temp/crankshaft.rst'
 
     """
-    return _download_file("crankshaft", "crankshaft.rst")
+    return _download_file("crankshaft", "crankshaft.rst")
+
+def download_piston_rod() -> str:
+    """Download the result file of an example of a piston rod
+    under load and return the download path.
+
+    Examples files are downloaded to a persistent cache to avoid
+    re-downloading the same file twice.
+
+    Returns
+    -------
+    str
+        Path to the example file.
+
+    Examples
+    --------
+    Download an example result file and return the path of the file
+
+    >>> from ansys.dpf.core import examples
+    >>> path = examples.piston_rod
+    >>> path
+    'C:/Users/user/AppData/local/temp/piston_rod.rst'
+
+    """
+    return _download_file("piston_rod", "piston_rod.rst")

ansys/dpf/core/field.py

@@ -96,7 +96,7 @@ class Field(_FieldBase):
     >>> fields_container = disp.outputs.fields_container()
     >>> field = fields_container[0]
     >>> field.data[2]
-    array([-0.00672665, -0.03213735,  0.00016716])
+    DPFArray([-0.00672665, -0.03213735,  0.00016716]...
 
     """
 

ansys/dpf/core/field_base.py

@@ -287,7 +287,7 @@ def get_entity_data(self, index):
         >>> stress_op = model.results.stress()
         >>> fields_container = stress_op.outputs.fields_container()
         >>> fields_container[0].get_entity_data(0)
-        array([[-3.27795062e+05,  1.36012200e+06,  1.49090608e+08,
+        DPFArray([[-3.27795062e+05,  1.36012200e+06,  1.49090608e+08,
                 -4.88688900e+06,  1.43038560e+07,  1.65455040e+07],
                [-4.63817550e+06,  1.29312225e+06,  1.20411832e+08,
                 -6.06617800e+06,  2.34829700e+07,  1.77231120e+07],
@@ -302,7 +302,7 @@ def get_entity_data(self, index):
                [ 9.25567760e+07,  8.15244320e+07,  2.77157632e+08,
                 -1.48489875e+06,  5.89250600e+07,  2.05608920e+07],
                [ 6.70443680e+07,  8.70343440e+07,  2.73050464e+08,
-                -2.48670150e+06,  1.52268930e+07,  6.09583280e+07]])
+                -2.48670150e+06,  1.52268930e+07,  6.09583280e+07]]...
 
         """
         pass
@@ -325,7 +325,7 @@ def get_entity_data_by_id(self, id):
         >>> stress_op = model.results.stress()
         >>> fields_container = stress_op.outputs.fields_container()
         >>> fields_container[0].get_entity_data_by_id(391)
-        array([[-3.27795062e+05,  1.36012200e+06,  1.49090608e+08,
+        DPFArray([[-3.27795062e+05,  1.36012200e+06,  1.49090608e+08,
                 -4.88688900e+06,  1.43038560e+07,  1.65455040e+07],
                [-4.63817550e+06,  1.29312225e+06,  1.20411832e+08,
                 -6.06617800e+06,  2.34829700e+07,  1.77231120e+07],
@@ -340,7 +340,7 @@ def get_entity_data_by_id(self, id):
                [ 9.25567760e+07,  8.15244320e+07,  2.77157632e+08,
                 -1.48489875e+06,  5.89250600e+07,  2.05608920e+07],
                [ 6.70443680e+07,  8.70343440e+07,  2.73050464e+08,
-                -2.48670150e+06,  1.52268930e+07,  6.09583280e+07]])
+                -2.48670150e+06,  1.52268930e+07,  6.09583280e+07]]...
 
         """
         pass
@@ -363,8 +363,8 @@ def append(self, data, scopingid):
         >>> field.append([1.,2.,3.],1)
         >>> field.append([1.,2.,3.],2)
         >>> field.data
-        array([[1., 2., 3.],
-               [1., 2., 3.]])
+        DPFArray([[1., 2., 3.],
+               [1., 2., 3.]]...
         >>> field.scoping.ids
         <BLANKLINE>
         ...[1, 2]...

ansys/dpf/core/field_definition.py

@@ -121,7 +121,7 @@ def dimensionality(self):
         dimensionality : Dimensionality
             Nature and size of the elementary data.
         """
-        dim = integral_types.MutableListInt32()
+        dim = integral_types.MutableListInt32(size=3)
         nature = integral_types.MutableInt32()
         self._api.csfield_definition_fill_dimensionality(self, dim, nature, dim.internal_size)
         return Dimensionality(dim.tolist(), natures(int(nature)))