Merge pull request #1360 from ie3-institute/mh/#1332-introducing-BmModel-to-ParticipantAgent

Factory case class in BmModel and BmInput case in GridAgentBuilder

Author: sebastian-peter

CHANGELOG.md

@@ -72,6 +72,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Implementing auto-merge for dependabot PRs [#1339](https://github.com/ie3-institute/simona/issues/1339)
 - Introduce operatingPoints also to `ThermalGrid` [#1338](https://github.com/ie3-institute/simona/issues/1338)
 - Added configuration for console log level [#1364](https://github.com/ie3-institute/simona/issues/1364)
+- Introduced `BmModel` to `ParticipantAgent` [#1332](https://github.com/ie3-institute/simona/issues/1332)
 
 ### Changed
 - Adapted to changed data source in PSDM [#435](https://github.com/ie3-institute/simona/issues/435)

src/main/scala/edu/ie3/simona/agent/grid/GridAgentBuilder.scala

@@ -143,7 +143,7 @@ class GridAgentBuilder(
                 curSysPart,
               ) =>
             curSysPart match {
-              case entity @ (_: BmInput | _: ChpInput | _: EvInput) =>
+              case entity @ (_: ChpInput | _: EvInput) =>
                 (
                   notProcessedElements + entity.getClass.getSimpleName,
                   availableSystemParticipants,
@@ -389,6 +389,18 @@ class GridAgentBuilder(
           environmentRefs.scheduler,
           maybeControllingEm,
         )
+      case input: BmInput =>
+        buildParticipant(
+          SimpleInputContainer(input),
+          participantConfigUtil.getOrDefault[BmRuntimeConfig](
+            input.getUuid
+          ),
+          outputConfigUtil.getOrDefault(NotifierIdentifier.BioMassPlant),
+          participantRefs,
+          simParams,
+          environmentRefs.scheduler,
+          maybeControllingEm,
+        )
       case input: WecInput =>
         buildParticipant(
           SimpleInputContainer(input),

src/main/scala/edu/ie3/simona/config/RuntimeConfig.scala

@@ -16,15 +16,15 @@ import scala.language.implicitConversions
 
 /** Runtime configurations for simona.
   * @param em
-  *   runtime configs for energy management systems
+  *   Runtime configs for energy management systems.
   * @param listener
-  *   runtime listener configuration
+  *   Runtime listener configuration.
   * @param participant
-  *   runtime configuration
+  *   Runtime configuration.
   * @param selectedSubgrids
-  *   option for selected sub grids (default: None)
+  *   Option for selected sub grids (default: None).
   * @param selectedVoltLvls
-  *   option for selected voltage levels (default: None)
+  *   Option for selected voltage levels (default: None).
   */
 final case class RuntimeConfig(
     em: AssetConfigs[EmRuntimeConfig] = AssetConfigs(EmRuntimeConfig()),
@@ -41,11 +41,11 @@ object RuntimeConfig {
   /** Wraps an [[BaseRuntimeConfig]] with a [[AssetConfigs]].
     *
     * @param config
-    *   to wrap
+    *   To wrap.
     * @tparam T
-    *   type of config
+    *   Type of config.
     * @return
-    *   a [[AssetConfigs]]
+    *   A [[AssetConfigs]].
     */
   implicit def wrap[T <: BaseRuntimeConfig](config: T): AssetConfigs[T] =
     AssetConfigs(config)
@@ -56,24 +56,27 @@ object RuntimeConfig {
   )
 
   /** Runtime configurations for participants.
+    * @param bm
+    *   Runtime configs for biomass power plants.
     * @param evcs
-    *   runtime configs for electrical vehicle charging stations
+    *   Runtime configs for electrical vehicle charging stations.
     * @param fixedFeedIn
-    *   runtime configs for fixed feed ins
+    *   Runtime configs for fixed feed ins.
     * @param hp
-    *   runtime configs for heat pumps
+    *   Runtime configs for heat pumps.
     * @param load
-    *   runtime configs for loads
+    *   Runtime configs for loads.
     * @param pv
-    *   runtime configs for photovoltaic plants
+    *   Runtime configs for photovoltaic plants.
     * @param requestVoltageDeviationThreshold
-    *   threshold for the voltage deviation
+    *   Threshold for the voltage deviation.
     * @param storage
-    *   runtime configs for electrical storages
+    *   Runtime configs for electrical storages.
     * @param wec
-    *   runtime configs for wind energy converters
+    *   Runtime configs for wind energy converters.
     */
   final case class Participant(
+      bm: AssetConfigs[BmRuntimeConfig] = BmRuntimeConfig(),
       evcs: AssetConfigs[EvcsRuntimeConfig] = EvcsRuntimeConfig(),
       fixedFeedIn: AssetConfigs[FixedFeedInRuntimeConfig] =
         FixedFeedInRuntimeConfig(),
@@ -95,17 +98,17 @@ object RuntimeConfig {
 
   /** Runtime configuration for electric vehicle charging stations.
     * @param calculateMissingReactivePowerWithModel
-    *   if missing reactive power may be filled up with model function (default:
-    *   false)
+    *   If missing reactive power may be filled up with model function (default:
+    *   false).
     * @param scaling
-    *   the scaling factor of the power output (default: 1.0)
+    *   The scaling factor of the power output (default: 1.0).
     * @param uuids
-    *   of the models that should use this config, for the default config this
-    *   value is ignored
+    *   Of the models that should use this config, for the default config this
+    *   value is ignored.
     * @param chargingStrategy
-    *   the charging strategy to use
+    *   The charging strategy to use.
     * @param lowestEvSoc
-    *   the lowest SOC possible for EV batteries (inverse of max dod)
+    *   The lowest SOC possible for EV batteries (inverse of max dod).
     */
   final case class EvcsRuntimeConfig(
       override val calculateMissingReactivePowerWithModel: Boolean = false,
@@ -117,17 +120,17 @@ object RuntimeConfig {
 
   /** Runtime configuration for energy management systems.
     * @param calculateMissingReactivePowerWithModel
-    *   if missing reactive power may be filled up with model function (default:
-    *   false)
+    *   If missing reactive power may be filled up with model function (default:
+    *   false).
     * @param scaling
-    *   the scaling factor of the power output (default: 1.0)
+    *   The scaling factor of the power output (default: 1.0).
     * @param uuids
-    *   of the models that should use this config, for the default config this
-    *   value is ignored
+    *   Of the models that should use this config, for the default config this
+    *   value is ignored.
     * @param aggregateFlex
-    *   strategy for aggregating flexibilities (default: SELF_OPT_EXCL_REG)
+    *   Strategy for aggregating flexibilities (default: SELF_OPT_EXCL_REG).
     * @param curtailRegenerative
-    *   if regenerative generation can be curtailed (default: false)
+    *   If regenerative generation can be curtailed (default: false).
     */
   final case class EmRuntimeConfig(
       override val calculateMissingReactivePowerWithModel: Boolean = false,
@@ -139,13 +142,13 @@ object RuntimeConfig {
 
   /** Runtime configuration for fixed feed ins.
     * @param calculateMissingReactivePowerWithModel
-    *   if missing reactive power may be filled up with model function (default:
-    *   false)
+    *   If missing reactive power may be filled up with model function (default:
+    *   false).
     * @param scaling
-    *   the scaling factor of the power output (default: 1.0)
+    *   The scaling factor of the power output (default: 1.0).
     * @param uuids
-    *   of the models that should use this config, for the default config this
-    *   value is ignored
+    *   Of the models that should use this config, for the default config this
+    *   value is ignored.
     */
   final case class FixedFeedInRuntimeConfig(
       override val calculateMissingReactivePowerWithModel: Boolean = false,
@@ -155,13 +158,13 @@ object RuntimeConfig {
 
   /** Runtime configuration for heat pumps.
     * @param calculateMissingReactivePowerWithModel
-    *   if missing reactive power may be filled up with model function (default:
-    *   false)
+    *   If missing reactive power may be filled up with model function (default:
+    *   false).
     * @param scaling
-    *   the scaling factor of the power output (default: 1.0)
+    *   The scaling factor of the power output (default: 1.0).
     * @param uuids
-    *   of the models that should use this config, for the default config this
-    *   value is ignored
+    *   Of the models that should use this config, for the default config this
+    *   value is ignored.
     */
   final case class HpRuntimeConfig(
       override val calculateMissingReactivePowerWithModel: Boolean = false,
@@ -171,18 +174,18 @@ object RuntimeConfig {
 
   /** Runtime configuration for loads.
     * @param calculateMissingReactivePowerWithModel
-    *   if missing reactive power may be filled up with model function (default:
-    *   false)
+    *   If missing reactive power may be filled up with model function (default:
+    *   false).
     * @param scaling
-    *   the scaling factor of the power output (default: 1.0)
+    *   The scaling factor of the power output (default: 1.0).
     * @param uuids
-    *   of the models that should use this config, for the default config this
-    *   value is ignored
+    *   Of the models that should use this config, for the default config this
+    *   value is ignored.
     * @param modelBehaviour
-    *   the behaviour of the loads (default: fix)
+    *   The behaviour of the loads (default: fix).
     * @param reference
-    *   defined to which reference a load model behaviour might be scaled
-    *   (default: power)
+    *   Defined to which reference a load model behaviour might be scaled
+    *   (default: power).
     */
   final case class LoadRuntimeConfig(
       override val calculateMissingReactivePowerWithModel: Boolean = false,
@@ -194,13 +197,13 @@ object RuntimeConfig {
 
   /** Runtime configuration for photovoltaic plants.
     * @param calculateMissingReactivePowerWithModel
-    *   if missing reactive power may be filled up with model function (default:
-    *   false)
+    *   If missing reactive power may be filled up with model function (default:
+    *   false).
     * @param scaling
-    *   the scaling factor of the power output (default: 1.0)
+    *   The scaling factor of the power output (default: 1.0).
     * @param uuids
-    *   of the models that should use this config, for the default config this
-    *   value is ignored
+    *   Of the models that should use this config, for the default config this
+    *   value is ignored.
     */
   final case class PvRuntimeConfig(
       override val calculateMissingReactivePowerWithModel: Boolean = false,
@@ -210,17 +213,17 @@ object RuntimeConfig {
 
   /** Runtime configuration for electrical storages.
     * @param calculateMissingReactivePowerWithModel
-    *   if missing reactive power may be filled up with model function (default:
-    *   false)
+    *   If missing reactive power may be filled up with model function (default:
+    *   false).
     * @param scaling
-    *   the scaling factor of the power output (default: 1.0)
+    *   The scaling factor of the power output (default: 1.0).
     * @param uuids
-    *   of the models that should use this config, for the default config this
-    *   value is ignored
+    *   Of the models that should use this config, for the default config this
+    *   value is ignored.
     * @param initialSoc
-    *   the initial state of charge in percent of the storage (default: 0.0)
+    *   The initial state of charge in percent of the storage (default: 0.0).
     * @param targetSoc
-    *   option for a targeted state of charge (default: None)
+    *   Option for a targeted state of charge (default: None).
     */
   final case class StorageRuntimeConfig(
       override val calculateMissingReactivePowerWithModel: Boolean = false,
@@ -232,17 +235,33 @@ object RuntimeConfig {
 
   /** Runtime configuration for wind energy converters.
     * @param calculateMissingReactivePowerWithModel
-    *   if missing reactive power may be filled up with model function (default:
-    *   false)
+    *   If missing reactive power may be filled up with model function (default:
+    *   false).
     * @param scaling
-    *   the scaling factor of the power output (default: 1.0)
+    *   The scaling factor of the power output (default: 1.0).
     * @param uuids
-    *   of the models that should use this config, for the default config this
-    *   value is ignored
+    *   Of the models that should use this config, for the default config this
+    *   value is ignored.
     */
   final case class WecRuntimeConfig(
       override val calculateMissingReactivePowerWithModel: Boolean = false,
       override val scaling: Double = 1.0,
       override val uuids: List[String] = List.empty,
   ) extends BaseRuntimeConfig
+
+  /** Runtime configuration for biomass plants.
+    * @param calculateMissingReactivePowerWithModel
+    *   If missing reactive power may be filled up with model function (default:
+    *   false).
+    * @param scaling
+    *   The scaling factor of the power output (default: 1.0).
+    * @param uuids
+    *   Of the models that should use this config, for the default config this
+    *   value is ignored.
+    */
+  final case class BmRuntimeConfig(
+      override val calculateMissingReactivePowerWithModel: Boolean = false,
+      override val scaling: Double = 1.0,
+      override val uuids: List[String] = List.empty,
+  ) extends BaseRuntimeConfig
 }