Remove operator name in result info print (#119)

cbellot000 · web-flow · commit 3d773c9fd47c · 2021-11-16T10:30:55.000+01:00
diff --git a/README.md b/README.md
@@ -67,21 +67,20 @@ To open a result file and explore what's inside, do:
 
     DPF Model
     ------------------------------
-    DPF Result Info 
-      Analysis: static 
-      Physics Type: mecanic 
-      Unit system: MKS: m, kg, N, s, V, A, degC 
-      Available results: 
-        U Displacement :nodal displacements 
-        ENF Element nodal Forces :element nodal forces 
-        ENG_VOL Volume :element volume 
-        ENG_SE Energy-stiffness matrix :element energy associated with the stiffness matrix 
-        ENG_AHO Hourglass Energy :artificial hourglass energy 
-        ENG_TH thermal dissipation energy :thermal dissipation energy 
-        ENG_KE Kinetic Energy :kinetic energy 
-        ENG_CO co-energy :co-energy (magnetics) 
-        ENG_INC incremental energy :incremental energy (magnetics) 
-        BFE Temperature :element structural nodal temperatures 
+    Static analysis
+    Unit system: Metric (m, kg, N, s, V, A)
+    Physics Type: Mecanic
+    Available results:
+         -  displacement: Nodal Displacement
+         -  element_nodal_forces: ElementalNodal Element nodal Forces
+         -  elemental_volume: Elemental Volume
+         -  stiffness_matrix_energy: Elemental Energy-stiffness matrix
+         -  artificial_hourglass_energy: Elemental Hourglass Energy
+         -  thermal_dissipation_energy: Elemental thermal dissipation energy
+         -  kinetic_energy: Elemental Kinetic Energy
+         -  co_energy: Elemental co-energy
+         -  incremental_energy: Elemental incremental energy
+         -  structural_temperature: ElementalNodal Temperature
     ------------------------------
     DPF  Meshed Region: 
       3751 nodes 
@@ -92,8 +91,8 @@ To open a result file and explore what's inside, do:
     DPF  Time/Freq Support: 
       Number of sets: 1 
     Cumulative     Time (s)       LoadStep       Substep         
-    1              1.000000       1              1       
-    
+    1              1.000000       1              1               
+
 
 ```
 
diff --git a/ansys/dpf/core/available_result.py b/ansys/dpf/core/available_result.py
@@ -134,6 +134,11 @@ def native_scoping_location(self):
         else:
             return loc
 
+    @property
+    def physical_name(self) -> str:
+        """Name of the result with spaces"""
+        return self._message.physicsname
+
 
 _result_properties = {
     "S": {"location": "ElementalNodal", "scripting_name": "stress"},
diff --git a/ansys/dpf/core/result_info.py b/ansys/dpf/core/result_info.py
@@ -73,17 +73,21 @@ def __init__(self, result_info, server=None):
             self._message = result_info
 
     def __str__(self):
-        txt = (
-            "%s analysis\n" % self.analysis_type.capitalize()
-            + "Unit system: %s\n" % self.unit_system
-            + "Physics Type: %s\n" % self.physics_type.capitalize()
-            + "Available results:\n"
-        )
-        for res in self.available_results:
-            line = ["", "-", res.name]
-            txt += "{0:^4} {1:^2} {2:<30}".format(*line) + "\n"
-
-        return txt
+        try:
+            txt = (
+                "%s analysis\n" % self.analysis_type.capitalize()
+                + "Unit system: %s\n" % self.unit_system
+                + "Physics Type: %s\n" % self.physics_type.capitalize()
+                + "Available results:\n"
+            )
+            for res in self.available_results:
+                line = ["", "-", f'{res.name}: {res.native_location} {res.physical_name}']
+                txt += "{0:^4} {1:^2} {2:<30}".format(*line) + "\n"
+
+            return txt
+        except:
+            from ansys.dpf.core.core import _description
+            return _description(self._message, self._server)
 
     @property
     def _names(self):
@@ -308,17 +312,6 @@ def _connect(self):
         """Connect to the gRPC service containing the reader."""
         return result_info_pb2_grpc.ResultInfoServiceStub(self._server.channel)
 
-    def __str__(self):
-        """Describe the entity.
-
-        Returns
-        -------
-        description : str
-        """
-        from ansys.dpf.core.core import _description
-
-        return _description(self._message, self._server)
-
     def __del__(self):
         try:
             self._stub.Delete(self._message)
diff --git a/docs/source/_static/simple_example.rst b/docs/source/_static/simple_example.rst
@@ -18,32 +18,31 @@ extracting results from it is easy:
 
     DPF Model
     ------------------------------
-    DPF Result Info 
-      Analysis: static 
-      Physics Type: mecanic 
-      Unit system: MKS: m, kg, N, s, V, A, degC 
-      Available results: 
-        U Displacement :nodal displacements 
-        ENF Element nodal Forces :element nodal forces 
-        ENG_VOL Volume :element volume 
-        ENG_SE Energy-stiffness matrix :element energy associated with the stiffness matrix 
-        ENG_AHO Hourglass Energy :artificial hourglass energy 
-        ENG_TH thermal dissipation energy :thermal dissipation energy 
-        ENG_KE Kinetic Energy :kinetic energy 
-        ENG_CO co-energy :co-energy (magnetics) 
-        ENG_INC incremental energy :incremental energy (magnetics) 
-        BFE Temperature :element structural nodal temperatures 
+    Static analysis
+    Unit system: Metric (m, kg, N, s, V, A)
+    Physics Type: Mecanic
+    Available results:
+         -  displacement: Nodal Displacement
+         -  element_nodal_forces: ElementalNodal Element nodal Forces
+         -  elemental_volume: Elemental Volume
+         -  stiffness_matrix_energy: Elemental Energy-stiffness matrix
+         -  artificial_hourglass_energy: Elemental Hourglass Energy
+         -  thermal_dissipation_energy: Elemental thermal dissipation energy
+         -  kinetic_energy: Elemental Kinetic Energy
+         -  co_energy: Elemental co-energy
+         -  incremental_energy: Elemental incremental energy
+         -  structural_temperature: ElementalNodal Temperature
     ------------------------------
-    DPF  Meshed Region: 
-      3751 nodes 
-      3000 elements 
-      Unit: m 
+    DPF  Meshed Region:
+      3751 nodes
+      3000 elements
+      Unit: m
       With solid (3D) elements
     ------------------------------
-    DPF  Time/Freq Support: 
-      Number of sets: 1 
-    Cumulative     Time (s)       LoadStep       Substep         
-    1              1.000000       1              1               
+    DPF  Time/Freq Support:
+      Number of sets: 1
+    Cumulative     Time (s)       LoadStep       Substep
+    1              1.000000       1              1
     
 
 .. code-block:: default
diff --git a/docs/source/getting_started/index.rst b/docs/source/getting_started/index.rst
@@ -48,32 +48,31 @@ For a quick tryout installation, use:
 
     DPF Model
     ------------------------------
-    DPF Result Info 
-      Analysis: static 
-      Physics Type: mecanic 
-      Unit system: MKS: m, kg, N, s, V, A, degC 
-      Available results: 
-        U Displacement :nodal displacements 
-        ENF Element nodal Forces :element nodal forces 
-        ENG_VOL Volume :element volume 
-        ENG_SE Energy-stiffness matrix :element energy associated with the stiffness matrix 
-        ENG_AHO Hourglass Energy :artificial hourglass energy 
-        ENG_TH thermal dissipation energy :thermal dissipation energy 
-        ENG_KE Kinetic Energy :kinetic energy 
-        ENG_CO co-energy :co-energy (magnetics) 
-        ENG_INC incremental energy :incremental energy (magnetics) 
-        BFE Temperature :element structural nodal temperatures 
+    Static analysis
+    Unit system: Metric (m, kg, N, s, V, A)
+    Physics Type: Mecanic
+    Available results:
+         -  displacement: Nodal Displacement
+         -  element_nodal_forces: ElementalNodal Element nodal Forces
+         -  elemental_volume: Elemental Volume
+         -  stiffness_matrix_energy: Elemental Energy-stiffness matrix
+         -  artificial_hourglass_energy: Elemental Hourglass Energy
+         -  thermal_dissipation_energy: Elemental thermal dissipation energy
+         -  kinetic_energy: Elemental Kinetic Energy
+         -  co_energy: Elemental co-energy
+         -  incremental_energy: Elemental incremental energy
+         -  structural_temperature: ElementalNodal Temperature
     ------------------------------
-    DPF  Meshed Region: 
-      3751 nodes 
-      3000 elements 
-      Unit: m 
+    DPF  Meshed Region:
+      3751 nodes
+      3000 elements
+      Unit: m
       With solid (3D) elements
     ------------------------------
-    DPF  Time/Freq Support: 
-      Number of sets: 1 
-    Cumulative     Time (s)       LoadStep       Substep         
-    1              1.000000       1              1               
+    DPF  Time/Freq Support:
+      Number of sets: 1
+    Cumulative     Time (s)       LoadStep       Substep
+    1              1.000000       1              1
     
 
 
diff --git a/docs/source/user_guide/model.rst b/docs/source/user_guide/model.rst
@@ -37,32 +37,31 @@ To undestand what is available in the result file, you can print the model
 
     DPF Model
     ------------------------------
-    DPF Result Info 
-      Analysis: static 
-      Physics Type: mecanic 
-      Unit system: MKS: m, kg, N, s, V, A, degC 
-      Available results: 
-        U Displacement :nodal displacements 
-        ENF Element nodal Forces :element nodal forces 
-        ENG_VOL Volume :element volume 
-        ENG_SE Energy-stiffness matrix :element energy associated with the stiffness matrix 
-        ENG_AHO Hourglass Energy :artificial hourglass energy 
-        ENG_TH thermal dissipation energy :thermal dissipation energy 
-        ENG_KE Kinetic Energy :kinetic energy 
-        ENG_CO co-energy :co-energy (magnetics) 
-        ENG_INC incremental energy :incremental energy (magnetics) 
-        BFE Temperature :element structural nodal temperatures 
+    Static analysis
+    Unit system: Metric (m, kg, N, s, V, A)
+    Physics Type: Mecanic
+    Available results:
+         -  displacement: Nodal Displacement
+         -  element_nodal_forces: ElementalNodal Element nodal Forces
+         -  elemental_volume: Elemental Volume
+         -  stiffness_matrix_energy: Elemental Energy-stiffness matrix
+         -  artificial_hourglass_energy: Elemental Hourglass Energy
+         -  thermal_dissipation_energy: Elemental thermal dissipation energy
+         -  kinetic_energy: Elemental Kinetic Energy
+         -  co_energy: Elemental co-energy
+         -  incremental_energy: Elemental incremental energy
+         -  structural_temperature: ElementalNodal Temperature
     ------------------------------
-    DPF  Meshed Region: 
-      3751 nodes 
-      3000 elements 
-      Unit: m 
+    DPF  Meshed Region:
+      3751 nodes
+      3000 elements
+      Unit: m
       With solid (3D) elements
     ------------------------------
-    DPF  Time/Freq Support: 
-      Number of sets: 1 
-    Cumulative     Time (s)       LoadStep       Substep         
-    1              1.000000       1              1               
+    DPF  Time/Freq Support:
+      Number of sets: 1
+    Cumulative     Time (s)       LoadStep       Substep
+    1              1.000000       1              1
     
 
 
@@ -157,35 +156,21 @@ To view available results, print them:
 
  .. code-block:: none
  
- DPF Result Information
- 
-  Analysis: static 
-  
-  Physics Type: mecanic 
-  
-  Unit system: MKS: m, kg, N, s, V, A, degC 
-  Available results: 
-  
-    U Displacement :nodal displacements 
-    
-    ENF Element nodal Forces :element nodal forces 
-    
-    ENG_VOL Volume :element volume 
-    
-    ENG_SE Energy-stiffness matrix :element energy associated with the stiffness matrix 
-    
-    ENG_AHO Hourglass Energy :artificial hourglass energy 
-    
-    ENG_TH thermal dissipation energy :thermal dissipation energy 
-    
-    ENG_KE Kinetic Energy :kinetic energy 
-    
-    ENG_CO co-energy :co-energy (magnetics) 
-    
-    ENG_INC incremental energy :incremental energy (magnetics) 
-    
-    BFE Temperature :element structural nodal temperatures 
-        
+    Static analysis
+    Unit system: Metric (m, kg, N, s, V, A)
+    Physics Type: Mecanic
+    Available results:
+         -  displacement: Nodal Displacement
+         -  element_nodal_forces: ElementalNodal Element nodal Forces
+         -  elemental_volume: Elemental Volume
+         -  stiffness_matrix_energy: Elemental Energy-stiffness matrix
+         -  artificial_hourglass_energy: Elemental Hourglass Energy
+         -  thermal_dissipation_energy: Elemental thermal dissipation energy
+         -  kinetic_energy: Elemental Kinetic Energy
+         -  co_energy: Elemental co-energy
+         -  incremental_energy: Elemental incremental energy
+         -  structural_temperature: ElementalNodal Temperature
+
 
 .. autoattribute:: ansys.dpf.core.model.Model.results
   :noindex:
diff --git a/tests/test_model.py b/tests/test_model.py
@@ -57,7 +57,7 @@ def test_kinetic(static_model):
 
 
 def test_str_model(static_model):
-    assert "Physics Type: mecanic" in str(static_model)
+    assert "Static" in str(static_model)
     assert "81" in str(static_model)
     assert "Unit: m" in str(static_model)
 
diff --git a/tests/test_resultinfo.py b/tests/test_resultinfo.py
@@ -22,7 +22,7 @@ def test_get_resultinfo_no_model(velocity_acceleration):
 
 def test_get_resultinfo(model):
     res = model.metadata.result_info
-    assert "Analysis: static" in str(res)
+    assert "Static analysis" in str(res)
     assert res.analysis_type == "static"
     assert res.n_results == 14
     assert res.unit_system == "Metric (m, kg, N, s, V, A)"
