Create data model for air condition

Author: danielfeismann

docs/readthedocs/io/ValidationUtils.md

@@ -57,6 +57,7 @@ The ValidationUtils include validation checks for...
     - MeasurementUnitInput
 - SystemParticipantValidationUtils
     - SystemParticipantInput
+        - AcInput
         - BmInput
         - ChpInput
         - EvInput
@@ -67,7 +68,8 @@ The ValidationUtils include validation checks for...
         - StorageInput
         - WecInput
         - EvcsInput (also checks ChargingPointType)
-    - SystemParticipantTypeInput
+  - SystemParticipantTypeInput
+        - AcTypeInput
         - BmTypeInput
         - ChpTypeInput
         - EvTypeInput

docs/readthedocs/models/input/participant/ac.md

@@ -0,0 +1,108 @@
+(aircon-model)=
+
+# Air Condition
+
+Model of a heat pump.
+
+## Attributes, Units and Remarks
+
+### Type Model
+
+```{list-table}
+   :widths: auto
+   :class: wrapping
+   :header-rows: 1
+
+
+   * - Attribute
+     - Unit
+     - Remarks
+
+   * - uuid
+     -
+     -
+
+   * - id
+     -
+     - Human readable identifier
+
+   * - capex
+     - €
+     - Capital expenditure to purchase one entity of this type
+
+   * - opex
+     - € / MWh
+     - Operational expenditure to operate one entity of
+       this type
+
+   * - sRated
+     - kVA
+     - Rated apparent power
+
+   * - cosPhiRated
+     -
+     - Rated power factor
+
+   * - pThermal
+     - kW
+     - Rated thermal power (at rated electrical power)
+
+```
+
+### Entity Model
+
+```{list-table}
+   :widths: auto
+   :class: wrapping
+   :header-rows: 1
+
+
+   * - Attribute
+     - Unit
+     - Remarks
+
+   * - uuid
+     -
+     -
+
+   * - id
+     -
+     - Human readable identifier
+
+   * - operator
+     -
+     -
+
+   * - operationTime
+     -
+     - Timely restriction of operation
+
+   * - node
+     -
+     -
+
+   * - thermalBus
+     -
+     - Connection point to the thermal system
+
+   * - qCharacteristics
+     -
+     - [Reactive power characteristic](#participant-general-q-characteristic) to follow
+
+   * - type
+     -
+     -
+
+   * - controllingEm
+     -
+     - UUID reference to an [Energy Management Unit](#em_model) that is controlling
+       this system participant. Field can be empty or missing, if this participant
+       is not controlled.
+
+
+```
+
+## Caveats
+
+Nothing - at least not known.
+If you found something, please contact us!

docs/readthedocs/models/models.md

@@ -139,6 +139,7 @@ input/thermal/domestichotwaterstorage
 maxdepth: 1
 ---
 input/participant/general
+input/participant/ac
 input/participant/bm
 input/participant/chp
 input/participant/ev
@@ -195,6 +196,7 @@ result/grid/congestion
 ---
 maxdepth: 1
 ---
+result/participant/ac
 result/participant/bm
 result/participant/chp
 result/participant/ev

docs/readthedocs/models/result/participant/ac.md

@@ -0,0 +1,43 @@
+(ac-result)=
+
+# Air Condition
+
+Result of an air condition.
+
+## Attributes, Units and Remarks
+
+```{list-table}
+   :widths: 33 33 33
+   :header-rows: 1
+
+
+   * - Attribute
+     - Unit
+     - Remarks
+
+   * - time
+     -
+     - date and time for the produced result
+
+   * - inputModel
+     -
+     - uuid for the associated input model
+
+   * - p
+     - MW
+     -
+
+   * - q
+     - MVAr
+     -
+
+   * - qDot
+     - MW
+     - Thermal power
+
+```
+
+## Caveats
+
+Nothing - at least not known.
+If you found something, please contact us!

docs/uml/main/EntitySourceClassDiagram.puml

@@ -129,6 +129,7 @@ class ResultEntitySource {
     + Set<EvcsResult> getEvcsResults() throws SourceException
     + Set<EvResult> getEvResults() throws SourceException
     + Set<HpResult> getHpResults() throws SourceException
+    + Set<AcResult> getAcResults() throws SourceException
     + Set<CylindricalStorageResult> getCylindricalStorageResult() throws SourceException
     + Set<DomesticHotStorageResult> getDomesticHotWaterStorageResult() throws SourceException
     + Set<ThermalHouseResult> getThermalHouseResults() throws SourceException
@@ -141,6 +142,7 @@ class SystemParticipantSource{
     - RawGridSource rawGridSource
     - ThermalSource thermalSource
     - EnergyManagementSource energyManagementSource
+    - AcInputFactory acInputFactory
     - BmInputFactory bmInputFactory
     - ChpInputFactory chpInputFactory
     - EvInputFactory evInputFactory
@@ -154,6 +156,8 @@ class SystemParticipantSource{
     + SystemParticipantSource(TypeSource, ThermalSource, RawGridSource, EnergyManagementSource, DataSource)
     + SystemParticipants getSystemParticipants() throws SourceException
     + SystemParticipants getSystemParticipants(Map<UUID, OperatorInput>, Map<UUID, NodeInput>) throws SourceException
+    + Set<AcInput> getAirConditions() throws SourceException
+    + Set<AcInput> getAirConditions(Map<UUID, OperatorInput>, Map<UUID, NodeInput>, Set<AcTypeInput>) throws SourceException
     + Set<BmInput> getBmPlants() throws SourceException
     + Set<BmInput> getBmPlants(Map<UUID, OperatorInput>, Map<UUID, NodeInput>, Set<BmTypeInput>) throws SourceException
     + Set<ChpInput> getChpPlants() throws SourceException

docs/uml/main/OutputDatamodelConcept.puml

@@ -93,6 +93,9 @@ package models {
             class HpResult
             SystemParticipantWithHeatResult <|-- HpResult
 
+            class AcResult
+            SystemParticipantWithHeatResult <|-- AcResult
+
             class WecResult
             SystemParticipantResult <|-- WecResult
 

docs/uml/main/input/ModelContainerConcept.puml

@@ -40,6 +40,7 @@ package models.input.container {
     RawGridElements ..|> InputContainer
 
     class SystemParticipants {
+        - airConditions: Set<AcInput>
         - bmPlants: Set<BmInput>
         - chpPlants: Set<ChpInput>
         - evcs: Set<EvcsInput>

docs/uml/main/input/SystemDatamodelConcept.puml

@@ -173,6 +173,15 @@ package models {
             SystemParticipantInput ..|> HasNodes
             SystemParticipantInput ..|> NodeInput
 
+            class AcInput {
+                - type: AcTypeInput
+                - thermalBus: ThermalBusInput
+            }
+            AcInput --|> SystemParticipantInput
+            AcInput ..|> HasType
+            AcInput ..|> HasThermalBus
+            AcInput *-- ThermalBusInput
+
             class BmInput {
                 - type: BmTypeInput
                 - marketReaction: Boolean
@@ -214,7 +223,7 @@ package models {
             HpInput --|> SystemParticipantInput
             HpInput ..|> HasType
             HpInput ..|> HasThermalBus
-            ChpInput *-- ThermalBusInput
+            HpInput *-- ThermalBusInput
 
             class LoadInput {
                 - standardLoadProfile: StandardLoadProfile

src/main/java/edu/ie3/datamodel/io/factory/input/participant/AcInputEntityData.java

@@ -0,0 +1,88 @@
+/*
+ * © 2021. 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.input.participant;
+
+import edu.ie3.datamodel.models.input.EmInput;
+import edu.ie3.datamodel.models.input.NodeInput;
+import edu.ie3.datamodel.models.input.OperatorInput;
+import edu.ie3.datamodel.models.input.system.AcInput;
+import edu.ie3.datamodel.models.input.system.type.AcTypeInput;
+import edu.ie3.datamodel.models.input.thermal.ThermalBusInput;
+import java.util.Map;
+import java.util.Objects;
+
+public class AcInputEntityData extends SystemParticipantTypedEntityData<AcTypeInput> {
+  private final ThermalBusInput thermalBusInput;
+
+  public AcInputEntityData(
+      Map<String, String> fieldsToAttributes,
+      NodeInput node,
+      EmInput em,
+      AcTypeInput typeInput,
+      ThermalBusInput thermalBusInput) {
+    super(fieldsToAttributes, AcInput.class, node, em, typeInput);
+    this.thermalBusInput = thermalBusInput;
+  }
+
+  public AcInputEntityData(
+      Map<String, String> fieldsToAttributes,
+      OperatorInput operator,
+      NodeInput node,
+      EmInput em,
+      AcTypeInput typeInput,
+      ThermalBusInput thermalBusInput) {
+    super(fieldsToAttributes, AcInput.class, operator, node, em, typeInput);
+    this.thermalBusInput = thermalBusInput;
+  }
+
+  /**
+   * Creates a new AcInputEntityData object based on a given {@link
+   * SystemParticipantTypedEntityData} object and given thermal bus input
+   *
+   * @param entityData The SystemParticipantTypedEntityData object to enhance
+   * @param thermalBusInput The thermal bus input
+   */
+  public AcInputEntityData(
+      SystemParticipantTypedEntityData<AcTypeInput> entityData, ThermalBusInput thermalBusInput) {
+    super(entityData, entityData.getTypeInput());
+    this.thermalBusInput = thermalBusInput;
+  }
+
+  public ThermalBusInput getThermalBusInput() {
+    return thermalBusInput;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (!(o instanceof AcInputEntityData that)) return false;
+    if (!super.equals(o)) return false;
+    return thermalBusInput.equals(that.thermalBusInput);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(super.hashCode(), thermalBusInput);
+  }
+
+  @Override
+  public String toString() {
+    return "AcInputEntityData{"
+        + "thermalBusInput="
+        + thermalBusInput.getUuid()
+        + ", typeInput="
+        + getTypeInput().getUuid()
+        + ", node="
+        + getNode().getUuid()
+        + ", operatorInput="
+        + getOperatorInput().getUuid()
+        + ", fieldsToValues="
+        + getFieldsToValues()
+        + ", targetClass="
+        + getTargetClass()
+        + '}';
+  }
+}

src/main/java/edu/ie3/datamodel/io/factory/input/participant/AcInputFactory.java

@@ -0,0 +1,50 @@
+/*
+ * © 2021. 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.input.participant;
+
+import edu.ie3.datamodel.models.OperationTime;
+import edu.ie3.datamodel.models.input.EmInput;
+import edu.ie3.datamodel.models.input.NodeInput;
+import edu.ie3.datamodel.models.input.OperatorInput;
+import edu.ie3.datamodel.models.input.system.AcInput;
+import edu.ie3.datamodel.models.input.system.characteristic.ReactivePowerCharacteristic;
+import java.util.UUID;
+
+public class AcInputFactory
+    extends SystemParticipantInputEntityFactory<AcInput, AcInputEntityData> {
+
+  public AcInputFactory() {
+    super(AcInput.class);
+  }
+
+  @Override
+  protected String[] getAdditionalFields() {
+    return new String[0];
+  }
+
+  @Override
+  protected AcInput buildModel(
+      AcInputEntityData data,
+      UUID uuid,
+      String id,
+      NodeInput node,
+      ReactivePowerCharacteristic qCharacteristics,
+      OperatorInput operator,
+      OperationTime operationTime) {
+    final EmInput em = data.getControllingEm().orElse(null);
+
+    return new AcInput(
+        uuid,
+        id,
+        operator,
+        operationTime,
+        node,
+        data.getThermalBusInput(),
+        qCharacteristics,
+        em,
+        data.getTypeInput());
+  }
+}