ReCoDe

CHANGELOG.md

@@ -25,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated docker documentation [#488](https://github.com/ie3-institute/simona/issues/488)
 - Added support classes for transformer tap position calculation [#1543](https://github.com/ie3-institute/simona/issues/1543)
 - Added basic external em service [#1566](https://github.com/ie3-institute/simona/issues/1566)
+- Added external result provider [#1530](https://github.com/ie3-institute/simona/issues/1530)
 
 ### Changed
 - Upgraded `scala2` to `scala3` [#53](https://github.com/ie3-institute/simona/issues/53)

build.gradle

@@ -206,8 +206,6 @@ tasks.shadowJar {
 tasks.withType(ScalaCompile).configureEach {
   scalaCompileOptions.additionalParameters = scala3compilerOptions + [
     "-Xplugin:" + configurations.scalaCompilerPlugin.asPath,
-    "-P:scapegoat:dataDir:" + project.layout.buildDirectory.get().asFile.absolutePath + "/reports/scapegoat/src/",
-    "-P:scapegoat:disabledInspections:TryGet"
   ]
   scalaCompileOptions.forkOptions.jvmArgs = [
     '-Xss2m',
@@ -219,8 +217,6 @@ tasks.withType(ScalaCompile).configureEach {
 compileTestScala {
   scalaCompileOptions.additionalParameters = scala3compilerOptions + [
     "-Xplugin:" + configurations.scalaCompilerPlugin.asPath,
-    "-P:scapegoat:dataDir:" + project.layout.buildDirectory.get().asFile.absolutePath + "/reports/scapegoat/testsrc/",
-    "-P:scapegoat:disabledInspections:TryGet"
   ]
 }
 

input/samples/vn_simona/vn_simona.conf

@@ -23,13 +23,13 @@ simona.time.schedulerReadyCheckWindow = 900
 # Input Parameters
 ##################################################################
 simona.input.primary.csvParams = {
-  directoryPath: "input/samples/vn_simona/fullGrid"
+  directoryPath: "simona/input/samples/vn_simona/fullGridEm"
   csvSep: ","
   isHierarchic: false
 }
 simona.input.grid.datasource.id = "csv"
 simona.input.grid.datasource.csvParams = {
-  directoryPath: "input/samples/vn_simona/fullGrid"
+  directoryPath: "simona/input/samples/vn_simona/fullGridEm"
   csvSep: ","
   isHierarchic: false
 }
@@ -44,7 +44,7 @@ simona.input.weather.datasource = {
 ##################################################################
 # Output Parameters
 ##################################################################
-simona.output.base.dir = "output/vn_simona"
+simona.output.base.dir = "simona/output/vn_simonaEM"
 simona.output.base.addTimestampToOutputDir = true
 
 simona.output.sink.csv {

src/main/scala/edu/ie3/simona/agent/EnvironmentRefs.scala

@@ -10,6 +10,7 @@ import edu.ie3.simona.event.RuntimeEvent
 import edu.ie3.simona.ontology.messages.{SchedulerMessage, ServiceMessage}
 import edu.ie3.simona.service.em.ExtEmDataService
 import edu.ie3.simona.service.ev.ExtEvDataService
+import edu.ie3.simona.service.results.ResultServiceProxy
 import org.apache.pekko.actor.typed.ActorRef
 
 /** Container class, that gather together reference to relevant entities, that
@@ -21,6 +22,8 @@ import org.apache.pekko.actor.typed.ActorRef
   *   Reference to the runtime event listener.
   * @param primaryServiceProxy
   *   Reference to the primary service proxy.
+  * @param resultProxy
+  *   Reference to the result service proxy.
   * @param weather
   *   Reference to the service, that provides weather information.
   * @param loadProfiles
@@ -34,6 +37,7 @@ final case class EnvironmentRefs(
     scheduler: ActorRef[SchedulerMessage],
     runtimeEventListener: ActorRef[RuntimeEvent],
     primaryServiceProxy: ActorRef[ServiceMessage],
+    resultProxy: ActorRef[ResultServiceProxy.Message],
     weather: ActorRef[ServiceMessage],
     loadProfiles: ActorRef[ServiceMessage],
     emDataService: Option[ActorRef[ExtEmDataService.Message]],

src/main/scala/edu/ie3/simona/agent/em/EmAgent.scala

@@ -63,7 +63,7 @@ object EmAgent {
     *   agent is em-controlled, or a [[Left]] with a reference to the scheduler
     *   that is activating this agent.
     * @param listener
-    *   A collection of result event listeners.
+    *   A listener for result events.
     * @param emDataService
     *   An energy management service.
     */
@@ -74,8 +74,8 @@ object EmAgent {
       modelStrategy: String,
       simulationStartDate: ZonedDateTime,
       parent: Either[ActorRef[SchedulerMessage], ActorRef[FlexResponse]],
-      listener: Iterable[ActorRef[ResultEvent]],
-      emDataService: Option[ActorRef[ExtEmDataService.Message]] = None,
+      listener: ActorRef[ResultEvent],
+      emDataService: Option[ActorRef[ExtEmDataService.Message]],
   ): Behavior[Message] = Behaviors.setup[Message] { ctx =>
 
     val parentData = emDataService match {
@@ -200,8 +200,18 @@ object EmAgent {
     case (_, msg: Activation) =>
       activate(emData, modelShell, core, msg.tick)
 
-    case (_, msg: FlexActivation) =>
-      activate(emData, modelShell, core, msg.tick)
+    case (ctx, msg: FlexActivation) =>
+      val tick = msg.tick
+      ctx.log.info(s"EmAgent (${modelShell.uuid}) activated for tick $tick")
+
+      activate(emData, modelShell, core, tick)
+
+    case (ctx, msg: FlexShiftActivation) =>
+      val tick = msg.tick
+      ctx.log.info(
+        s"EmAgent (${modelShell.uuid}) activated by service for tick $tick"
+      )
+      activate(emData, modelShell, core.gotoTick(tick), tick)
 
     case (ctx, msg: IssueFlexControl) =>
       val flexOptionsCore = core.activate(msg.tick)
@@ -265,9 +275,7 @@ object EmAgent {
             )
           )
 
-          emData.listener.foreach {
-            _ ! FlexOptionsResultEvent(flexResult)
-          }
+          emData.listener ! FlexOptionsResultEvent(flexResult)
         }
 
         emData.parent match {
@@ -392,6 +400,11 @@ object EmAgent {
             inactiveCore,
             lastActiveTick = updatedCore.activeTick,
           )(using ctx.self)
+
+          ctx.log.info(
+            s"${modelShell.uuid} -> inactive, next tick ${completion.requestAtTick}"
+          )
+
           inactive(emData, modelShell, inactiveCore)
         }
         .getOrElse {
@@ -422,17 +435,15 @@ object EmAgent {
       }
 
     maybeResult.foreach { result =>
-      emData.listener.foreach {
-        _ ! ParticipantResultEvent(
-          new EmResult(
-            lastActiveTick
-              .toDateTime(using emData.simulationStartDate),
-            modelShell.uuid,
-            result.p.toMegawatts.asMegaWatt,
-            result.q.toMegavars.asMegaVar,
-          )
+      emData.listener ! ParticipantResultEvent(
+        new EmResult(
+          lastActiveTick
+            .toDateTime(using emData.simulationStartDate),
+          modelShell.uuid,
+          result.p.toMegawatts.asMegaWatt,
+          result.q.toMegavars.asMegaVar,
         )
-      }
+      )
 
       emData.parent.foreach {
         _ ! FlexResult(modelShell.uuid, result)
@@ -463,13 +474,13 @@ object EmAgent {
     *   agent is em-controlled, or a [[Left]] with a reference to the scheduler
     *   that is activating this agent.
     * @param listener
-    *   A collection of result event listeners.
+    *   A listener for result events.
     */
   private final case class EmData(
       outputConfig: NotifierConfig,
       simulationStartDate: ZonedDateTime,
       parent: Either[ActorRef[SchedulerMessage], ActorRef[FlexResponse]],
-      listener: Iterable[ActorRef[ResultEvent]],
+      listener: ActorRef[ResultEvent],
   )
 
   /** The existence of this data object indicates that the corresponding agent

src/main/scala/edu/ie3/simona/agent/em/EmDataCore.scala

@@ -81,6 +81,18 @@ object EmDataCore {
         modelToActor = modelToActor.updated(asset, actor)
       )
 
+    def gotoTick(newTick: Long): Inactive = {
+      // remove the activations
+      activationQueue.headKeyOption.foreach { nextScheduledTick =>
+        if newTick > nextScheduledTick then {
+          val toActivate = activationQueue.getAndRemoveSet(nextScheduledTick)
+          activationQueue.set(newTick, toActivate)
+        }
+      }
+
+      this
+    }
+
     /** Tries to handle an activation of the EmAgent for given tick. If the
       * activation for the tick is not valid, a [[CriticalFailureException]] is
       * thrown. If successful, an [[AwaitingFlexOptions]] data core is returned

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

@@ -32,7 +32,10 @@ import edu.ie3.simona.ontology.messages.SchedulerMessage.{
   Completion,
   ScheduleActivation,
 }
+import edu.ie3.simona.service.results.ResultServiceProxy.ExpectResult
 import edu.ie3.simona.util.TickUtil.TickLong
+import edu.ie3.util.TimeUtil
+import edu.ie3.simona.util.TickUtil.{RichZonedDateTime, TickLong}
 import org.apache.pekko.actor.typed.scaladsl.AskPattern.Askable
 import org.apache.pekko.actor.typed.scaladsl.{
   ActorContext,
@@ -68,7 +71,6 @@ object GridAgent extends DBFSAlgorithm with DCMAlgorithm {
   def apply(
       environmentRefs: EnvironmentRefs,
       simonaConfig: SimonaConfig,
-      listener: Iterable[ActorRef[ResultEvent]],
   ): Behavior[Message] = Behaviors.withStash(100) { buffer =>
     val cfg = simonaConfig.simona
 
@@ -83,7 +85,6 @@ object GridAgent extends DBFSAlgorithm with DCMAlgorithm {
     val agentValues = GridAgentConstantData(
       environmentRefs,
       simonaConfig,
-      listener,
       resolution,
       simStartTime,
       simEndTime,
@@ -229,6 +230,13 @@ object GridAgent extends DBFSAlgorithm with DCMAlgorithm {
         ctx.self,
         Some(activation.tick),
       )
+
+      // inform the result proxy that this grid agent will send new results
+      constantData.environmentRefs.resultProxy ! ExpectResult(
+        gridAgentBaseData.assets,
+        activation.tick,
+      )
+
       buffer.unstashAll(simulateGrid(gridAgentBaseData, activation.tick))
 
     case (_, msg: Message) =>
@@ -279,7 +287,13 @@ object GridAgent extends DBFSAlgorithm with DCMAlgorithm {
 
     // check if congestion management is enabled
     if gridAgentBaseData.congestionManagementParams.detectionEnabled then {
-      startCongestionManagement(gridAgentBaseData, currentTick, results, ctx)
+      startCongestionManagement(
+        gridAgentBaseData,
+        currentTick,
+        nextTick,
+        results,
+        ctx,
+      )
     } else {
       // clean up agent and go back to idle
       gotoIdle(gridAgentBaseData, nextTick, results, ctx)

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

@@ -308,9 +308,9 @@ object GridAgentBuilder {
 
     given ParticipantRefs = ParticipantRefs(
       gridAgentContext.self,
-      constantData.environmentRefs.primaryServiceProxy,
+      environmentRefs.primaryServiceProxy,
+      environmentRefs.resultProxy,
       serviceMap,
-      constantData.listener,
     )
 
     given SimulationParameters = SimulationParameters(
@@ -488,7 +488,7 @@ object GridAgentBuilder {
         maybeControllingEm.toRight(
           constantData.environmentRefs.scheduler
         ),
-        constantData.listener,
+        constantData.environmentRefs.resultProxy,
         emDataService,
       ),
       actorName(classOf[EmAgent.type], emInput.getId),

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

@@ -46,9 +46,6 @@ object GridAgentData {
     *   the grid agent.
     * @param simonaConfig
     *   Configuration of SIMONA, that is used for.
-    * @param listener
-    *   A sequence of listeners, that will receive the results from the grid
-    *   agent.
     * @param resolution
     *   That is used for the power flow. If no power flow should be carried out,
     *   this value is set to [[Long.MaxValue]].
@@ -60,14 +57,12 @@ object GridAgentData {
   final case class GridAgentConstantData(
       environmentRefs: EnvironmentRefs,
       simonaConfig: SimonaConfig,
-      listener: Iterable[ActorRef[ResultEvent]],
       resolution: Long,
       simStartTime: ZonedDateTime,
       simEndTime: ZonedDateTime,
   ) {
-    def notifyListeners(event: ResultEvent): Unit = {
-      listener.foreach(_ ! event)
-    }
+    def notifyListeners(event: ResultEvent): Unit =
+      environmentRefs.resultProxy ! event
 
     val participantConfigUtil: ParticipantConfigUtil =
       ConfigUtil.ParticipantConfigUtil(simonaConfig.simona.runtime.participant)
@@ -323,6 +318,15 @@ object GridAgentData {
   ) extends GridAgentData
       with GridAgentDataHelper {
 
+    val assets: Seq[UUID] = {
+      val components = gridEnv.gridModel.gridComponents
+      components.nodes.map(_.uuid) ++ components.lines.map(
+        _.uuid
+      ) ++ components.switches.map(_.uuid) ++ components.transformers.map(
+        _.uuid
+      ) ++ components.transformers3w.map(_.uuid)
+    }
+
     override protected val subgridGates: Vector[SubGridGate] =
       gridEnv.subgridGateToActorRef.keys.toVector
     override protected val subgridId: Int = gridEnv.gridModel.subnetNo

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

@@ -58,17 +58,16 @@ private[grid] trait GridResultsSupport {
   def createResultModels(
       grid: GridModel,
       sweepValueStore: SweepValueStore,
-  )(implicit timestamp: ZonedDateTime, log: Logger): PowerFlowResultEvent = {
+  )(using timestamp: ZonedDateTime, log: Logger): PowerFlowResultEvent = {
     // no sanity check for duplicated uuid result data as we expect valid data at this point
-    implicit val sweepValueStoreData: Map[UUID, SweepValueStoreData] =
+    given sweepValueStoreData: Map[UUID, SweepValueStoreData] =
       sweepValueStore.sweepData
         .map(sweepValueStoreData =>
           sweepValueStoreData.nodeUuid -> sweepValueStoreData
         )
         .toMap
 
-    implicit val iNominal: ElectricCurrent =
-      grid.mainRefSystem.nominalCurrent
+    given ElectricCurrent = grid.mainRefSystem.nominalCurrent
 
     /* When creating node results, we have to consider two things:
      *   1) The result of a two winding transformer's hv node is calculated twice. If this grid contains the

src/main/scala/edu/ie3/simona/agent/grid/congestion/DCMAlgorithm.scala

@@ -48,6 +48,7 @@ trait DCMAlgorithm extends CongestionDetection {
   private[grid] def startCongestionManagement(
       gridAgentBaseData: GridAgentBaseData,
       currentTick: Long,
+      nextTick: Long,
       results: Option[PowerFlowResultEvent],
       ctx: ActorContext[Message],
   )(using
@@ -59,7 +60,7 @@ trait DCMAlgorithm extends CongestionDetection {
     val congestionManagementData = results
       .map(res => CongestionManagementData(gridAgentBaseData, currentTick, res))
       .getOrElse(
-        CongestionManagementData.empty(gridAgentBaseData, currentTick)
+        CongestionManagementData.empty(gridAgentBaseData, currentTick, nextTick)
       )
 
     ctx.self ! StartStep

src/main/scala/edu/ie3/simona/agent/grid/congestion/data/CongestionManagementData.scala

@@ -169,6 +169,7 @@ object CongestionManagementData {
   def empty(
       gridAgentBaseData: GridAgentBaseData,
       currentTick: Long,
+      nextTick: Long,
   ): CongestionManagementData = apply(
     gridAgentBaseData,
     currentTick,