doc(tutorials): data structures - fields

doc/source/user_guide/tutorials/data_structures/index.rst

@@ -20,23 +20,29 @@ These tutorials explains how these structures work and how you can manipulate da
     :padding: 2
     :margin: 2
 
-    .. grid-item-card:: DPF raw data storage structures
-       :link: ref_tutorials
+    .. grid-item-card:: Data arrays - Fields
+       :link: ref_tutorials_data_arrays
        :link-type: ref
        :text-align: center
 
-       This tutorial shows how to create and work with some DPF data arrays:
-       Field, StringField and PropertyField
+       This tutorial shows how to create and work with data arrays in PyDPF-Core.
 
 
     .. grid-item-card:: DPF collections
        :link: ref_tutorials_language_and_usage
        :link-type: ref
        :text-align: center
+       :class-header: sd-bg-light sd-text-dark
+       :class-footer: sd-bg-light sd-text-dark
 
        This tutorial shows how to create and work with some DPF collections:
-       FieldsContainer, MeshesContainer and ScopingContainer
+       FieldsContainer, MeshesContainer and ScopingsContainer
+
+       +++
+       Coming soon
 
 .. toctree::
     :maxdepth: 2
     :hidden:
+
+    data_arrays.rst

doc/source/user_guide/tutorials/import_data/import_result_file.rst

@@ -278,8 +278,10 @@ inputs for PyDPF-Core APIs.
 Use a |Model|
 -------------
 
-The |Model| is a helper designed to give shortcuts to access the analysis results
-metadata and to instanciate results providers by opening a |DataSources| or a Streams.
+The :class:`Model <ansys.dpf.core.model.Model>` class creates and evaluates common readers for the files it is given,
+such as a mesh provider, a result info provider, and a streams provider.
+It provides dynamically built methods to extract the results available in the files, as well as many shortcuts
+to facilitate exploration of the available data.
 
 To create a |Model| you can provide to the *'data_sources'* argument.:
 

doc/source/user_guide/tutorials/post_processing_basics/01-main-steps.rst

@@ -3,7 +3,7 @@
 Postprocessing main steps
 -------------------------
 
-There are five main steps to transform simulation data into output data that can
+There are four main steps to transform simulation data into output data that can
 be used to visualize and analyze simulation results:
 
 .. grid::
@@ -39,17 +39,10 @@ be used to visualize and analyze simulation results:
 
        Visualize the data
 
-    .. grid-item-card:: 5
-       :link: tutorials_main_steps_5
-       :link-type: ref
-       :text-align: center
-
-       Export data
-
 .. _tutorials_main_steps_1:
 
-1- Importing and opening results files
-**************************************
+1- Import and open results files
+********************************
 
 First, import the DPF-Core module as ``dpf`` and import the included examples file
 
@@ -68,8 +61,10 @@ data inputs for DPF and define their locations.
    my_data_sources = dpf.DataSources(result_path=examples.find_simple_bar())
 
 
-The model is a helper designed to give shortcuts to access the analysis results
-metadata, by opening a DataSources or a Streams, and to instanciate results provider for it.
+The :class:`Model <ansys.dpf.core.model.Model>` class creates and evaluates common readers for the files it is given,
+such as a mesh provider, a result info provider, and a streams provider.
+It provides dynamically built methods to extract the results available in the files, as well as many shortcuts
+to facilitate exploration of the available data.
 
 Printing the model displays:
 
@@ -192,8 +187,3 @@ Plot the transformed displacement results
     :hide-code:
 
     my_model.metadata.meshed_region.plot(field_or_fields_container=my_displacements)
-
-.. _tutorials_main_steps_5:
-
-5- Extract the data
-*******************

src/ansys/dpf/core/dimensionality.py

@@ -67,6 +67,8 @@ def __init__(self, dim_vec=None, nature: natures = natures.vector):
                 self.dim = [3, 3]
             elif self.nature == natures.scalar:
                 self.dim = [1]
+            elif self.nature == natures.matrix:
+                self.dim = [3, 3]
 
     def is_1d_dim(self):
         """Check if dimensionality is 1."""

src/ansys/dpf/core/field.py

@@ -50,6 +50,7 @@
 from ansys.dpf.gate.errors import DPFServerException
 
 if TYPE_CHECKING:  # pragma: nocover
+    from ansys.dpf.core.dimensionality import Dimensionality
     from ansys.dpf.core.dpf_operator import Operator
     from ansys.dpf.core.meshed_region import MeshedRegion
     from ansys.dpf.core.results import Result
@@ -442,7 +443,7 @@ def get_entity_data_by_id(self, id: int) -> dpf_array.DPFArray:
             data.shape = (data.size // n_comp, n_comp)
         return data
 
-    def append(self, data, scopingid):
+    def append(self, data: float | list[float] | np.ndarray[np.float64], scopingid: int):
         """Append data to the Field."""
         if isinstance(data, list):
             if isinstance(data[0], list):
@@ -520,7 +521,7 @@ def to_nodal(self):
     def plot(
         self,
         shell_layers: eshell_layers = None,
-        deform_by: Union[Field, Result, Operator] = None,
+        deform_by: Field | Result | Operator = None,
         scale_factor: float = 1.0,
         meshed_region: MeshedRegion = None,
         **kwargs,
@@ -675,7 +676,7 @@ def dimensionality(self):
             return self.field_definition.dimensionality
 
     @dimensionality.setter
-    def dimensionality(self, value):
+    def dimensionality(self, value: Dimensionality):
         fielddef = self.field_definition
         fielddef.dimensionality = value
         self.field_definition = fielddef

src/ansys/dpf/core/field_definition.py

@@ -262,7 +262,7 @@ def shell_layers(self, value):
         self._api.csfield_definition_set_shell_layers(self, value)
 
     @dimensionality.setter
-    def dimensionality(self, value):
+    def dimensionality(self, value: Dimensionality):
         if not isinstance(value, Dimensionality):
             raise TypeError("the dimensionality needs to be of type Dimensionality")
         self._api.csfield_definition_set_dimensionality(