doc: modified more files.

Author: moe-ad

src/ansys/dpf/core/ipconfig.py

@@ -19,6 +19,7 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
+"""Provides for retrieving local ip address."""
 
 import socket
 

src/ansys/dpf/core/label_space.py

@@ -35,6 +35,8 @@
 
 
 class LabelSpace:
+    """A class representing a label space, which allows storage and management of key-value pairs (labels)."""
+
     def __init__(self, label_space=None, obj=None, server=None):
         # ############################
         # step 1: get server
@@ -68,13 +70,42 @@ def _data_processing_core_api(self):
         return core_api
 
     def fill(self, label_space: Dict[str, int]):
+        """
+        Fill the label space with the provided dictionary of labels.
+
+        Parameters
+        ----------
+        label_space : dict
+            A dictionary where keys are labels (str) and values are indices (int) to be added to the label space.
+
+        Returns
+        -------
+        None
+            This method does not return anything, it modifies the internal label space.
+        """
         for key, index in label_space.items():
             self._api.label_space_add_data(self, key, index)
 
     def __str__(self):
+        """
+        Return a string representation of the LabelSpace instance.
+
+        Returns
+        -------
+        str
+            A string representation of the label space, formatted as a dictionary.
+        """
         return str(dict(self))
 
     def __iter__(self):
+        """
+        Iterate over the labels in the label space, yielding (key, value) pairs.
+
+        Yields
+        ------
+        tuple
+            A tuple of (key, value) for each label in the label space.
+        """
         yield from [
             (
                 self._api.label_space_get_labels_name(self, i),
@@ -84,6 +115,14 @@ def __iter__(self):
         ]
 
     def __dict__(self):
+        """
+        Return a dictionary representation of the LabelSpace instance.
+
+        Returns
+        -------
+        dict
+            A dictionary where keys are label names (str) and values are label indices (int).
+        """
         if isinstance(self._internal_obj, dict):
             return self._internal_obj
         out = {}
@@ -95,6 +134,13 @@ def __dict__(self):
         return out
 
     def __del__(self):
+        """
+        Destructor for cleaning up the label space resources.
+
+        Returns
+        -------
+        None
+        """
         try:
             self._deleter_func[0](self._deleter_func[1](self))
         except:

src/ansys/dpf/core/log.py

@@ -19,6 +19,7 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
+"""Provides for setting up logging."""
 
 import logging
 

src/ansys/dpf/core/mapping_types.py

@@ -19,6 +19,7 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
+"""Provides utilities for mapping and transforming data types between Python and C++ representations."""
 
 import sys
 import inspect

src/ansys/dpf/core/mesh_info.py

@@ -20,10 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-"""
-MeshInfo
-
-"""
+"""MeshInfo."""
 
 from ansys.dpf.core import server as server_module
 from ansys.dpf.core.generic_data_container import GenericDataContainer
@@ -66,7 +63,7 @@ def __init__(
         mesh_info=None,
         server=None,
     ):
-        """Initialize with a MeshInfo message"""
+        """Initialize with a MeshInfo message."""
         # ############################
         # step 1: get server
 
@@ -90,6 +87,14 @@ def __init__(
         self._bodies_map = None
 
     def __str__(self):
+        """
+        Return a string representation of the MeshInfo instance.
+
+        Returns
+        -------
+        str
+            A string representation of the information about a mesh space.
+        """
         txt = "DPF MeshInfo\n"
         txt += "-" * 30 + "\n"
         txt += "with properties:\n"
@@ -101,8 +106,7 @@ def __str__(self):
 
     @property
     def generic_data_container(self) -> GenericDataContainer:
-        """GenericDataContainer wrapped into the MeshInfo
-        that contains all the relative information of the derived class.
+        """GenericDataContainer wrapped into the MeshInfo that contains all the relative information of the derived class.
 
         Returns
         -------
@@ -113,9 +117,7 @@ def generic_data_container(self) -> GenericDataContainer:
 
     @generic_data_container.setter
     def generic_data_container(self, value: GenericDataContainer):
-        """GenericDataContainer wrapped into the MeshInfo
-        that contains all the relative information of the derived class.
-        """
+        """GenericDataContainer wrapped into the MeshInfo that contains all the relative information of the derived class."""
         if not isinstance(value, GenericDataContainer):
             raise ValueError("Input value must be a GenericDataContainer.")
         self._generic_data_container = value
@@ -169,7 +171,8 @@ def set_property(self, property_name, prop):
 
     @property
     def number_nodes(self):
-        """
+        """Returns number of nodes in the mesh.
+
         Returns
         -------
         number_nodes : int
@@ -179,7 +182,8 @@ def number_nodes(self):
 
     @property
     def number_faces(self):
-        """
+        """Returns number of faces in the mesh.
+
         Returns
         -------
         number_faces : int
@@ -192,7 +196,8 @@ def number_faces(self):
 
     @property
     def number_elements(self):
-        """
+        """Returns number of elements in the mesh.
+
         Returns
         -------
         number_elements : int
@@ -205,7 +210,8 @@ def number_elements(self):
 
     @property
     def splittable_by(self):
-        """
+        """Return name of properties according to which the mesh can be split by.
+
         Returns
         -------
         splittable by which entity : StringField
@@ -218,7 +224,8 @@ def splittable_by(self):
 
     @property
     def available_elem_types(self):
-        """
+        """Returns available mesh element types.
+
         Returns
         -------
         available element types : Scoping
@@ -231,7 +238,8 @@ def available_elem_types(self):
 
     @property
     def part_names(self):
-        """
+        """Return part names of the mesh.
+
         Returns
         -------
         part_names : StringField
@@ -267,7 +275,8 @@ def parts(self) -> dict:
 
     @property
     def part_scoping(self):
-        """
+        """Return part scoping of the mesh.
+
         Returns
         -------
         part_scoping : Scoping
@@ -283,7 +292,8 @@ def part_scoping(self):
 
     @property
     def body_names(self):
-        """
+        """Return body names of the mesh.
+
         Returns
         -------
         body_names : StringField
@@ -296,7 +306,8 @@ def body_names(self):
 
     @property
     def body_scoping(self):
-        """
+        """Return body scoping of the mesh.
+
         Returns
         -------
         body_scoping : Scoping
@@ -332,7 +343,8 @@ def bodies(self) -> dict:
 
     @property
     def zone_names(self):
-        """
+        """Return zone names of the mesh.
+
         Returns
         -------
         zone_names : StringField
@@ -423,7 +435,8 @@ def cell_zones(self) -> dict:
 
     @property
     def zone_scoping(self):
-        """
+        """Return zone scoping of the mesh.
+
         Returns
         -------
         zone_scoping : Scoping
@@ -439,20 +452,20 @@ def zone_scoping(self):
 
     @number_nodes.setter
     def number_nodes(self, value):
-        """Set the number of nodes in the mesh"""
+        """Set the number of nodes in the mesh."""
         self.generic_data_container.set_property("num_nodes", value)
 
     @number_elements.setter
     def number_elements(self, value):
-        """Set the number of elements in the mesh"""
+        """Set the number of elements in the mesh."""
         self.generic_data_container.set_property("num_elements", value)
 
     @splittable_by.setter
     def splittable_by(self, value):
-        """Set name of the properties according to which the mesh can be split by"""
+        """Set name of the properties according to which the mesh can be split by."""
         self.generic_data_container.set_property("splittable_by", value)
 
     @available_elem_types.setter
     def available_elem_types(self, value):
-        """Set the available element types"""
+        """Set the available element types."""
         self.generic_data_container.set_property("available_elem_types", value)

src/ansys/dpf/core/mesh_scoping_factory.py

@@ -21,7 +21,7 @@
 # SOFTWARE.
 
 """
-mesh_scoping_factory
+mesh_scoping_factory.
 
 Contains functions to simplify creating mesh scopings.
 """