Fix temperature difference edge case

fkleedorfer · fkleedorfer · commit acceea253ce7 · 2024-03-17T14:06:26.000+01:00
diff --git a/qudtlib-data-gen/src/main/resources/add-to-quantitykinds.ttl b/qudtlib-data-gen/src/main/resources/add-to-quantitykinds.ttl
@@ -29,4 +29,6 @@ quantitykind:SecondAxialMomentOfArea qudt:applicableUnit unit:CentiM4 .
 
 quantitykind:Viscosity qudt:applicableUnit unit:DecaPOISE .
 
-quantitykind:DynamicViscosity qudt:applicableUnit unit:DecaPOISE .
+quantitykind:DynamicViscosity qudt:applicableUnit unit:DecaPOISE .
+
+quantitykind:SpecificHeatCapacity qudt:applicableUnit unit:KiloJ-PER-KiloGM-K .
diff --git a/qudtlib-data-gen/src/main/resources/add-to-units.ttl b/qudtlib-data-gen/src/main/resources/add-to-units.ttl
@@ -67,7 +67,7 @@ unit:DecaPOISE a qudt:Unit;
   rdfs:isDefinedBy <http://qudt.org/2.1/vocab/unit>;
   qudt:applicableSystem sou:CGS-GAUSS, sou:CGS;
   qudt:hasQuantityKind quantitykind:Viscosity, quantitykind:DynamicViscosity;
-  qudt:conversionMultiplier 10.0;
+  qudt:conversionMultiplier 1.0;
   qudt:hasDimensionVector <http://qudt.org/vocab/dimensionvector/A0E0L-1I0M1H0T-1D0>;
   qudt:symbol "daP";
   qudt:ucumCode "daP"^^qudt:UCUMcs;
diff --git a/qudtlib-data-gen/src/main/resources/si-base-units.ttl b/qudtlib-data-gen/src/main/resources/si-base-units.ttl
@@ -189,8 +189,8 @@ unit:R
     ] .
 
 unit:L qudt:factorUnit [
-    qudt:unit unit:DeciM;
-    qudt:exponent 3
+    qudt:unit unit:DeciM3;
+    qudt:exponent 1
 ] .
 
 unit:PSI
diff --git a/qudtlib-main/src/main/java/io/github/qudtlib/Qudt.java b/qudtlib-main/src/main/java/io/github/qudtlib/Qudt.java
@@ -920,7 +920,22 @@ public static QuantityValue quantityValue(BigDecimal value, Unit unit) {
      */
     public static QuantityValue convert(QuantityValue from, Unit toUnit)
             throws InconvertibleQuantitiesException {
-        return from.convert(toUnit);
+        return convert(from, toUnit, null);
+    }
+
+    /**
+     * Convert the specified {@link QuantityValue} <code>from</code> into the specified target
+     * {@link Unit} <code>toUnit</code>.
+     *
+     * @param from the quantity value to convert
+     * @param toUnit the target unit
+     * @param quantityKind optional quantity kind for handling edge cases (temperature difference)
+     * @return a new {@link QuantityValue} object holding the result.
+     * @throws InconvertibleQuantitiesException if the conversion is not possible
+     */
+    public static QuantityValue convert(QuantityValue from, Unit toUnit, QuantityKind quantityKind)
+            throws InconvertibleQuantitiesException {
+        return from.convert(toUnit, quantityKind);
     }
 
     /**
@@ -969,6 +984,23 @@ public static BigDecimal convert(BigDecimal fromValue, String fromUnitIri, Strin
      */
     public static BigDecimal convert(BigDecimal fromValue, Unit fromUnit, Unit toUnit)
             throws InconvertibleQuantitiesException {
+        return convert(fromValue, fromUnit, toUnit, null);
+    }
+
+    /**
+     * Convert the specified <code>fromValue</code>, interpreted to be in the {@link Unit} <code>
+     * fromUnit</code> into the unit <code>toUnit</code>.
+     *
+     * @param fromValue the value to convert
+     * @param fromUnit the unit of the <code>value</code>
+     * @param toUnit the target unit
+     * @param quantityKind optional quantity kind for handling edge cases (temperature difference)
+     * @return the resulting value
+     * @throws InconvertibleQuantitiesException if the conversion is not possible
+     */
+    public static BigDecimal convert(
+            BigDecimal fromValue, Unit fromUnit, Unit toUnit, QuantityKind quantityKind)
+            throws InconvertibleQuantitiesException {
         return fromUnit.convert(fromValue, toUnit);
     }
 
diff --git a/qudtlib-model/src/main/java/io/github/qudtlib/model/QuantityValue.java b/qudtlib-model/src/main/java/io/github/qudtlib/model/QuantityValue.java
@@ -37,7 +37,18 @@ public boolean equals(Object o) {
     }
 
     public QuantityValue convert(Unit toUnit) throws InconvertibleQuantitiesException {
-        return new QuantityValue(this.unit.convert(this.value, toUnit), toUnit);
+        return convert(toUnit, null);
+    }
+
+    /**
+     * @param toUnit
+     * @param quantityKind optional quantity kind for handling edge cases
+     * @return
+     * @throws InconvertibleQuantitiesException
+     */
+    public QuantityValue convert(Unit toUnit, QuantityKind quantityKind)
+            throws InconvertibleQuantitiesException {
+        return new QuantityValue(this.unit.convert(this.value, toUnit, quantityKind), toUnit);
     }
 
     @Override
diff --git a/qudtlib-model/src/main/java/io/github/qudtlib/model/Unit.java b/qudtlib-model/src/main/java/io/github/qudtlib/model/Unit.java
@@ -18,6 +18,7 @@
  * @version 1.0
  */
 public class Unit extends SelfSmuggler {
+    private static final String TEMPERATURE_DIFFERENCE = "TemperatureDifference";
 
     public static Definition definition(String iri) {
         return new Definition(iri);
@@ -329,8 +330,30 @@ public QuantityValue convertToQuantityValue(BigDecimal value, Unit toUnit) {
 
     public BigDecimal convert(BigDecimal value, Unit toUnit)
             throws InconvertibleQuantitiesException {
+        return convert(value, toUnit, null);
+    }
+
+    /**
+     * Convert method allowing for special handling depending on the specified quantity kind.
+     * Introduced to ignore the offset when converting a temperature difference.
+     *
+     * @param value
+     * @param toUnit
+     * @param quantityKind optional quantity kind for handling edge cases. Pass null for normal
+     *     conversion.
+     * @return
+     * @throws InconvertibleQuantitiesException
+     */
+    public BigDecimal convert(BigDecimal value, Unit toUnit, QuantityKind quantityKind)
+            throws InconvertibleQuantitiesException {
         Objects.requireNonNull(value);
         Objects.requireNonNull(toUnit);
+        boolean ignoreOffset = false;
+        if (quantityKind != null) {
+            if (quantityKind.getIriLocalname().equals(TEMPERATURE_DIFFERENCE)) {
+                ignoreOffset = true;
+            }
+        }
         if (this.equals(toUnit)) {
             return value;
         }
@@ -343,9 +366,13 @@ public BigDecimal convert(BigDecimal value, Unit toUnit)
                             "Cannot convert from %s to %s: dimension vectors differ",
                             this.getIri(), toUnit.getIri()));
         }
-        BigDecimal fromOffset = this.getConversionOffset().orElse(BigDecimal.ZERO);
+        BigDecimal fromOffset =
+                ignoreOffset ? BigDecimal.ZERO : this.getConversionOffset().orElse(BigDecimal.ZERO);
         BigDecimal fromMultiplier = this.getConversionMultiplier().orElse(BigDecimal.ONE);
-        BigDecimal toOffset = toUnit.getConversionOffset().orElse(BigDecimal.ZERO);
+        BigDecimal toOffset =
+                ignoreOffset
+                        ? BigDecimal.ZERO
+                        : toUnit.getConversionOffset().orElse(BigDecimal.ZERO);
         BigDecimal toMultiplier = toUnit.getConversionMultiplier().orElse(BigDecimal.ONE);
         return value.add(fromOffset)
                 .multiply(fromMultiplier, MathContext.DECIMAL128)
diff --git a/qudtlib-test/src/test/java/io/github/qudtlib/QudtTests.java b/qudtlib-test/src/test/java/io/github/qudtlib/QudtTests.java
@@ -1,5 +1,6 @@
 package io.github.qudtlib;
 
+import static io.github.qudtlib.model.QuantityKinds.TemperatureDifference;
 import static io.github.qudtlib.model.Units.*;
 import static org.junit.jupiter.api.Assertions.*;
 
@@ -499,6 +500,29 @@ public void testConvert_Celsius_to_Fahrenheit() {
         Assertions.assertEquals(Qudt.unitIriFromLocalname("DEG_F"), fahrenheit.getUnit().getIri());
     }
 
+    @Test
+    public void testConvert_Celsius_to_Fahrenheit_tempdiff() {
+        QuantityValue celsius100 =
+                new QuantityValue(new BigDecimal("100"), Qudt.unitFromLocalnameRequired("DEG_C"));
+        QuantityValue fahrenheit = Qudt.convert(celsius100, DEG_F, TemperatureDifference);
+        Assertions.assertNotNull(fahrenheit);
+        MatcherAssert.assertThat(
+                fahrenheit.getValue(),
+                Matchers.comparesEqualTo(new BigDecimal("179.9999999999999856000000000000012")));
+        Assertions.assertEquals(Qudt.unitIriFromLocalname("DEG_F"), fahrenheit.getUnit().getIri());
+    }
+
+    @Test
+    public void testConvert_Celsius_to_Kelvin_tempdiff() {
+        QuantityValue celsius100 =
+                new QuantityValue(new BigDecimal("100"), Qudt.unitFromLocalnameRequired("DEG_C"));
+        QuantityValue kelvin = Qudt.convert(celsius100, K, TemperatureDifference);
+        Assertions.assertNotNull(kelvin);
+        MatcherAssert.assertThat(
+                kelvin.getValue(), Matchers.comparesEqualTo(new BigDecimal("100")));
+        Assertions.assertEquals(Qudt.unitIriFromLocalname("K"), kelvin.getUnit().getIri());
+    }
+
     @Test
     public void testConvert_Celsius_to_Fahrenheit_2() {
         MatcherAssert.assertThat(
