Merge branch 'master' into fix/associate_mesh_to_coordinates_field

Author: PProfizi

doc/source/_static/dpf_operators.html

@@ -182,7 +182,7 @@ The following Ansys licensing increments provide rights to use the licensed DPF
 - ``cfd_solve_level2`` available in the ``Ansys CFD Enterprise`` product
 - ``cfd_solve_level3`` available in the ``Ansys CFD Enterprise`` product
 - ``fluent_meshing`` available in the ``Ansys CFD Enterprise`` product
-- ``avrxp_snd_level1`` available in the ``Ansys Sound Enterprise`` product
+- ``avrxp_snd_level1`` available in the ``Ansys Sound Pro`` product
 - ``sherlock`` available in the ``Ansys Sherlock`` product
 
 Each increment may be available in other products. On the Ansys Customer Portal,

doc/source/getting_started/licensing.rst

@@ -211,6 +211,36 @@ def add_file_path(self, filepath, key="", is_domain: bool = False, domain_id=0):
             else:
                 self._api.data_sources_add_file_path_with_key_utf8(self, str(filepath), key)
 
+    def add_domain_file_path(self, filepath, key, domain_id):
+        """Add a file path to the data sources.
+
+        Files not added as result files are accessory files, which contain accessory
+        information not present in the result files.
+
+        Parameters
+        ----------
+        filepath:
+            Path of the file.
+        key:
+            Extension of the file, which is used as a key for choosing the correct
+            plugin when a result is requested by an operator.
+        domain_id:
+            Domain ID for the distributed files.
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> data_sources = dpf.DataSources()
+        >>> data_sources.add_domain_file_path('/tmp/ds.dat', "dat", 1)
+
+        """
+        # The filename needs to be a fully qualified file name
+        if not os.path.dirname(filepath):
+            # append local path
+            filepath = os.path.join(os.getcwd(), os.path.basename(filepath))
+        self._api.data_sources_add_domain_file_path_with_key_utf8(
+            self, str(filepath), key, domain_id
+        )
+
     def add_file_path_for_specified_result(self, filepath, key="", result_key=""):
         """Add a file path for a specified result file key to the data sources.
 

src/ansys/dpf/core/data_sources.py

@@ -6,7 +6,9 @@
 The OperatorSpecification Provides a documentation for each Operator
 """
 
+from __future__ import annotations
 import abc
+from typing import Union
 from ansys.dpf.core import server as server_module
 from ansys.dpf.gate import (
     operator_specification_capi,
@@ -58,7 +60,7 @@ class PinSpecification:
     name_derived_class = str
 
     def __init__(
-        self, name, type_names, document="", optional=False, ellipsis=False, name_derived_class=""
+        self, name: str, type_names: list, document="", optional=False, ellipsis=False, name_derived_class=""
     ):
         self.name = name
         self.type_names = type_names
@@ -68,7 +70,7 @@ def __init__(
         self.name_derived_class = name_derived_class
 
     @property
-    def type_names(self):
+    def type_names(self) -> list[str]:
         """
         Returns
         -------
@@ -103,7 +105,7 @@ def type_names(self, val):
         self._type_names = val
 
     @staticmethod
-    def _get_copy(other, changed_types):
+    def _get_copy(other, changed_types) -> PinSpecification:
         return PinSpecification(
             other.name,
             changed_types,
@@ -170,7 +172,7 @@ class ConfigOptionSpec:
     default_value_str: str
     document: str
 
-    def __init__(self, name, type_names, default_value_str, document):
+    def __init__(self, name: str, type_names: list, default_value_str: str, document: str):
         self.name = name
         self.type_names = type_names
         self.default_value_str = default_value_str
@@ -189,17 +191,17 @@ def __repr__(self):
 class SpecificationBase:
     @property
     @abc.abstractmethod
-    def description(self):
+    def description(self) -> Union[str, None]:
         pass
 
     @property
     @abc.abstractmethod
-    def inputs(self):
+    def inputs(self) -> dict:
         pass
 
     @property
     @abc.abstractmethod
-    def outputs(self):
+    def outputs(self) -> dict:
         pass
 
 
@@ -231,7 +233,7 @@ class Specification(SpecificationBase):
     'result file path container, used if no streams are set'
     """
 
-    def __init__(self, operator_name=None, specification=None, server=None):
+    def __init__(self, operator_name: Union[str, None]=None, specification: Union[Specification, None]=None, server: Union[server_module.BaseServer, None]=None):
         # step 1: get server
         self._server = server_module.get_or_create_server(server)
 
@@ -272,9 +274,9 @@ def __str__(self):
         return "Description:\n" + str(self.description) + "\nProperties:\n" + str(self.properties)
 
     @property
-    def properties(self):
-        """Returns some additional properties of the Operator, like the category, the exposure,
-        the scripting and user names and the plugin
+    def properties(self) -> dict:
+        """some additional properties of the Operator, like the category, the exposure,
+        the scripting and user names, and the plugin
 
         Examples
         --------
@@ -498,11 +500,11 @@ class SpecificationProperties:
 
     def __init__(
         self,
-        user_name: str = None,
-        category: str = None,
-        scripting_name: str = None,
+        user_name: Union[str, None] = None,
+        category: Union[str, None] = None,
+        scripting_name: Union[str, None] = None,
         exposure: Exposures = Exposures.public,
-        plugin: str = None,
+        plugin: Union[str, None] = None,
         license: str = None,
         spec=None,
         **kwargs,

src/ansys/dpf/core/operator_specification.py

@@ -68,7 +68,6 @@
 from .qr_solve import qr_solve 
 from .real_part import real_part 
 from .relative_error import relative_error 
-from .sampler import sampler 
 from .scale import scale 
 from .scale_by_field import scale_by_field 
 from .scale_by_field_fc import scale_by_field_fc 
@@ -79,8 +78,6 @@
 from .sqr_fc import sqr_fc 
 from .sqrt import sqrt 
 from .sqrt_fc import sqrt_fc 
-from .stft import stft 
-from .stft_fc import stft_fc 
 from .svd import svd 
 from .sweeping_phase import sweeping_phase 
 from .sweeping_phase_fc import sweeping_phase_fc 

src/ansys/dpf/core/operators/math/__init__.py

@@ -13,13 +13,20 @@
 
 class correlation(Operator):
     """Takes two fields and a weighting and computes their correlation:
-    aMb/(||aMa||.||bMb||).
+    aMb/(||aMa||.||bMb||). If several b fields are provided (via a
+    fields container), correlation is computed for each of them.
 
     Parameters
     ----------
     fieldA : Field or float
+        Field a. the reference field.
     fieldB : Field or FieldsContainer
-    ponderation : Field
+        Field b. if a fields container is provided,
+        correlation is computed for each
+        field.
+    ponderation : Field or FieldsContainer
+        Field m, optional weighting for correclation
+        computation.
 
 
     Examples
@@ -65,41 +72,48 @@ def __init__(
     @staticmethod
     def _spec():
         description = """Takes two fields and a weighting and computes their correlation:
-            aMb/(||aMa||.||bMb||)."""
+            aMb/(||aMa||.||bMb||). If several b fields are provided
+            (via a fields container), correlation is computed for each
+            of them."""
         spec = Specification(
             description=description,
             map_input_pin_spec={
                 0: PinSpecification(
                     name="fieldA",
                     type_names=["field", "double", "vector<double>"],
                     optional=False,
-                    document="""""",
+                    document="""Field a. the reference field.""",
                 ),
                 1: PinSpecification(
                     name="fieldB",
                     type_names=["field", "fields_container"],
                     optional=False,
-                    document="""""",
+                    document="""Field b. if a fields container is provided,
+        correlation is computed for each
+        field.""",
                 ),
                 2: PinSpecification(
                     name="ponderation",
-                    type_names=["field"],
+                    type_names=["field", "fields_container"],
                     optional=False,
-                    document="""""",
+                    document="""Field m, optional weighting for correclation
+        computation.""",
                 ),
             },
             map_output_pin_spec={
                 0: PinSpecification(
                     name="field",
                     type_names=["field"],
                     optional=False,
-                    document="""""",
+                    document="""Correlation factor for each input field b.""",
                 ),
                 1: PinSpecification(
                     name="index",
                     type_names=["int32"],
                     optional=False,
-                    document="""""",
+                    document="""If several b are provided, this output
+        contains the index of the highest
+        correlation factor.""",
                 ),
             },
         )
@@ -171,6 +185,8 @@ def __init__(self, op: Operator):
     def fieldA(self):
         """Allows to connect fieldA input to the operator.
 
+        Field a. the reference field.
+
         Parameters
         ----------
         my_fieldA : Field or float
@@ -189,6 +205,10 @@ def fieldA(self):
     def fieldB(self):
         """Allows to connect fieldB input to the operator.
 
+        Field b. if a fields container is provided,
+        correlation is computed for each
+        field.
+
         Parameters
         ----------
         my_fieldB : Field or FieldsContainer
@@ -207,9 +227,12 @@ def fieldB(self):
     def ponderation(self):
         """Allows to connect ponderation input to the operator.
 
+        Field m, optional weighting for correclation
+        computation.
+
         Parameters
         ----------
-        my_ponderation : Field
+        my_ponderation : Field or FieldsContainer
 
         Examples
         --------