Added SystemParticipantWithHeatResult class and modified ChpResult accordingly

AUTHORS

@@ -15,6 +15,7 @@ Main Contributers:
     - Sebastian Peter - https://github.com/sebastian-peter
     - Christian Mahr - https://github.com/cmahr93
     - Vasilios Zachopoulos - https://github.com/baszach
+    - Shubham Bajpai - https://github.com/ahamshubham
 
 Coordination:
     - Chris Kittl

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -   reading time series from csv files (including a container object to hold the different types of time series)
 -   reading mapping from participant uuid to time series uuid including a mapping object for easy access to time series
 -   Couchbase, SQL and CSV connectors and sources for weather data
+-   added `SystemParticipantWithHeatResult` with thermal power variable to be used by heat plant result models
 
 ### Changed
 -   BREAKING: replaced [Unit API 1.0](https://github.com/unitsofmeasurement/uom-se) (JSR 363, tec.uom.se) with [Unit API 2.0](https://github.com/unitsofmeasurement/indriya) (JSR 385, tech.units.indriya)
@@ -23,13 +24,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -   added coordinate distance sort method to GridAndGeoUtils
 -   BREAKING: Harmonized field naming for time information
 -   BREAKING: Properly applying snake case to result file names
+-   deprecated `TarballUtils`
 
 ### Fixed
 - InfluxDbConnector now keeps session instead of creating a new one each call
 (resolves [#247](https://github.com/ie3-institute/PowerSystemDataModel/issues/247)
 and [#248](https://github.com/ie3-institute/PowerSystemDataModel/issues/248))
 - BREAKING: fix invalid application of solar irradiance / irradiation ([#266](https://github.com/ie3-institute/PowerSystemDataModel/issues/266))
 - BREAKING: deleted `IrradiationValue` as it is invalid and no longer required
+- added copy builder implementations for thermal input models `CylindricalStorageInput`, `ThermalBusInput` and `ThermalHouseInput`
 
 ## [1.1.0] - 2020-09-15
 

Jenkinsfile

@@ -108,7 +108,7 @@ node {
                         'spotbugsTest test jacocoTestReport jacocoTestCoverageVerification', projectName)
 
                 // due to an issue with openjdk-8 we use openjdk-11 for javadocs generation
-                sh(script: """set +x && cd $projectName""" + ''' set +x; ./gradlew clean javadoc -Dorg.gradle.java.home=/usr/local/openjdk-11''', returnStdout: true)
+                sh(script: """set +x && cd $projectName""" + ''' set +x; ./gradlew clean javadoc -Dorg.gradle.java.home=/opt/java/openjdk''', returnStdout: true)
             }
 
             // sonarqube analysis
@@ -150,7 +150,7 @@ node {
                          */
                         sh(
                                 script: """set +x && cd $projectName""" +
-                                ''' set +x; ./gradlew clean javadoc -Dorg.gradle.java.home=/usr/local/openjdk-11''',
+                                ''' set +x; ./gradlew clean javadoc -Dorg.gradle.java.home=/opt/java/openjdk''',
                                 returnStdout: true
                         )
 
@@ -364,7 +364,7 @@ def deployJavaDocs(String projectName, String sshCredentialsId, String gitChecko
                     "git config user.name 'Johannes Hiry' && " +
                     "git fetch --depth=1 origin api-docs && " +
                     "git checkout api-docs && " +
-                    "cd .. && ./gradlew clean javadoc -Dorg.gradle.java.home=/usr/local/openjdk-11 && " +
+                    "cd .. && ./gradlew clean javadoc -Dorg.gradle.java.home=/opt/java/openjdk && " +
                     "cp -R build/docs/javadoc/* tmp-api-docs && " +
                     "cd tmp-api-docs &&" +
                     "git add --all && git commit -m 'updated api-docs' && git push origin api-docs:api-docs" +

docs/readthedocs/models/result/participant/chp.rst

@@ -20,7 +20,8 @@ Attributes, Units and Remarks
 +---------------+---------+--------------------------------------------------------------+
 | q             | MVAr    |                                                              |
 +---------------+---------+--------------------------------------------------------------+
-
+| qDot          | MW      | Thermal power                                                |
++---------------+---------+--------------------------------------------------------------+
 
 Caveats
 ^^^^^^^

docs/uml/main/OutputDatamodelConcept.puml

@@ -82,11 +82,16 @@ package models {
             class PvResult
             SystemParticipantResult  <|-- PvResult
 
+            abstract class SystemParticipantWithHeatResult{
+                - qDot: ComparableQuantity<Power>
+            }
+            SystemParticipantResult  <|-- SystemParticipantWithHeatResult
+
             class ChpResult
-            SystemParticipantResult <|-- ChpResult
+            SystemParticipantWithHeatResult <|-- ChpResult
 
             class HpResult
-            SystemParticipantResult <|-- HpResult
+            SystemParticipantWithHeatResult <|-- HpResult
 
             class WecResult
             SystemParticipantResult <|-- WecResult

src/main/java/edu/ie3/datamodel/io/factory/result/SystemParticipantResultFactory.java

@@ -55,8 +55,8 @@ protected List<Set<String>> getFields(SimpleEntityData data) {
       optionalFields = expandSet(minConstructorParams, ENTITY_UUID);
     }
 
-    if (data.getTargetClass().equals(HpResult.class)) {
-      minConstructorParams = newSet(TIME, INPUT_MODEL, POWER, REACTIVE_POWER, Q_DOT);
+    if (SystemParticipantWithHeatResult.class.isAssignableFrom(data.getTargetClass())) {
+      minConstructorParams = expandSet(minConstructorParams, Q_DOT);
       optionalFields = expandSet(minConstructorParams, ENTITY_UUID);
     }
 
@@ -95,19 +95,25 @@ protected SystemParticipantResult buildModel(SimpleEntityData data) {
       return uuidOpt
           .map(uuid -> new EvcsResult(uuid, zdtTime, inputModelUuid, p, q))
           .orElseGet(() -> new EvcsResult(zdtTime, inputModelUuid, p, q));
-    } else if (entityClass.equals(ChpResult.class)) {
-      return uuidOpt
-          .map(uuid -> new ChpResult(uuid, zdtTime, inputModelUuid, p, q))
-          .orElseGet(() -> new ChpResult(zdtTime, inputModelUuid, p, q));
+    } else if (SystemParticipantWithHeatResult.class.isAssignableFrom(entityClass)) {
+      /* The following classes all have a heat component as well */
+      ComparableQuantity<Power> qDot = data.getQuantity(Q_DOT, StandardUnits.Q_DOT_RESULT);
+
+      if (entityClass.equals(ChpResult.class)) {
+        return uuidOpt
+            .map(uuid -> new ChpResult(uuid, zdtTime, inputModelUuid, p, q, qDot))
+            .orElseGet(() -> new ChpResult(zdtTime, inputModelUuid, p, q, qDot));
+      } else if (entityClass.equals(HpResult.class)) {
+        return uuidOpt
+            .map(uuid -> new HpResult(uuid, zdtTime, inputModelUuid, p, q, qDot))
+            .orElseGet(() -> new HpResult(zdtTime, inputModelUuid, p, q, qDot));
+      } else {
+        throw new FactoryException("Cannot process " + entityClass.getSimpleName() + ".class.");
+      }
     } else if (entityClass.equals(WecResult.class)) {
       return uuidOpt
           .map(uuid -> new WecResult(uuid, zdtTime, inputModelUuid, p, q))
           .orElseGet(() -> new WecResult(zdtTime, inputModelUuid, p, q));
-    } else if (entityClass.equals(HpResult.class)) {
-      ComparableQuantity<Power> qDotQuantity = data.getQuantity(Q_DOT, StandardUnits.Q_DOT_RESULT);
-      return uuidOpt
-          .map(uuid -> new HpResult(uuid, zdtTime, inputModelUuid, p, q, qDotQuantity))
-          .orElseGet(() -> new HpResult(zdtTime, inputModelUuid, p, q, qDotQuantity));
     } else if (entityClass.equals(EvResult.class)) {
       ComparableQuantity<Dimensionless> socQuantity = data.getQuantity(SOC, PERCENT);
 

src/main/java/edu/ie3/datamodel/io/processor/Processor.java

@@ -137,6 +137,7 @@ protected SortedMap<String, Method> mapFieldNameToGetter(
                   fieldName = V_RATED;
                   resFieldNameToMethod.put(VOLT_LVL, pd.getReadMethod());
                 }
+
                 resFieldNameToMethod.put(fieldName, pd.getReadMethod());
               });
 

src/main/java/edu/ie3/datamodel/models/result/system/ChpResult.java

@@ -11,7 +11,7 @@
 import tech.units.indriya.ComparableQuantity;
 
 /** Represents calculation results of a {@link edu.ie3.datamodel.models.input.system.ChpInput} */
-public class ChpResult extends SystemParticipantResult {
+public class ChpResult extends SystemParticipantWithHeatResult {
 
   /**
    * Standard constructor with automatic uuid generation.
@@ -20,13 +20,15 @@ public class ChpResult extends SystemParticipantResult {
    * @param inputModel uuid of the input model that produces the result
    * @param p active power output normally provided in MW
    * @param q reactive power output normally provided in MVAr
+   * @param qDot thermal power output normally provided in MW
    */
   public ChpResult(
       ZonedDateTime time,
       UUID inputModel,
       ComparableQuantity<Power> p,
-      ComparableQuantity<Power> q) {
-    super(time, inputModel, p, q);
+      ComparableQuantity<Power> q,
+      ComparableQuantity<Power> qDot) {
+    super(time, inputModel, p, q, qDot);
   }
 
   /**
@@ -38,14 +40,16 @@ public ChpResult(
    * @param inputModel uuid of the input model that produces the result
    * @param p active power output normally provided in MW
    * @param q reactive power output normally provided in MVAr
+   * @param qDot thermal power output normally provided in MW
    */
   public ChpResult(
       UUID uuid,
       ZonedDateTime time,
       UUID inputModel,
       ComparableQuantity<Power> p,
-      ComparableQuantity<Power> q) {
-    super(uuid, time, inputModel, p, q);
+      ComparableQuantity<Power> q,
+      ComparableQuantity<Power> qDot) {
+    super(uuid, time, inputModel, p, q, qDot);
   }
 
   @Override
@@ -61,6 +65,8 @@ public String toString() {
         + getP()
         + ", q="
         + getQ()
+        + ", qDot="
+        + getqDot()
         + '}';
   }
 }

src/main/java/edu/ie3/datamodel/models/result/system/HpResult.java

@@ -6,16 +6,12 @@
 package edu.ie3.datamodel.models.result.system;
 
 import java.time.ZonedDateTime;
-import java.util.Objects;
 import java.util.UUID;
-import javax.measure.Quantity;
 import javax.measure.quantity.Power;
 import tech.units.indriya.ComparableQuantity;
 
 /** Represents calculation results of a {@link edu.ie3.datamodel.models.input.system.HpInput} */
-public class HpResult extends SystemParticipantResult {
-
-  private final Quantity<Power> qDot;
+public class HpResult extends SystemParticipantWithHeatResult {
 
   /**
    * Standard constructor with automatic uuid generation.
@@ -31,9 +27,8 @@ public HpResult(
       UUID inputModel,
       ComparableQuantity<Power> p,
       ComparableQuantity<Power> q,
-      Quantity<Power> qDot) {
-    super(time, inputModel, p, q);
-    this.qDot = qDot;
+      ComparableQuantity<Power> qDot) {
+    super(time, inputModel, p, q, qDot);
   }
 
   /**
@@ -53,27 +48,8 @@ public HpResult(
       UUID inputModel,
       ComparableQuantity<Power> p,
       ComparableQuantity<Power> q,
-      Quantity<Power> qDot) {
-    super(uuid, time, inputModel, p, q);
-    this.qDot = qDot;
-  }
-
-  public Quantity<Power> getqDot() {
-    return qDot;
-  }
-
-  @Override
-  public boolean equals(Object o) {
-    if (this == o) return true;
-    if (o == null || getClass() != o.getClass()) return false;
-    if (!super.equals(o)) return false;
-    HpResult hpResult = (HpResult) o;
-    return qDot.equals(hpResult.qDot);
-  }
-
-  @Override
-  public int hashCode() {
-    return Objects.hash(super.hashCode(), qDot);
+      ComparableQuantity<Power> qDot) {
+    super(uuid, time, inputModel, p, q, qDot);
   }
 
   @Override
@@ -90,7 +66,7 @@ public String toString() {
         + ", q="
         + getQ()
         + ", qDot="
-        + qDot
+        + getqDot()
         + '}';
   }
 }

src/main/java/edu/ie3/datamodel/models/result/system/SystemParticipantWithHeatResult.java

@@ -0,0 +1,97 @@
+/*
+ * © 2021. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.models.result.system;
+
+import java.time.ZonedDateTime;
+import java.util.Objects;
+import java.util.UUID;
+import javax.measure.quantity.Power;
+import tech.units.indriya.ComparableQuantity;
+
+/** Abstract class that holds values common to result entities having heat result */
+public abstract class SystemParticipantWithHeatResult extends SystemParticipantResult {
+  /** The thermal power output normally provided in MW */
+  private final ComparableQuantity<Power> qDot;
+
+  /**
+   * @param time date and time when the result is produced
+   * @param inputModel uuid of the input model that produces the result
+   * @param p active power output normally provided in MW
+   * @param q reactive power output normally provided in MVAr
+   * @param qDot thermal power output normally provided in MW
+   */
+  public SystemParticipantWithHeatResult(
+      ZonedDateTime time,
+      UUID inputModel,
+      ComparableQuantity<Power> p,
+      ComparableQuantity<Power> q,
+      ComparableQuantity<Power> qDot) {
+    super(time, inputModel, p, q);
+    this.qDot = qDot;
+  }
+
+  /**
+   * @param uuid uuid of this result entity, for automatic uuid generation use primary constructor
+   *     above
+   * @param time date and time when the result is produced
+   * @param inputModel uuid of the input model that produces the result
+   * @param p active power output normally provided in MW
+   * @param q reactive power output normally provided in MVAr
+   * @param qDot thermal power output normally provided in MW
+   */
+  public SystemParticipantWithHeatResult(
+      UUID uuid,
+      ZonedDateTime time,
+      UUID inputModel,
+      ComparableQuantity<Power> p,
+      ComparableQuantity<Power> q,
+      ComparableQuantity<Power> qDot) {
+    super(uuid, time, inputModel, p, q);
+    this.qDot = qDot;
+  }
+
+  /**
+   * Thermal power output of the decentralised energy resource asset. Convention: Generated powers
+   * are given in negative values.
+   *
+   * @return Thermal power output in MW.
+   */
+  public ComparableQuantity<Power> getqDot() {
+    return qDot;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (o == null || getClass() != o.getClass()) return false;
+    if (!super.equals(o)) return false;
+    SystemParticipantWithHeatResult that = (SystemParticipantWithHeatResult) o;
+    return qDot.equals(that.qDot);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(super.hashCode(), qDot);
+  }
+
+  @Override
+  public String toString() {
+    return "SystemParticipantWithHeatResult{"
+        + "uuid="
+        + getUuid()
+        + ", time="
+        + getTime()
+        + ", inputModel="
+        + getInputModel()
+        + ", p="
+        + getP()
+        + ", q="
+        + getQ()
+        + ", qDot="
+        + getqDot()
+        + '}';
+  }
+}

src/test/groovy/edu/ie3/datamodel/io/factory/result/SystemParticipantResultFactoryTest.groovy

@@ -49,7 +49,7 @@ class SystemParticipantResultFactoryTest extends Specification implements Factor
 			parameter["soc"] = "10"
 		}
 
-		if(modelClass == HpResult){
+		if (modelClass == HpResult || modelClass == ChpResult) {
 			parameter["qDot"] = "1"
 		}
 
@@ -69,11 +69,17 @@ class SystemParticipantResultFactoryTest extends Specification implements Factor
 		if (modelClass == EvResult) {
 			assert (((EvResult) result.get()).soc == getQuant(parameter["soc"], Units.PERCENT))
 		}
-		if(modelClass ==StorageResult){
+
+		if (modelClass == StorageResult) {
 			assert (((StorageResult) result.get()).soc == getQuant(parameter["soc"], Units.PERCENT))
 		}
-		if(modelClass == HpResult){
-			assert(((HpResult)result.get()).qDot == getQuant(parameter["qDot"], StandardUnits.Q_DOT_RESULT))
+
+		if (modelClass == HpResult) {
+			assert(((HpResult)result.get()).getqDot() == getQuant(parameter["qDot"], StandardUnits.Q_DOT_RESULT))
+		}
+
+		if (modelClass == ChpResult) {
+			assert(((ChpResult)result.get()).getqDot() == getQuant(parameter["qDot"], StandardUnits.Q_DOT_RESULT))
 		}
 
 		where: