add ground temperature 1m as option to weather data

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 - Extend Validation to EnergyManagement Systems. [#1356](https://github.com/ie3-institute/PowerSystemDataModel/issues/1356)
+- Add ground temperature (1m) as  option to weather data. [#1343](https://github.com/ie3-institute/PowerSystemDataModel/issues/1343)
 
 ### Fixed
 - Fixed handling of `CongestionResult.InputModelType` in `EntityProcessor` [#1325](https://github.com/ie3-institute/PowerSystemDataModel/issues/1325)

src/main/java/edu/ie3/datamodel/io/factory/timeseries/CosmoTimeBasedWeatherValueFactory.java

@@ -1,37 +1,44 @@
 /*
- * © 2021. TU Dortmund University,
+ * © 2020. TU Dortmund University,
  * Institute of Energy Systems, Energy Efficiency and Energy Economics,
  * Research group Distribution grid planning and operation
 */
 package edu.ie3.datamodel.io.factory.timeseries;
 
+import edu.ie3.datamodel.exceptions.FactoryException;
 import edu.ie3.datamodel.models.StandardUnits;
 import edu.ie3.datamodel.models.timeseries.individual.TimeBasedValue;
+import edu.ie3.datamodel.models.value.TemperatureValue;
 import edu.ie3.datamodel.models.value.WeatherValue;
 import edu.ie3.util.TimeUtil;
 import edu.ie3.util.quantities.PowerSystemUnits;
 import edu.ie3.util.quantities.interfaces.Irradiance;
 import java.time.ZonedDateTime;
 import java.time.format.DateTimeFormatter;
-import java.util.Collections;
-import java.util.List;
-import java.util.Set;
+import java.util.*;
 import javax.measure.quantity.Angle;
+import javax.measure.quantity.Length;
 import javax.measure.quantity.Speed;
 import javax.measure.quantity.Temperature;
 import org.locationtech.jts.geom.Point;
 import tech.units.indriya.ComparableQuantity;
+import tech.units.indriya.quantity.Quantities;
+import tech.units.indriya.unit.Units;
 
 /**
  * Factory implementation of {@link TimeBasedWeatherValueFactory}, that is able to handle field to
  * value mapping in the typical PowerSystemDataModel (PSDM) column scheme
  */
 public class CosmoTimeBasedWeatherValueFactory extends TimeBasedWeatherValueFactory {
+  private static final String TIME = "time";
+  private static final String COORDINATE_ID = "coordinateId";
   private static final String DIFFUSE_IRRADIANCE = "diffuseIrradiance";
   private static final String DIRECT_IRRADIANCE = "directIrradiance";
   private static final String TEMPERATURE = "temperature";
   private static final String WIND_DIRECTION = "windDirection";
   private static final String WIND_VELOCITY = "windVelocity";
+  private static final String GROUND_TEMPERATURE_SURFACE = "groundTemperatureSurface";
+  private static final String GROUND_TEMPERATURE_1M = "groundTemperature1m";
 
   public CosmoTimeBasedWeatherValueFactory(TimeUtil timeUtil) {
     super(timeUtil);
@@ -48,20 +55,28 @@ public CosmoTimeBasedWeatherValueFactory() {
   @Override
   protected List<Set<String>> getFields(Class<?> entityClass) {
     Set<String> minConstructorParams =
-        newSet(
-            COORDINATE_ID,
-            DIFFUSE_IRRADIANCE,
-            DIRECT_IRRADIANCE,
-            TEMPERATURE,
-            WIND_DIRECTION,
-            WIND_VELOCITY);
-    return Collections.singletonList(minConstructorParams);
+        new HashSet<>(
+            Set.of(
+                COORDINATE_ID,
+                TIME,
+                DIFFUSE_IRRADIANCE,
+                DIRECT_IRRADIANCE,
+                TEMPERATURE,
+                WIND_DIRECTION,
+                WIND_VELOCITY));
+
+    Set<String> withGroundTemps = new HashSet<>(minConstructorParams);
+    withGroundTemps.add(GROUND_TEMPERATURE_SURFACE);
+    withGroundTemps.add(GROUND_TEMPERATURE_1M);
+
+    return List.of(minConstructorParams, withGroundTemps);
   }
 
   @Override
   protected TimeBasedValue<WeatherValue> buildModel(TimeBasedWeatherValueData data) {
     Point coordinate = data.getCoordinate();
     ZonedDateTime time = timeUtil.toZonedDateTime(data.getField(TIME));
+
     ComparableQuantity<Irradiance> directIrradiance =
         data.getQuantity(DIRECT_IRRADIANCE, PowerSystemUnits.WATT_PER_SQUAREMETRE);
     ComparableQuantity<Irradiance> diffuseIrradiance =
@@ -72,14 +87,34 @@ protected TimeBasedValue<WeatherValue> buildModel(TimeBasedWeatherValueData data
         data.getQuantity(WIND_DIRECTION, StandardUnits.WIND_DIRECTION);
     ComparableQuantity<Speed> windVelocity =
         data.getQuantity(WIND_VELOCITY, StandardUnits.WIND_VELOCITY);
+
+    Map<ComparableQuantity<Length>, TemperatureValue> groundTemperatures = new HashMap<>();
+
+    try {
+      TemperatureValue tempValue =
+          new TemperatureValue(
+              data.getQuantity(GROUND_TEMPERATURE_SURFACE, StandardUnits.TEMPERATURE));
+      groundTemperatures.put(Quantities.getQuantity(0, Units.METRE), tempValue);
+    } catch (FactoryException ignored) {
+    }
+
+    try {
+      TemperatureValue tempValue =
+          new TemperatureValue(data.getQuantity(GROUND_TEMPERATURE_1M, StandardUnits.TEMPERATURE));
+      groundTemperatures.put(Quantities.getQuantity(1, Units.METRE), tempValue);
+    } catch (FactoryException ignored) {
+    }
+
     WeatherValue weatherValue =
         new WeatherValue(
             coordinate,
             directIrradiance,
             diffuseIrradiance,
             temperature,
             windDirection,
-            windVelocity);
+            windVelocity,
+            groundTemperatures);
+
     return new TimeBasedValue<>(time, weatherValue);
   }
 }

src/main/java/edu/ie3/datamodel/io/factory/timeseries/IconTimeBasedWeatherValueFactory.java

@@ -5,15 +5,18 @@
 */
 package edu.ie3.datamodel.io.factory.timeseries;
 
+import edu.ie3.datamodel.exceptions.FactoryException;
 import edu.ie3.datamodel.models.StandardUnits;
 import edu.ie3.datamodel.models.timeseries.individual.TimeBasedValue;
+import edu.ie3.datamodel.models.value.TemperatureValue;
 import edu.ie3.datamodel.models.value.WeatherValue;
 import edu.ie3.util.quantities.PowerSystemUnits;
 import edu.ie3.util.quantities.interfaces.Irradiance;
 import java.time.ZonedDateTime;
 import java.time.format.DateTimeFormatter;
 import java.util.*;
 import javax.measure.quantity.Angle;
+import javax.measure.quantity.Length;
 import javax.measure.quantity.Speed;
 import javax.measure.quantity.Temperature;
 import org.locationtech.jts.geom.Point;
@@ -33,6 +36,8 @@ public class IconTimeBasedWeatherValueFactory extends TimeBasedWeatherValueFacto
   private static final String TEMPERATURE = "t2m";
   private static final String WIND_VELOCITY_U = "u131m";
   private static final String WIND_VELOCITY_V = "v131m";
+  private static final String GROUND_TEMP_SURFACE = "tG";
+  private static final String SOIL_TEMP_100CM = "tso100cm";
 
   public IconTimeBasedWeatherValueFactory() {
     super();
@@ -47,13 +52,20 @@ protected List<Set<String>> getFields(Class<?> entityClass) {
     Set<String> minParameters =
         newSet(
             DIFFUSE_IRRADIANCE, DIRECT_IRRADIANCE, TEMPERATURE, WIND_VELOCITY_U, WIND_VELOCITY_V);
+
+    Set<String> minParametersWithGroundTemp = new HashSet<>(minParameters);
+    minParametersWithGroundTemp.add(GROUND_TEMP_SURFACE);
+    minParametersWithGroundTemp.add(SOIL_TEMP_100CM);
+
     Set<String> allParameters =
         expandSet(
             minParameters,
             "albrad",
             "asobs",
             "aswdifuS",
             "tG",
+            GROUND_TEMP_SURFACE,
+            SOIL_TEMP_100CM,
             "u10m",
             "u20m",
             "u216m",
@@ -73,7 +85,7 @@ protected List<Set<String>> getFields(Class<?> entityClass) {
             "sobsrad",
             "t131m");
 
-    return Arrays.asList(minParameters, allParameters);
+    return Arrays.asList(minParameters, minParametersWithGroundTemp, allParameters);
   }
 
   @Override
@@ -88,14 +100,35 @@ protected TimeBasedValue<WeatherValue> buildModel(TimeBasedWeatherValueData data
         data.getQuantity(TEMPERATURE, Units.KELVIN).to(StandardUnits.TEMPERATURE);
     ComparableQuantity<Angle> windDirection = getWindDirection(data);
     ComparableQuantity<Speed> windVelocity = getWindVelocity(data);
+
+    Map<ComparableQuantity<Length>, TemperatureValue> groundTemperatures = new HashMap<>();
+
+    try {
+      TemperatureValue tempValue =
+          new TemperatureValue(
+              data.getQuantity(GROUND_TEMP_SURFACE, Units.KELVIN).to(StandardUnits.TEMPERATURE));
+      groundTemperatures.put(Quantities.getQuantity(0, Units.METRE), tempValue);
+    } catch (FactoryException ignored) {
+    }
+
+    try {
+      TemperatureValue tempValue =
+          new TemperatureValue(
+              data.getQuantity(SOIL_TEMP_100CM, Units.KELVIN).to(StandardUnits.TEMPERATURE));
+      groundTemperatures.put(Quantities.getQuantity(1, Units.METRE), tempValue);
+    } catch (FactoryException ignored) {
+    }
+
     WeatherValue weatherValue =
         new WeatherValue(
             coordinate,
             directIrradiance,
             diffuseIrradiance,
             temperature,
             windDirection,
-            windVelocity);
+            windVelocity,
+            groundTemperatures);
+
     return new TimeBasedValue<>(time, weatherValue);
   }
 
@@ -114,11 +147,8 @@ protected TimeBasedValue<WeatherValue> buildModel(TimeBasedWeatherValueData data
    */
   private static ComparableQuantity<Angle> getWindDirection(TimeBasedWeatherValueData data) {
     /* Get the three dimensional parts of the wind velocity vector in cartesian coordinates */
-    double u =
-        data.getDouble(WIND_VELOCITY_U); // Wind component from west to east (parallel to latitudes)
-    double v =
-        data.getDouble(
-            WIND_VELOCITY_V); // Wind component from south to north (parallel to longitudes)
+    double u = data.getDouble(WIND_VELOCITY_U);
+    double v = data.getDouble(WIND_VELOCITY_V);
 
     double angle = Math.toDegrees(Math.atan2(-u, -v));
     return Quantities.getQuantity(angle < 0 ? angle + 360d : angle, PowerSystemUnits.DEGREE_GEOM)