Mv StagyyData.scale to Scales.make_dimensional

Author: amorison

docs/sources/apiref/phyvars.rst

@@ -56,4 +56,4 @@ phyvars
 
       Dictionary mapping dimension strings (**dim** fields in ``Var*``) to
       functions which are themselves mapping from
-      :class:`~stagpy.stagyydata.StagyyData` to the scale for that dimension.
+      :class:`~stagpy.dimensions.Scales` to the scale for that dimension.

stagpy/datatypes.py

@@ -13,8 +13,7 @@
 class Varf:
     """Metadata of scalar field.
 
-    `dim` is the dimension used to :func:`~stagpy.stagyydata.StagyyData.scale` to
-    dimensional values.
+    `dim` is the dimension used to scale to dimensional values.
     """
 
     description: str
@@ -33,8 +32,7 @@ class Field:
 class Varr:
     """Metadata of radial profiles.
 
-    `dim` is the dimension used to :func:`~stagpy.stagyydata.StagyyData.scale` to
-    dimensional values.
+    `dim` is the dimension used to scale to dimensional values.
     """
 
     description: str
@@ -55,8 +53,7 @@ class Rprof:
 class Vart:
     """Metadata of time series.
 
-    `dim` is the dimension used to :func:`~stagpy.stagyydata.StagyyData.scale` to
-    dimensional values.
+    `dim` is the dimension used to scale to dimensional values.
     """
 
     description: str

stagpy/dimensions.py

@@ -4,10 +4,19 @@
 from dataclasses import dataclass
 from functools import cached_property
 
+from . import phyvars
+from .config import Scaling
+
 if typing.TYPE_CHECKING:
+    from typing import TypeVar
+
+    from numpy.typing import NDArray
+
     from .parfile import StagyyPar
     from .stagyydata import StagyyData
 
+    T = TypeVar("T", float, NDArray)
+
 
 @dataclass(frozen=True)
 class Scales:
@@ -19,6 +28,23 @@ class Scales:
     def par(self) -> StagyyPar:
         return self.sdat.par
 
+    def make_dimensional(self, data: T, unit: str, scaling: Scaling) -> tuple[T, str]:
+        """Scale quantity to obtain dimensional quantity."""
+        if self.par.get("switches", "dimensional_units", True) or unit == "1":
+            return data, ""
+        scale = phyvars.SCALES[unit](self)
+        factor = scaling.factors.get(unit, " ")
+        if scaling.time_in_y and unit == "s":
+            scale /= scaling.yearins
+            unit = "yr"
+        elif scaling.vel_in_cmpy and unit == "m/s":
+            scale *= 100 * scaling.yearins
+            unit = "cm/y"
+        if factor in phyvars.PREFIXES:
+            scale *= 10 ** (-3 * (phyvars.PREFIXES.index(factor) + 1))
+            unit = factor + unit
+        return data * scale, unit
+
     @cached_property
     def length(self) -> float:
         """Length in m."""

stagpy/stagyydata.py

@@ -795,42 +795,6 @@ def nfields_max(self, nfields: Optional[int]) -> None:
             raise error.InvalidNfieldsError(nfields)
         self._nfields_max = nfields
 
-    @typing.overload
-    def scale(self, data: ndarray, unit: str) -> Tuple[ndarray, str]:
-        """Scale a ndarray."""
-        ...
-
-    @typing.overload
-    def scale(self, data: float, unit: str) -> Tuple[float, str]:
-        """Scale a float."""
-        ...
-
-    def scale(
-        self, data: Union[ndarray, float], unit: str
-    ) -> Tuple[Union[ndarray, float], str]:
-        """Scales quantity to obtain dimensionful quantity.
-
-        Args:
-            data: the quantity that should be scaled.
-            unit: the dimension of data as defined in phyvars.
-        Return:
-            scaled quantity and unit string.
-        """
-        if self.par.get("switches", "dimensional_units", True) or unit == "1":
-            return data, ""
-        scaling = phyvars.SCALES[unit](self.scales)
-        factor = conf.scaling.factors.get(unit, " ")
-        if conf.scaling.time_in_y and unit == "s":
-            scaling /= conf.scaling.yearins
-            unit = "yr"
-        elif conf.scaling.vel_in_cmpy and unit == "m/s":
-            scaling *= 100 * conf.scaling.yearins
-            unit = "cm/y"
-        if factor in phyvars.PREFIXES:
-            scaling *= 10 ** (-3 * (phyvars.PREFIXES.index(factor) + 1))
-            unit = factor + unit
-        return data * scaling, unit
-
     def filename(
         self,
         fname: str,