diff --git a/CHANGELOG.md b/CHANGELOG.md index 2a2cb7b066..4cef76459a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -134,6 +134,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Fixed ThermalStorageResults having multiple entries [#924](https://github.com/ie3-institute/simona/issues/924) - Fix filter for thermal result checking for lastTick not for currentTick [#1008](https://github.com/ie3-institute/simona/issues/1008) - Fixed `CHANGELOG` entry for issue ([#103](https://github.com/ie3-institute/simona/issues/103)) [#941](https://github.com/ie3-institute/simona/issues/941) +- Fix grammar and spelling in docs and comments [#1022](https://github.com/ie3-institute/simona/issues/1022) ## [3.0.0] - 2023-08-07 @@ -226,7 +227,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Support for three winding transformers [#63](https://github.com/ie3-institute/simona/issues/63) - Handle incoming slack voltage accordingly - Allow multiple sub grid gates at one node (also allows multiple two winding transformers at one node) - - Perform power flow calculation in highest grid, if a three winding transformer is apparent + - Perform power flow calculation in the highest grid, if a three winding transformer is apparent - Write out results - Fixed broken layout in RTD documentation [#500](https://github.com/ie3-institute/simona/issues/500) - Corrected tests in RefSystemTest [#560](https://github.com/ie3-institute/simona/issues/560) diff --git a/docs/readthedocs/developersguide.md b/docs/readthedocs/developersguide.md index ace59e05e6..a246fc106a 100644 --- a/docs/readthedocs/developersguide.md +++ b/docs/readthedocs/developersguide.md @@ -2,7 +2,7 @@ # Developer’s Guide -The SIMONA repository can be found [on Github](https://github.com/ie3-institute/simona). +The SIMONA repository can be found [on GitHub](https://github.com/ie3-institute/simona). ```{contents} --- diff --git a/docs/readthedocs/models/chp_model.md b/docs/readthedocs/models/chp_model.md index c5f01364bf..d7eb8232eb 100644 --- a/docs/readthedocs/models/chp_model.md +++ b/docs/readthedocs/models/chp_model.md @@ -6,7 +6,7 @@ This page documents the functionality of the CHP Model (combined heat and power ## Assumptions -The CHP unit is able to operate either at full load or not at all. Uncovered heat demand of former time-steps is not considered in the following steps, as the CHP unit does not posses a memory. Losses of the heat storage are not considered. +The CHP unit is able to operate either at full load or not at all. Uncovered heat demand of former time-steps is not considered in the following steps, as the CHP unit does not possess a memory. Losses of the heat storage are not considered. ## Parameters diff --git a/docs/readthedocs/models/cts_model.md b/docs/readthedocs/models/cts_model.md index 5750820624..e03fa06563 100644 --- a/docs/readthedocs/models/cts_model.md +++ b/docs/readthedocs/models/cts_model.md @@ -3,7 +3,7 @@ This page documents the functionality of the cylindrical thermal storage available in SIMONA. ## Behaviour -This storage model operates on volumes, although the functions it provides for other models all operate with energy. Internally the storage model converts energy to volume and vice versa with formulas specified below. Furthermore it is assumed that the storage medium is water. Also the model holds a variable for the current storage level. +This storage model operates on volumes, although the functions it provides for other models all operate with energy. Internally the storage model converts energy to volume and vice versa with formulas specified below. Furthermore, it is assumed that the storage medium is water. Also, the model holds a variable for the current storage level. ## Attributes, Units and Remarks diff --git a/docs/readthedocs/models/em.md b/docs/readthedocs/models/em.md index ae10cb3ac2..ea7261d4f8 100644 --- a/docs/readthedocs/models/em.md +++ b/docs/readthedocs/models/em.md @@ -16,7 +16,7 @@ If an EmAgent is itself controlled by another EmAgent, it also behaves like a sy Every EmAgent aggregates flex options and power of its connected assets and disaggregates flex control among the connected assets. It also functions as a scheduler for all connected assets by processing information on the ticks of the next desired activations and conveying such information to the controlling EmAgent or a central scheduler respectively. -Uncontrolled EmAgents answer to a scheduler with regards to their activation. +Uncontrolled EmAgents answer to a scheduler with regard to their activation. ![](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/ie3-institute/simona/dev/docs/uml/protocol/em/UncontrolledEm.puml) diff --git a/docs/readthedocs/models/hp_model.md b/docs/readthedocs/models/hp_model.md index 0458fffbac..8070e36f36 100644 --- a/docs/readthedocs/models/hp_model.md +++ b/docs/readthedocs/models/hp_model.md @@ -6,7 +6,7 @@ This page documents the functionality of the Heat Pump Model (HP model) availabl ## Assumptions -The HP unit is able to operate either at full load or not at all. Uncovered heat demand of former time-steps is not considered in the following steps, as the HP unit does not posses a memory. +The HP unit is able to operate either at full load or not at all. Uncovered heat demand of former time-steps is not considered in the following steps, as the HP unit does not possess a memory. ## Parameters @@ -17,6 +17,6 @@ Please refer to {doc}`PowerSystemDataModel - HP Model // this happens if this agent is either a) the superior grid agent, because it will always get a request for // the next sweep, as it triggers calculations for the next sweep or b) at all other - // (non last downstream grid agents) in sweep 0 + // (non-last downstream grid agents) in sweep 0 ctx.log.debug( "Unable to find slack voltage for nodes '{}' in sweep '{}'. Try to get voltage of previous sweep.", nodeUuids, @@ -386,7 +386,7 @@ trait DBFSAlgorithm extends PowerFlowSupport with GridResultsSupport { // update the sweep value store and clear all received maps // note: normally it is expected that this has to be done after power flow calculations but for the sake - // of having it only once in the code we put this here. Otherwise it would have to been put before EVERY + // of having it only once in the code we put this here. Otherwise, it would have to be put before EVERY // return with a valid power flow result (currently happens already in two situations) val updatedGridAgentBaseData = if (stillPendingRequestAnswers.isEmpty) { @@ -737,7 +737,7 @@ trait DBFSAlgorithm extends PowerFlowSupport with GridResultsSupport { gridAgentBaseData.powerFlowParams.sweepTimeout, )(ctx) - // when we don't have inferior grids and no assets both methods return None and we can skip doing another power + // when we don't have inferior grids and no assets both methods return None, and we can skip doing another power // flow calculation otherwise we go back to simulate grid and wait for the answers if (!askForAssetPowersOpt && !askForInferiorGridPowersOpt) { ctx.log.debug( @@ -832,7 +832,7 @@ trait DBFSAlgorithm extends PowerFlowSupport with GridResultsSupport { ) /* Regarding the power flow result of this grid, there are two cases. If this is the "highest" grid in a - * simulation without a three winding transformer, the grid consists of only one node and we can mock the power + * simulation without a three winding transformer, the grid consists of only one node, and we can mock the power * flow results. If there is a three winding transformer apparent, we actually have to perform power flow * calculations, as the high voltage branch of the transformer is modeled here. */ (if (gridModel.gridComponents.transformers3w.isEmpty) { @@ -955,13 +955,13 @@ trait DBFSAlgorithm extends PowerFlowSupport with GridResultsSupport { } } - /** Checks if all data has been received and if yes checks if the there are - * any failed power flow indications from inferior grids. If both == true, - * then no [[Behavior]] change is triggered but the sweep value store is - * updated with a [[FailedPowerFlow]] information as well, the now used data - * is set to [[PowerFlowDoneData]] and this is escalated to the superior - * grid(s). If there is no [[FailedPowerFlow]] in the [[GridAgentBaseData]] a - * behavior transition to [[handlePowerFlowCalculations]] is triggered. + /** Checks if all data has been received and if yes checks if there are any + * failed power flow indications from inferior grids. If both == true, then + * no [[Behavior]] change is triggered but the sweep value store is updated + * with a [[FailedPowerFlow]] information as well, the now used data is set + * to [[PowerFlowDoneData]] and this is escalated to the superior grid(s). If + * there is no [[FailedPowerFlow]] in the [[GridAgentBaseData]] a behavior + * transition to [[handlePowerFlowCalculations]] is triggered. * * If allReceived == false, no [[Behavior]] transition is triggered * @@ -1023,11 +1023,11 @@ trait DBFSAlgorithm extends PowerFlowSupport with GridResultsSupport { /** Normally only reached by the superior (dummy) agent! * - * Checks if all data has been received and if yes checks if the there are - * any failed power flow indications from inferior grids. If both == true, - * then a finish simulation is triggered and depending on the configuration - * this step is skipped and the simulation goes on or this leads to a - * termination of the simulation due to a failed power flow calculation. + * Checks if all data has been received and if yes checks if there are any + * failed power flow indications from inferior grids. If both == true, then a + * finish simulation is triggered and depending on the configuration this + * step is skipped and the simulation goes on or this leads to a termination + * of the simulation due to a failed power flow calculation. * * If there is no [[FailedPowerFlow]] in the [[GridAgentBaseData]] a * [[Behavior]] transition to [[checkPowerDifferences]] is triggered. @@ -1153,7 +1153,7 @@ trait DBFSAlgorithm extends PowerFlowSupport with GridResultsSupport { * @param askTimeout * a timeout for the request * @return - * true if this grids contains assets or false if no request has been send + * true if this grids contains assets or false if no request has been sent * due to non-existence of assets */ private def askForAssetPowers( @@ -1383,11 +1383,11 @@ trait DBFSAlgorithm extends PowerFlowSupport with GridResultsSupport { } /** This method uses [[ActorContext.pipeToSelf()]] to send a future message to - * itself. If the future is a [[Success]] the message is send, else a - * [[WrappedFailure]] with the thrown error is send. + * itself. If the future is a [[Success]] the message is sent, else a + * [[WrappedFailure]] with the thrown error is sent. * * @param future - * future message that should be send to the agent after it was processed + * future message that should be sent to the agent after it was processed * @param ctx * [[ActorContext]] of the receiving actor */ diff --git a/src/main/scala/edu/ie3/simona/agent/grid/GridAgent.scala b/src/main/scala/edu/ie3/simona/agent/grid/GridAgent.scala index f02d7c36b1..c9bca30ce1 100644 --- a/src/main/scala/edu/ie3/simona/agent/grid/GridAgent.scala +++ b/src/main/scala/edu/ie3/simona/agent/grid/GridAgent.scala @@ -57,7 +57,7 @@ object GridAgent extends DBFSAlgorithm { // val initialization val resolution: Long = simonaConfig.simona.powerflow.resolution.get( ChronoUnit.SECONDS - ) // this determines the agents regular time bin it wants to be triggered e.g one hour + ) // this determines the agents regular time bin it wants to be triggered e.g. one hour val simStartTime: ZonedDateTime = TimeUtil.withDefaults .toZonedDateTime(simonaConfig.simona.time.startDateTime) diff --git a/src/main/scala/edu/ie3/simona/agent/grid/GridAgentController.scala b/src/main/scala/edu/ie3/simona/agent/grid/GridAgentController.scala index f2e78f7c53..ad0d6c3b07 100644 --- a/src/main/scala/edu/ie3/simona/agent/grid/GridAgentController.scala +++ b/src/main/scala/edu/ie3/simona/agent/grid/GridAgentController.scala @@ -158,7 +158,7 @@ class GridAgentController( /** Go through all provided input models, build agents for those and group the * resulting actor references for each connection nodes. All participant * agents are also introduced to the agent environment and the scheduler is - * requested to send a initialisation trigger. + * requested to send an initialisation trigger. * * @param participantsConfig * Configuration information for participant models diff --git a/src/main/scala/edu/ie3/simona/agent/grid/GridAgentData.scala b/src/main/scala/edu/ie3/simona/agent/grid/GridAgentData.scala index 636baca646..6b77430487 100644 --- a/src/main/scala/edu/ie3/simona/agent/grid/GridAgentData.scala +++ b/src/main/scala/edu/ie3/simona/agent/grid/GridAgentData.scala @@ -56,7 +56,7 @@ object GridAgentData { } } - /** Data that is send to the [[GridAgent]] directly after startup. It contains + /** Data that is sent to the [[GridAgent]] directly after startup. It contains * the main information for initialization. This data should include all * [[GridAgent]] individual data, for data that is the same for all * [[GridAgent]] s please use [[GridAgent.apply()]] diff --git a/src/main/scala/edu/ie3/simona/agent/grid/GridAgentMessages.scala b/src/main/scala/edu/ie3/simona/agent/grid/GridAgentMessages.scala index b0d98be1e9..288add1bd9 100644 --- a/src/main/scala/edu/ie3/simona/agent/grid/GridAgentMessages.scala +++ b/src/main/scala/edu/ie3/simona/agent/grid/GridAgentMessages.scala @@ -186,7 +186,7 @@ object GridAgentMessages { /** Provide values as a reply to a * [[edu.ie3.simona.agent.participant.ParticipantAgent.RequestAssetPowerMessage]]. * In contrast to [[AssetPowerChangedMessage]], this message indicates that - * the same values for [[p]] and [[q]] has been send again as in the previous + * the same values for [[p]] and [[q]] has been sent again as in the previous * request * * @param p diff --git a/src/main/scala/edu/ie3/simona/agent/grid/GridResultsSupport.scala b/src/main/scala/edu/ie3/simona/agent/grid/GridResultsSupport.scala index c872cc8e54..8d6d4adcfe 100644 --- a/src/main/scala/edu/ie3/simona/agent/grid/GridResultsSupport.scala +++ b/src/main/scala/edu/ie3/simona/agent/grid/GridResultsSupport.scala @@ -96,7 +96,7 @@ private[grid] trait GridResultsSupport { * and the corresponding sweep value data * * @param lines - * the set of lines which the result should be build for + * the set of lines which the result should be built for * @param sweepValueStoreData * the value store with all power flow result values of the provided lines * @param iNominal @@ -142,7 +142,7 @@ private[grid] trait GridResultsSupport { * [[TransformerModel]] and the corresponding sweep value data * * @param transformers - * the set of transformers which the result should be build for + * the set of transformers which the result should be built for * @param sweepValueStoreData * the value store with all power flow result values of the provided * transformers @@ -190,7 +190,7 @@ private[grid] trait GridResultsSupport { * [[Transformer3wModel]] and the corresponding sweep value data * * @param transformers3w - * the set of 3 winding transformers which the result should be build for + * the set of 3 winding transformers which the result should be built for * @param sweepValueStoreData * the value store with all power flow result values of the provided 3 * winding transformers @@ -495,7 +495,7 @@ private[grid] trait GridResultsSupport { /** Calculate the current magnitude and the current angle in physical units * based on a provided electric current in p.u. and the nominal referenced * electric current. The arctangent "only" calculates the angle between the - * complex current and it's real part. This means, that i = (i_real, i_imag) + * complex current, and it's real part. This means, that i = (i_real, i_imag) * and i' = (-i_real, -i_imag) will lead to the same angle. However, for * power system simulation, the absolute orientation in the complex plane * with regard to the positive real axis is of interest. Therefore, diff --git a/src/main/scala/edu/ie3/simona/agent/grid/PowerFlowSupport.scala b/src/main/scala/edu/ie3/simona/agent/grid/PowerFlowSupport.scala index eae1369de4..c43700466c 100644 --- a/src/main/scala/edu/ie3/simona/agent/grid/PowerFlowSupport.scala +++ b/src/main/scala/edu/ie3/simona/agent/grid/PowerFlowSupport.scala @@ -203,7 +203,7 @@ trait PowerFlowSupport { * p/q values from the provided sweepDataValues and combines them with * updated receivedSlackValues. Normally used in a forward sweep phase of * [[DBFSAlgorithm]] as in this state only voltages are updated and a power - * flow with new voltages but old p/q values is executed afterwards + * flow with new voltages but old p/q values is executed afterward. * * @param receivedSlackValues * new slack voltages provided by the superior grid @@ -369,7 +369,7 @@ trait PowerFlowSupport { * from a [[ValidNewtonRaphsonPFResult]] * * @param validResult - * the result that should be converted to a human readable debug string + * the result that should be converted to a human-readable debug string * @param gridModel * the grid model this result comes from * @return diff --git a/src/main/scala/edu/ie3/simona/agent/participant/ParticipantAgent.scala b/src/main/scala/edu/ie3/simona/agent/participant/ParticipantAgent.scala index 52e3a53a59..19eff90211 100644 --- a/src/main/scala/edu/ie3/simona/agent/participant/ParticipantAgent.scala +++ b/src/main/scala/edu/ie3/simona/agent/participant/ParticipantAgent.scala @@ -149,7 +149,7 @@ abstract class ParticipantAgent[ Activation(tick), modelBaseStateData: ParticipantModelBaseStateData[PD, CD, MS, M], ) if modelBaseStateData.services.isEmpty => - /* An activity start trigger is sent and no data is awaited (neither secondary nor primary). Therefore go straight + /* An activity start trigger is sent and no data is awaited (neither secondary nor primary). Therefore, go straight * ahead to calculations */ /* Hold tick, as state transition is needed */ @@ -448,8 +448,8 @@ abstract class ParticipantAgent[ case _ => participantStateData.receivedSecondaryDataStore } - /* At least parts of the needed data has been received or it is an additional activation, that has been triggered. - * Anyways, the calculation routine has also to take care of filling up missing data. */ + /* At least parts of the needed data has been received, or it is an additional activation, that has been triggered. + * Anyway, the calculation routine has also to take care of filling up missing data. */ val lastModelState = getLastOrInitialStateData(participantStateData, currentTick) calculatePowerWithSecondaryDataAndGoToIdle( @@ -493,7 +493,7 @@ abstract class ParticipantAgent[ * @param simulationEndDate * Real world time date time, when the simulation ends * @param resolution - * Agents regular time bin it wants to be triggered e.g one hour + * Agents regular time bin it wants to be triggered e.g. one hour * @param requestVoltageDeviationThreshold * Threshold, after which two nodal voltage magnitudes from participant * power requests for the same tick are considered to be different @@ -533,7 +533,7 @@ abstract class ParticipantAgent[ * @param simulationEndDate * Real world time date time, when the simulation ends * @param resolution - * Agents regular time bin it wants to be triggered e.g one hour + * Agents regular time bin it wants to be triggered e.g. one hour * @param requestVoltageDeviationThreshold * Threshold, after which two nodal voltage magnitudes from participant * power requests for the same tick are considered to be different @@ -656,7 +656,7 @@ abstract class ParticipantAgent[ * the agent is meant to replay external primary data: Announce result, add * content to result value store, go to [[Idle]] and answer the scheduler, * that the activity start trigger is fulfilled. 2.2) All secondary data is - * there, go to [[Calculate]] and ask the scheduler to trigger ourself for + * there, go to [[Calculate]] and ask the scheduler to trigger ourselves for * starting the model based calculation 3) Everything is at place and the * [[Activation]] has NOT yet been sent: Stay here and wait * @@ -835,7 +835,7 @@ abstract class ParticipantAgent[ )(implicit outputConfig: NotifierConfig): Unit /** Abstract definition to clean up agent value stores after power flow - * convergence. This is necessary for agents whose results are time dependent + * convergence. This is necessary for agents whose results are time-dependent * e.g. storage agents * * @param baseStateData diff --git a/src/main/scala/edu/ie3/simona/agent/participant/ParticipantAgentFundamentals.scala b/src/main/scala/edu/ie3/simona/agent/participant/ParticipantAgentFundamentals.scala index bce998d857..deaad623bf 100644 --- a/src/main/scala/edu/ie3/simona/agent/participant/ParticipantAgentFundamentals.scala +++ b/src/main/scala/edu/ie3/simona/agent/participant/ParticipantAgentFundamentals.scala @@ -157,7 +157,7 @@ protected trait ParticipantAgentFundamentals[ * @param simulationEndDate * Real world time date time, when the simulation ends * @param resolution - * Agents regular time bin it wants to be triggered e.g one hour + * Agents regular time bin it wants to be triggered e.g. one hour * @param requestVoltageDeviationThreshold * Threshold, after which two nodal voltage magnitudes from participant * power requests for the same tick are considered to be different @@ -244,7 +244,7 @@ protected trait ParticipantAgentFundamentals[ * @param simulationEndDate * Real world time date time, when the simulation ends * @param resolution - * Agents regular time bin it wants to be triggered e.g one hour + * Agents regular time bin it wants to be triggered e.g. one hour * @param requestVoltageDeviationThreshold * Threshold, after which two nodal voltage magnitudes from participant * power requests for the same tick are considered to be different @@ -368,7 +368,7 @@ protected trait ParticipantAgentFundamentals[ operationStart: Long, operationEnd: Long, ): SortedSet[Long] = { - /* The profile load model holds values in the specified resolution (e.g. for each full quarter hour (00:00, + /* The profile load model holds values in the specified resolution (e.g. for each full quarter-hour (00:00, * 00:15, ...)). As the simulation might not start at an integer multiple of the resolution, we have to * determine, what the first tick is, in which profile information do exist */ val firstProfileTick = @@ -388,7 +388,7 @@ protected trait ParticipantAgentFundamentals[ /** Assume we have information, that are available in a fixed resolution after * each full hour (including the full hour), then we have to determine, at - * what first tick those information are available. + * what first tick this information are available. * * @param simulationStartDate * Beginning of the simulation @@ -515,7 +515,7 @@ protected trait ParticipantAgentFundamentals[ val foreseenDataTicks = baseStateData.foreseenDataTicks + (msg.serviceRef -> msg.nextDataTick) - /* Go over to handling these information */ + /* Go over to handling this information */ val nextStateData = DataCollectionStateData( BaseStateData.updateBaseStateData( baseStateData, @@ -538,8 +538,9 @@ protected trait ParticipantAgentFundamentals[ * Announce result, add content to result value store, go to [[Idle]] and * answer the scheduler, that the activity start trigger is fulfilled. 2.2) * All secondary data is there, go to [[Calculate]] and ask the scheduler to - * trigger ourself for starting the model based calculation 3) Everything is - * at place and the [[Activation]] has NOT yet been sent: Stay here and wait + * trigger ourselves for starting the model based calculation 3) Everything + * is at place and the [[Activation]] has NOT yet been sent: Stay here and + * wait * * @param stateData * Apparent state data @@ -645,7 +646,7 @@ protected trait ParticipantAgentFundamentals[ ) } } else { - /* We sill have to wait - either for data or activation */ + /* We still have to wait - either for data or activation */ stay() using stateData } } @@ -1070,7 +1071,7 @@ protected trait ParticipantAgentFundamentals[ false } - // If we're completing initialization and we're EM-managed: + // If we're completing initialization, and we're EM-managed: // There is no new tick for the scheduler, // since we are activated by the EmAgent from now on scheduler ! Completion( @@ -1141,7 +1142,7 @@ protected trait ParticipantAgentFundamentals[ baseStateData, ) case (Some(additionalTick), _) => - /* The next activation is additional (either there is no foreseen data tick or it is after the additional tick. + /* The next activation is additional (either there is no foreseen data tick or it is after the additional tick). * Remove the tick from the list of additional activation ticks. */ val upcomingActivationTicks = baseStateData.additionalActivationTicks.rangeFrom(additionalTick + 1) @@ -1159,7 +1160,7 @@ protected trait ParticipantAgentFundamentals[ updatedBaseStateData, ) case (None, None) => - /* We don't know nothing about either additional activation nor new incoming data */ + /* We don't know anything about either additional activation nor new incoming data */ (None, baseStateData) } } @@ -1244,7 +1245,7 @@ protected trait ParticipantAgentFundamentals[ nodalVoltage, lastNodalVoltage, ).getOrElse { - /* If a fast reply is not possible, determine it the old fashioned way */ + /* If a fast reply is not possible, determine it the old-fashioned way */ determineReply( requestTick, baseStateData, @@ -1258,7 +1259,7 @@ protected trait ParticipantAgentFundamentals[ } /** Checks, if a fast reply is possible, when the very same request (in terms - * of tick and nodal voltage) already has been answered. Then a Option on + * of tick and nodal voltage) already has been answered. Then an Option on * stay in the same state with sending an [[AssetPowerUnchangedMessage]] is * given back. If a fast reply is not possible, [[None]] is given back. * Additionally, the listener are informed about the result. @@ -1292,7 +1293,7 @@ protected trait ParticipantAgentFundamentals[ case Some((mostRecentRequestTick, latestProvidedValues)) if mostRecentRequestTick == requestTick => /* A request for this tick has already been answered. Check, if it has been the same request. - * if it has been the same request we wanna answer with the same values afterwards, this data MUST always + * if it has been the same request we want to answer with the same values afterwards, this data MUST always * be available when we already provided data for this tick */ baseStateData match { case externalBaseStateData: FromOutsideBaseStateData[M, PD] => @@ -1475,7 +1476,7 @@ protected trait ParticipantAgentFundamentals[ determineTickWindow(requestTick, requestValueStore) /* All participants simulation results between the most recent simulation tick BEFORE or at the beginning of the - * averaging window and it's end (both including) are relevant for averaging the simulated primary data */ + * averaging window, and it's end (both including) are relevant for averaging the simulated primary data */ val firstRelevantTick = determineFirstRelevantTick( averagingWindowStart, resultValueStore, @@ -1753,7 +1754,7 @@ protected trait ParticipantAgentFundamentals[ * @param tick * Tick, the result belongs to * @param result - * The result to build a event for + * The result to build an event for * @param outputConfig * Configuration of the output behaviour */ @@ -1851,7 +1852,7 @@ protected trait ParticipantAgentFundamentals[ } /** To clean up agent value stores after power flow convergence. This is - * necessary for agents whose results are time dependent e.g. storage agents + * necessary for agents whose results are time-dependent e.g. storage agents * * @param baseStateData * Basic state data diff --git a/src/main/scala/edu/ie3/simona/agent/participant/evcs/EvcsAgentFundamentals.scala b/src/main/scala/edu/ie3/simona/agent/participant/evcs/EvcsAgentFundamentals.scala index 69b072e55b..8894a511ff 100644 --- a/src/main/scala/edu/ie3/simona/agent/participant/evcs/EvcsAgentFundamentals.scala +++ b/src/main/scala/edu/ie3/simona/agent/participant/evcs/EvcsAgentFundamentals.scala @@ -96,7 +96,7 @@ protected trait EvcsAgentFundamentals * @param simulationEndDate * Real world time date time, when the simulation ends * @param resolution - * Agents regular time bin it wants to be triggered e.g one hour + * Agents regular time bin it wants to be triggered e.g. one hour * @param requestVoltageDeviationThreshold * Threshold, after which two nodal voltage magnitudes from participant * power requests for the same tick are considered to be different diff --git a/src/main/scala/edu/ie3/simona/agent/participant/fixedfeedin/FixedFeedInAgentFundamentals.scala b/src/main/scala/edu/ie3/simona/agent/participant/fixedfeedin/FixedFeedInAgentFundamentals.scala index 5d3a2d6805..0b8845d80c 100644 --- a/src/main/scala/edu/ie3/simona/agent/participant/fixedfeedin/FixedFeedInAgentFundamentals.scala +++ b/src/main/scala/edu/ie3/simona/agent/participant/fixedfeedin/FixedFeedInAgentFundamentals.scala @@ -92,7 +92,7 @@ protected trait FixedFeedInAgentFundamentals * @param simulationEndDate * Real world time date time, when the simulation ends * @param resolution - * Agents regular time bin it wants to be triggered e.g one hour + * Agents regular time bin it wants to be triggered e.g. one hour * @param requestVoltageDeviationThreshold * Threshold, after which two nodal voltage magnitudes from participant * power requests for the same tick are considered to be different @@ -132,10 +132,10 @@ protected trait FixedFeedInAgentFundamentals val lastTickInSimulation = simulationEndDate.toTick(simulationStartDate) val dataTicks = /* As participant agents always return their last known operation point on request, it is sufficient - * to let a fixed fixed in model determine it's operation point on: + * to let a FixedFeedIn-Model determine its operation point on: * 1) The first tick of the simulation - * 2) The tick, it turns on (in time dependent operation) - * 3) The tick, it turns off (in time dependent operation) + * 2) The tick, it turns on (in time-dependent operation) + * 3) The tick, it turns off (in time-dependent operation) * Coinciding ticks are summarized and the last tick is removed, as the change in operation status * doesn't affect anything then */ SortedSet[Long]( diff --git a/src/main/scala/edu/ie3/simona/agent/participant/load/LoadAgentFundamentals.scala b/src/main/scala/edu/ie3/simona/agent/participant/load/LoadAgentFundamentals.scala index 78519a54c1..f7cb1d695e 100644 --- a/src/main/scala/edu/ie3/simona/agent/participant/load/LoadAgentFundamentals.scala +++ b/src/main/scala/edu/ie3/simona/agent/participant/load/LoadAgentFundamentals.scala @@ -103,7 +103,7 @@ protected trait LoadAgentFundamentals[LD <: LoadRelevantData, LM <: LoadModel[ * @param simulationEndDate * Real world time date time, when the simulation ends * @param resolution - * Agents regular time bin it wants to be triggered e.g one hour + * Agents regular time bin it wants to be triggered e.g. one hour * @param requestVoltageDeviationThreshold * Threshold, after which two nodal voltage magnitudes from participant * power requests for the same tick are considered to be different @@ -145,10 +145,10 @@ protected trait LoadAgentFundamentals[LD <: LoadRelevantData, LM <: LoadModel[ /* If no secondary data is needed (implicitly by fixed load model), add activation ticks for the simple model */ case fixedLoadModel: FixedLoadModel => /* As participant agents always return their last known operation point on request, it is sufficient - * to let a fixed load model determine it's operation point on: + * to let a fixed load model determine its operation point on: * 1) The first tick of the simulation - * 2) The tick, it turns on (in time dependent operation) - * 3) The tick, it turns off (in time dependent operation) + * 2) The tick, it turns on (in time-dependent operation) + * 3) The tick, it turns off (in time-dependent operation) * Coinciding ticks are summarized and the last tick is removed, as the change in operation status * doesn't affect anything then */ SortedSet[Long]( diff --git a/src/main/scala/edu/ie3/simona/agent/participant/pv/PvAgentFundamentals.scala b/src/main/scala/edu/ie3/simona/agent/participant/pv/PvAgentFundamentals.scala index ce152a3d7e..52f0a76e24 100644 --- a/src/main/scala/edu/ie3/simona/agent/participant/pv/PvAgentFundamentals.scala +++ b/src/main/scala/edu/ie3/simona/agent/participant/pv/PvAgentFundamentals.scala @@ -94,7 +94,7 @@ protected trait PvAgentFundamentals * @param simulationEndDate * Real world time date time, when the simulation ends * @param resolution - * Agents regular time bin it wants to be triggered e.g one hour + * Agents regular time bin it wants to be triggered e.g. one hour * @param requestVoltageDeviationThreshold * Threshold, after which two nodal voltage magnitudes from participant * power requests for the same tick are considered to be different @@ -210,7 +210,7 @@ protected trait PvAgentFundamentals tick - dataTick case _ => /* At the first tick, we are not able to determine the tick interval from last tick - * (since there is none). Then we use a fall back pv stem distance. */ + * (since there is none). Then we use a fallback pv stem distance. */ FALLBACK_WEATHER_STEM_DISTANCE } diff --git a/src/main/scala/edu/ie3/simona/agent/participant/statedata/BaseStateData.scala b/src/main/scala/edu/ie3/simona/agent/participant/statedata/BaseStateData.scala index 96758a2d16..9627ee1578 100644 --- a/src/main/scala/edu/ie3/simona/agent/participant/statedata/BaseStateData.scala +++ b/src/main/scala/edu/ie3/simona/agent/participant/statedata/BaseStateData.scala @@ -51,7 +51,7 @@ trait BaseStateData[+PD <: PrimaryDataWithApparentPower[PD]] */ val modelUuid: UUID - /** By default the agent should be triggered in the same tick, where data is + /** By default, the agent should be triggered in the same tick, where data is * incoming from primary or secondary sources. However, if there is no other * information needed, we might have the need to schedule ourselves for * activation triggers diff --git a/src/main/scala/edu/ie3/simona/agent/participant/wec/WecAgentFundamentals.scala b/src/main/scala/edu/ie3/simona/agent/participant/wec/WecAgentFundamentals.scala index 9edf6f2ae8..5b43263925 100644 --- a/src/main/scala/edu/ie3/simona/agent/participant/wec/WecAgentFundamentals.scala +++ b/src/main/scala/edu/ie3/simona/agent/participant/wec/WecAgentFundamentals.scala @@ -89,7 +89,7 @@ protected trait WecAgentFundamentals * @param simulationEndDate * Real world time date time, when the simulation ends * @param resolution - * Agents regular time bin it wants to be triggered e.g one hour + * Agents regular time bin it wants to be triggered e.g. one hour * @param requestVoltageDeviationThreshold * Threshold, after which two nodal voltage magnitudes from participant * power requests for the same tick are considered to be different diff --git a/src/main/scala/edu/ie3/simona/config/ConfigFailFast.scala b/src/main/scala/edu/ie3/simona/config/ConfigFailFast.scala index 3437944c78..8192814ae3 100644 --- a/src/main/scala/edu/ie3/simona/config/ConfigFailFast.scala +++ b/src/main/scala/edu/ie3/simona/config/ConfigFailFast.scala @@ -314,8 +314,8 @@ case object ConfigFailFast extends LazyLogging { ) } - /** Check participants's basic runtime configurations, as well as in default - * as in individual configs. This comprises + /** Check participants' basic runtime configurations, as well as in default as + * in individual configs. This comprises * i.e. uuid and scaling factor */ private def checkBaseRuntimeConfigs( @@ -663,7 +663,7 @@ case object ConfigFailFast extends LazyLogging { } - /** Check the config sub tree for output parameterization + /** Check the config subtree for output parameterization * * @param subConfig * Output sub config tree for participants @@ -685,7 +685,7 @@ case object ConfigFailFast extends LazyLogging { checkIndividualOutputConfigs(subConfig.individualConfigs) } - /** Check the config sub tree for output parameterization + /** Check the config subtree for output parameterization * * @param subConfig * Output sub config tree for participants diff --git a/src/main/scala/edu/ie3/simona/event/Event.scala b/src/main/scala/edu/ie3/simona/event/Event.scala index 2efb82b76e..dad24a314f 100644 --- a/src/main/scala/edu/ie3/simona/event/Event.scala +++ b/src/main/scala/edu/ie3/simona/event/Event.scala @@ -7,7 +7,7 @@ package edu.ie3.simona.event /** Trait that should be mixed into each event in [[edu.ie3.simona.event]] to - * provide an easy access to it's name + * provide easy access to its name */ trait Event { diff --git a/src/main/scala/edu/ie3/simona/event/RuntimeEvent.scala b/src/main/scala/edu/ie3/simona/event/RuntimeEvent.scala index da02b9c258..44d092ea0f 100644 --- a/src/main/scala/edu/ie3/simona/event/RuntimeEvent.scala +++ b/src/main/scala/edu/ie3/simona/event/RuntimeEvent.scala @@ -21,7 +21,7 @@ object RuntimeEvent { /** Indicates that the scheduler has finished a pre-defined advancement in * ticks and is ready to carry out the next task. In contrast to the * [[CheckWindowPassed]] event, whenever a [[Ready]] event is scheduled, the - * scheduled of [[edu.ie3.simona.scheduler.Scheduler]] will be stopped and + * schedule of [[edu.ie3.simona.scheduler.Scheduler]] will be stopped and * further commands are necessary to continue the schedule. * * @param tick diff --git a/src/main/scala/edu/ie3/simona/exceptions/WeatherServiceException.scala b/src/main/scala/edu/ie3/simona/exceptions/WeatherServiceException.scala index 08d109a2a6..b1291f6694 100644 --- a/src/main/scala/edu/ie3/simona/exceptions/WeatherServiceException.scala +++ b/src/main/scala/edu/ie3/simona/exceptions/WeatherServiceException.scala @@ -45,7 +45,7 @@ object WeatherServiceException { private val cause: Throwable = None.orNull, ) extends WeatherServiceException(msg, cause) - /** Exception to be thrown if the registration of the an agent fails + /** Exception to be thrown if the registration of an agent fails * @param msg * Message to prompt to the end user * @param cause diff --git a/src/main/scala/edu/ie3/simona/io/result/plain/PlainResult.scala b/src/main/scala/edu/ie3/simona/io/result/plain/PlainResult.scala index c85cd167af..4a9e9a4c8d 100644 --- a/src/main/scala/edu/ie3/simona/io/result/plain/PlainResult.scala +++ b/src/main/scala/edu/ie3/simona/io/result/plain/PlainResult.scala @@ -10,8 +10,8 @@ import java.util.UUID /** Results that are sent out with Kafka and avro should use this trait and * corresponding implementing classes, since these give more control over - * attribute types and naming and they include sim run id. Plain result objects - * can be created by [[PlainWriter]]. + * attribute types and naming, and they include sim run id. Plain result + * objects can be created by [[PlainWriter]]. */ sealed trait PlainResult diff --git a/src/main/scala/edu/ie3/simona/main/RunSimona.scala b/src/main/scala/edu/ie3/simona/main/RunSimona.scala index c255990a05..b08db66361 100644 --- a/src/main/scala/edu/ie3/simona/main/RunSimona.scala +++ b/src/main/scala/edu/ie3/simona/main/RunSimona.scala @@ -86,8 +86,8 @@ trait RunSimona[T <: SimonaSetup] extends LazyLogging { } } - /** Method to be implemented to setup everything that is necessary for a - * simulations. This is by creating an instance of [[SimonaSetup]] + /** Method to be implemented to set up everything that is necessary for a + * simulation. This is by creating an instance of [[SimonaSetup]] * implementation * * @param args diff --git a/src/main/scala/edu/ie3/simona/model/SystemComponent.scala b/src/main/scala/edu/ie3/simona/model/SystemComponent.scala index 623e5a58c3..7408c8cbef 100644 --- a/src/main/scala/edu/ie3/simona/model/SystemComponent.scala +++ b/src/main/scala/edu/ie3/simona/model/SystemComponent.scala @@ -28,7 +28,7 @@ import scala.util.{Failure, Success, Try} * @param uuid * the element's uuid * @param id - * the element's human readable id + * the element's human-readable id * @param operationInterval * Interval, in which the system is in operation */ diff --git a/src/main/scala/edu/ie3/simona/model/control/TransformerControlGroupModel.scala b/src/main/scala/edu/ie3/simona/model/control/TransformerControlGroupModel.scala index 2354770480..c6d7471787 100644 --- a/src/main/scala/edu/ie3/simona/model/control/TransformerControlGroupModel.scala +++ b/src/main/scala/edu/ie3/simona/model/control/TransformerControlGroupModel.scala @@ -134,7 +134,7 @@ object TransformerControlGroupModel { * Array of all regulation requests * @return * None in case of contrary requests, else the highest or lowest voltage - * depending of the direction for regulation + * depending on the direction for regulation */ private def harmonizeRegulationNeeds( regulationRequests: Array[Dimensionless] diff --git a/src/main/scala/edu/ie3/simona/model/em/PrioritizedFlexStrat.scala b/src/main/scala/edu/ie3/simona/model/em/PrioritizedFlexStrat.scala index 98162db86c..3d934e21f3 100644 --- a/src/main/scala/edu/ie3/simona/model/em/PrioritizedFlexStrat.scala +++ b/src/main/scala/edu/ie3/simona/model/em/PrioritizedFlexStrat.scala @@ -122,7 +122,7 @@ final case class PrioritizedFlexStrat(curtailRegenerative: Boolean) (issueCtrlMsgs, Some(remainingExcessPower)) } else if (remainingExcessPower < flexPotential) { // we cannot cover the excess feed-in with just this flexibility, - // thus use all of the available flexibility and continue + // thus use all the available flexibility and continue ( issueCtrlMsgs :+ (inputModel.getUuid, flexOption.max), Some(remainingExcessPower - flexPotential), @@ -171,7 +171,7 @@ final case class PrioritizedFlexStrat(curtailRegenerative: Boolean) (issueCtrlMsgs, Some(remainingExcessPower)) } else if (remainingExcessPower > flexPotential) { // we cannot cover the excess load with just this flexibility, - // thus use all of the available flexibility and continue + // thus use all the available flexibility and continue ( issueCtrlMsgs :+ (inputModel.getUuid, flexOption.min), Some(remainingExcessPower - flexPotential), diff --git a/src/main/scala/edu/ie3/simona/model/grid/GridModel.scala b/src/main/scala/edu/ie3/simona/model/grid/GridModel.scala index af90cfc344..16285b9317 100644 --- a/src/main/scala/edu/ie3/simona/model/grid/GridModel.scala +++ b/src/main/scala/edu/ie3/simona/model/grid/GridModel.scala @@ -194,7 +194,7 @@ object GridModel { /* Nodes that are connected via a [closed] switch map to the same idx as we fuse them during the power flow. - Therefore the admittance matrix has to be of the size of the distinct node idxs. + Therefore, the admittance matrix has to be of the size of the distinct node idxs. */ val linesAdmittanceMatrix = buildAssetAdmittanceMatrix( nodeUuidToIndexMap, @@ -332,7 +332,7 @@ object GridModel { } /** This checks whether the provided grid model graph is connected, that means - * if every node can be reached from every other node trough a sequence of + * if every node can be reached from every other node through a sequence of * edges. Also checks for referenced nodes that are missing. This check * considers the state (enabled/disabled) of the elements. * @@ -605,7 +605,7 @@ object GridModel { /** Check and validates the grid. Especially the consistency of the grid * model the connectivity of the grid model if there is InitData for - * superior or inferior GridGates if there exits voltage measurements for + * superior or inferior GridGates if there exists voltage measurements for * transformerControlGroups */ diff --git a/src/main/scala/edu/ie3/simona/model/grid/LineModel.scala b/src/main/scala/edu/ie3/simona/model/grid/LineModel.scala index 60a2621630..7c643a2298 100644 --- a/src/main/scala/edu/ie3/simona/model/grid/LineModel.scala +++ b/src/main/scala/edu/ie3/simona/model/grid/LineModel.scala @@ -28,7 +28,7 @@ import java.util.UUID * @param uuid * the element's uuid * @param id - * the element's human readable id + * the element's human-readable id * @param operationInterval * Interval, in which the system is in operation * @param nodeAUuid diff --git a/src/main/scala/edu/ie3/simona/model/grid/NodeModel.scala b/src/main/scala/edu/ie3/simona/model/grid/NodeModel.scala index 506ea804a1..af26beb12b 100644 --- a/src/main/scala/edu/ie3/simona/model/grid/NodeModel.scala +++ b/src/main/scala/edu/ie3/simona/model/grid/NodeModel.scala @@ -23,7 +23,7 @@ import java.util.UUID * @param uuid * the element's uuid * @param id - * the element's human readable id + * the element's human-readable id * @param operationInterval * Interval, in which the system is in operation * @param isSlack diff --git a/src/main/scala/edu/ie3/simona/model/grid/RefSystem.scala b/src/main/scala/edu/ie3/simona/model/grid/RefSystem.scala index 40319e699a..d9a6090601 100644 --- a/src/main/scala/edu/ie3/simona/model/grid/RefSystem.scala +++ b/src/main/scala/edu/ie3/simona/model/grid/RefSystem.scala @@ -153,7 +153,7 @@ final case class RefSystem private ( /** Converts a provided voltage value from physical SI value into p.u. value * * @param vInSi - * real or imaginary part of a unreferenced physical SI value + * real or imaginary part of an unreferenced physical SI value * @return * referenced voltage value in p.u. */ diff --git a/src/main/scala/edu/ie3/simona/model/grid/SwitchModel.scala b/src/main/scala/edu/ie3/simona/model/grid/SwitchModel.scala index 5a5a457a5f..8a947e9ee0 100644 --- a/src/main/scala/edu/ie3/simona/model/grid/SwitchModel.scala +++ b/src/main/scala/edu/ie3/simona/model/grid/SwitchModel.scala @@ -22,7 +22,7 @@ import scala.util.{Failure, Success, Try} * @param uuid * the element's uuid * @param id - * the element's human readable id + * the element's human-readable id * @param operationInterval * Interval, in which the system is in operation * @param nodeAUuid diff --git a/src/main/scala/edu/ie3/simona/model/grid/Transformer3wModel.scala b/src/main/scala/edu/ie3/simona/model/grid/Transformer3wModel.scala index 8f61c2a897..46ce7f3e44 100644 --- a/src/main/scala/edu/ie3/simona/model/grid/Transformer3wModel.scala +++ b/src/main/scala/edu/ie3/simona/model/grid/Transformer3wModel.scala @@ -49,7 +49,7 @@ import scala.math.BigDecimal.RoundingMode * @param uuid * the element's uuid * @param id - * the element's human readable id + * the element's human-readable id * @param operationInterval * Interval, in which the system is in operation * @param hvNodeUuid diff --git a/src/main/scala/edu/ie3/simona/model/grid/TransformerModel.scala b/src/main/scala/edu/ie3/simona/model/grid/TransformerModel.scala index ee03ef837a..81682693fc 100644 --- a/src/main/scala/edu/ie3/simona/model/grid/TransformerModel.scala +++ b/src/main/scala/edu/ie3/simona/model/grid/TransformerModel.scala @@ -33,7 +33,7 @@ import scala.math.BigDecimal.RoundingMode * @param uuid * the element's uuid * @param id - * the element's human readable id + * the element's human-readable id * @param operationInterval * Interval, in which the system is in operation * @param hvNodeUuid diff --git a/src/main/scala/edu/ie3/simona/model/grid/TransformerTapping.scala b/src/main/scala/edu/ie3/simona/model/grid/TransformerTapping.scala index 809e7c5f8f..a1679a54f2 100644 --- a/src/main/scala/edu/ie3/simona/model/grid/TransformerTapping.scala +++ b/src/main/scala/edu/ie3/simona/model/grid/TransformerTapping.scala @@ -17,7 +17,7 @@ import tech.units.indriya.quantity.Quantities * necessary to override updateTapPos (e.g. in [[Transformer3wModel]]). The * provided [[TransformerTappingModel]] *should* be protected and not be * accessible from outside to prevent direct access to internal functions! - * Instead all the functions provided here should be used for tap position + * Instead, all the functions provided here should be used for tap position * manipulation. */ trait TransformerTapping { diff --git a/src/main/scala/edu/ie3/simona/model/grid/TransformerTappingModel.scala b/src/main/scala/edu/ie3/simona/model/grid/TransformerTappingModel.scala index 602259cec2..a8534d7b7b 100644 --- a/src/main/scala/edu/ie3/simona/model/grid/TransformerTappingModel.scala +++ b/src/main/scala/edu/ie3/simona/model/grid/TransformerTappingModel.scala @@ -114,7 +114,7 @@ final case class TransformerTappingModel( * inverted. * * Furthermore, this method also considers the transformer not being able to - * change it's tap position anymore. Hence, 0 is returned, if no change is + * change its tap position anymore. Hence, 0 is returned, if no change is * possible anymore. * * @param vChangeRequest diff --git a/src/main/scala/edu/ie3/simona/model/participant/BMModel.scala b/src/main/scala/edu/ie3/simona/model/participant/BMModel.scala index 19fbe3e601..e1c9ed715a 100644 --- a/src/main/scala/edu/ie3/simona/model/participant/BMModel.scala +++ b/src/main/scala/edu/ie3/simona/model/participant/BMModel.scala @@ -94,7 +94,7 @@ final case class BMModel( applyLoadGradient(pEl) } - /** Calculates first time dependent factor for heat demand + /** Calculates first time-dependent factor for heat demand * @param time * the time * @return @@ -114,7 +114,7 @@ final case class BMModel( } } - /** Calculates second time dependent factor for heat demand + /** Calculates second time-dependent factor for heat demand * @param time * the time * @return diff --git a/src/main/scala/edu/ie3/simona/model/participant/ChpModel.scala b/src/main/scala/edu/ie3/simona/model/participant/ChpModel.scala index 56bd446412..c0336b0ddc 100644 --- a/src/main/scala/edu/ie3/simona/model/participant/ChpModel.scala +++ b/src/main/scala/edu/ie3/simona/model/participant/ChpModel.scala @@ -31,7 +31,7 @@ import java.util.UUID * @param uuid * the element's uuid * @param id - * the element's human readable id + * the element's human-readable id * @param operationInterval * Interval, in which the system is in operation * @param qControl diff --git a/src/main/scala/edu/ie3/simona/model/participant/FixedFeedInModel.scala b/src/main/scala/edu/ie3/simona/model/participant/FixedFeedInModel.scala index dbda236e4c..d5cd82c731 100644 --- a/src/main/scala/edu/ie3/simona/model/participant/FixedFeedInModel.scala +++ b/src/main/scala/edu/ie3/simona/model/participant/FixedFeedInModel.scala @@ -29,7 +29,7 @@ import java.util.UUID * @param uuid * the element's uuid * @param id - * the element's human readable id + * the element's human-readable id * @param operationInterval * Interval, in which the system is in operation * @param qControl diff --git a/src/main/scala/edu/ie3/simona/model/participant/HpModel.scala b/src/main/scala/edu/ie3/simona/model/participant/HpModel.scala index 8a6963e94a..1bd5287c75 100644 --- a/src/main/scala/edu/ie3/simona/model/participant/HpModel.scala +++ b/src/main/scala/edu/ie3/simona/model/participant/HpModel.scala @@ -34,7 +34,7 @@ import java.util.UUID * @param uuid * the element's uuid * @param id - * the element's human readable id + * the element's human-readable id * @param operationInterval * Interval, in which the system is in operation * @param qControl diff --git a/src/main/scala/edu/ie3/simona/model/participant/StorageModel.scala b/src/main/scala/edu/ie3/simona/model/participant/StorageModel.scala index 742f5d8f68..82744e7824 100644 --- a/src/main/scala/edu/ie3/simona/model/participant/StorageModel.scala +++ b/src/main/scala/edu/ie3/simona/model/participant/StorageModel.scala @@ -52,7 +52,7 @@ final case class StorageModel( /** Tolerance for power comparisons. With very small (dis-)charging powers, * problems can occur when calculating the future tick at which storage is * full or empty. For sufficiently large time frames, the maximum Long value - * ([[Long.MaxValue]]) can be exceeded, thus the Long value overflows and we + * ([[Long.MaxValue]]) can be exceeded, thus the Long value overflows, and we * get undefined behavior. * * Thus, small (dis-)charging powers compared to storage capacity have to be diff --git a/src/main/scala/edu/ie3/simona/model/participant/SystemParticipant.scala b/src/main/scala/edu/ie3/simona/model/participant/SystemParticipant.scala index 44c70539d7..f245923356 100644 --- a/src/main/scala/edu/ie3/simona/model/participant/SystemParticipant.scala +++ b/src/main/scala/edu/ie3/simona/model/participant/SystemParticipant.scala @@ -30,7 +30,7 @@ import java.util.UUID * @param uuid * the element's uuid * @param id - * the element's human readable id + * the element's human-readable id * @param operationInterval * Interval, in which the system is in operation * @param qControl diff --git a/src/main/scala/edu/ie3/simona/model/participant/WecModel.scala b/src/main/scala/edu/ie3/simona/model/participant/WecModel.scala index bffdd7fdae..4ecc4e5b5b 100644 --- a/src/main/scala/edu/ie3/simona/model/participant/WecModel.scala +++ b/src/main/scala/edu/ie3/simona/model/participant/WecModel.scala @@ -41,7 +41,7 @@ import scala.collection.SortedSet * @param uuid * the element's uuid * @param id - * the element's human readable id + * the element's human-readable id * @param operationInterval * Interval, in which the system is in operation * @param qControl @@ -146,7 +146,7 @@ final case class WecModel( ) } - /** The coefficient is dependent on the wind velocity v. Therefore use v to + /** The coefficient is dependent on the wind velocity v. Therefore, use v to * determine the betz coefficient cₚ. * * @param windVelocity diff --git a/src/main/scala/edu/ie3/simona/model/participant/control/QControl.scala b/src/main/scala/edu/ie3/simona/model/participant/control/QControl.scala index 25504c2fff..391d4bca7c 100644 --- a/src/main/scala/edu/ie3/simona/model/participant/control/QControl.scala +++ b/src/main/scala/edu/ie3/simona/model/participant/control/QControl.scala @@ -50,7 +50,7 @@ sealed trait QControl { ): Power => ReactivePower } -/** Object to create a [[QControl]]. Currently the following QControls +/** Object to create a [[QControl]]. Currently, the following QControls * characteristics are supported. * - cosine-Phi-Fixed * - cosine-Phi(P) diff --git a/src/main/scala/edu/ie3/simona/model/participant/evcs/EvcsModel.scala b/src/main/scala/edu/ie3/simona/model/participant/evcs/EvcsModel.scala index 4f0e4d9730..57a8f4c883 100644 --- a/src/main/scala/edu/ie3/simona/model/participant/evcs/EvcsModel.scala +++ b/src/main/scala/edu/ie3/simona/model/participant/evcs/EvcsModel.scala @@ -47,7 +47,7 @@ import scala.collection.immutable.SortedSet * @param uuid * the element's uuid * @param id - * the element's human readable id + * the element's human-readable id * @param operationInterval * Interval, in which the system is in operation * @param simulationStartDate @@ -194,7 +194,7 @@ final case class EvcsModel( state.evs } - /** Charge the given EV under consideration a applicable schedule + /** Charge the given EV under consideration an applicable schedule * * @param ev * Electric vehicle to charge @@ -271,7 +271,7 @@ final case class EvcsModel( /* Filter for entries, that end after the last schedule application and that start before the current tick. Entries that end at lastTick are not included because schedule - intervals are open at the right hand side. + intervals are open on the right hand side. Entries that start at currentTick are not included because these will be calculated with the next state. */ diff --git a/src/main/scala/edu/ie3/simona/model/participant/load/FixedLoadModel.scala b/src/main/scala/edu/ie3/simona/model/participant/load/FixedLoadModel.scala index d1ab4bd657..cc4bc82c65 100644 --- a/src/main/scala/edu/ie3/simona/model/participant/load/FixedLoadModel.scala +++ b/src/main/scala/edu/ie3/simona/model/participant/load/FixedLoadModel.scala @@ -28,7 +28,7 @@ import java.util.UUID * @param uuid * unique identifier * @param id - * human readable id + * human-readable id * @param operationInterval * Interval, in which the system is in operation * @param qControl diff --git a/src/main/scala/edu/ie3/simona/model/participant/load/profile/LoadProfileStore.scala b/src/main/scala/edu/ie3/simona/model/participant/load/profile/LoadProfileStore.scala index f1e7d54f62..63e4a0d4a5 100644 --- a/src/main/scala/edu/ie3/simona/model/participant/load/profile/LoadProfileStore.scala +++ b/src/main/scala/edu/ie3/simona/model/participant/load/profile/LoadProfileStore.scala @@ -45,7 +45,7 @@ class LoadProfileStore private (val reader: Reader) { ) /** Returns the load profiles entry (average power consumption for the - * following quarter hour) for given time and load profile. + * following quarter-hour) for given time and load profile. * * @param time * the requested time @@ -77,7 +77,7 @@ class LoadProfileStore private (val reader: Reader) { } } - /** Returns the maximum average power consumption per quarter hour for a given + /** Returns the maximum average power consumption per quarter-hour for a given * load profile, calculated over all seasons and weekday types of given load * profile * @@ -171,7 +171,7 @@ object LoadProfileStore extends LazyLogging { val headerKeys: util.List[String] = parser.getHeaderNames - // skip last column "quarter hour" + // skip last column "quarter-hour" (for (i <- Range(0, headerKeys.size() - 1)) yield { val headerKey = headerKeys.get(i) val profileKey = LoadProfileKey(headerKey) diff --git a/src/main/scala/edu/ie3/simona/model/participant/load/profile/ProfileLoadModel.scala b/src/main/scala/edu/ie3/simona/model/participant/load/profile/ProfileLoadModel.scala index 5e919a0064..e94f50867f 100644 --- a/src/main/scala/edu/ie3/simona/model/participant/load/profile/ProfileLoadModel.scala +++ b/src/main/scala/edu/ie3/simona/model/participant/load/profile/ProfileLoadModel.scala @@ -25,7 +25,7 @@ import java.util.UUID * @param uuid * unique identifier * @param id - * human readable id + * human-readable id * @param operationInterval * Interval, in which the system is in operation * @param qControl diff --git a/src/main/scala/edu/ie3/simona/model/participant/load/profile/TypeDayProfile.scala b/src/main/scala/edu/ie3/simona/model/participant/load/profile/TypeDayProfile.scala index dd2fcb6a18..22358772b1 100644 --- a/src/main/scala/edu/ie3/simona/model/participant/load/profile/TypeDayProfile.scala +++ b/src/main/scala/edu/ie3/simona/model/participant/load/profile/TypeDayProfile.scala @@ -26,8 +26,8 @@ final case class TypeDayProfile(private val values: Array[Double]) { "You may only instantiate type day parameters with 96 values." ) - /** Returns a value for given time. If time is not a 15 min step, it is - * rounded up to the next 15 min slice. + /** Returns a value for given time. If time is not a 15-min step, it is + * rounded up to the next 15-min slice. * * @param time * the time diff --git a/src/main/scala/edu/ie3/simona/model/participant/load/random/RandomLoadModel.scala b/src/main/scala/edu/ie3/simona/model/participant/load/random/RandomLoadModel.scala index a09e9bc8ff..4409d62cf2 100644 --- a/src/main/scala/edu/ie3/simona/model/participant/load/random/RandomLoadModel.scala +++ b/src/main/scala/edu/ie3/simona/model/participant/load/random/RandomLoadModel.scala @@ -33,7 +33,7 @@ import scala.util.Random * @param uuid * unique identifier * @param id - * human readable id + * human-readable id * @param operationInterval * Interval, in which the system is in operation * @param qControl diff --git a/src/main/scala/edu/ie3/simona/model/participant/load/random/RandomLoadParamStore.scala b/src/main/scala/edu/ie3/simona/model/participant/load/random/RandomLoadParamStore.scala index 36635ae940..33fb57a38a 100644 --- a/src/main/scala/edu/ie3/simona/model/participant/load/random/RandomLoadParamStore.scala +++ b/src/main/scala/edu/ie3/simona/model/participant/load/random/RandomLoadParamStore.scala @@ -105,7 +105,7 @@ case object RandomLoadParamStore extends LazyLogging { } catch { case e: FileIOException => throw new FileIOException( - s"Cannot determine random load parameters for day type '$dayType' and quarter hour '$quartHour'", + s"Cannot determine random load parameters for day type '$dayType' and quarter-hour '$quartHour'", e, ) } @@ -115,7 +115,7 @@ case object RandomLoadParamStore extends LazyLogging { case (_, quarterHour, randomLoadParameters) => (quarterHour, randomLoadParameters) } // Group entries by day type - .map { // For each day type, sort the parameters by quarter hour and build a type day parameter object from it + .map { // For each day type, sort the parameters by quarter-hour and build a type day parameter object from it case (dayType, quarterHourToParameters) => dayType -> TypeDayParameters( quarterHourToParameters.sortBy(_._1).map(_._2).toArray @@ -124,13 +124,13 @@ case object RandomLoadParamStore extends LazyLogging { } /** Builds a descriptor tree, which gives information what to find where in - * the file. Each head line element breaks down to encoded information about + * the file. Each headline element breaks down to encoded information about * the probability density function parameter and the addressed day type. All - * head line elements are treated this way and a mapping from day type to + * headline elements are treated this way and a mapping from day type to * column position of parameter is build. * * @param headerElements - * List of head line elements + * List of headline elements * @return * Mapping from day type to a mapping from parameter to column index */ diff --git a/src/main/scala/edu/ie3/simona/model/participant/load/random/TypeDayParameters.scala b/src/main/scala/edu/ie3/simona/model/participant/load/random/TypeDayParameters.scala index 36360ff600..57210c68b2 100644 --- a/src/main/scala/edu/ie3/simona/model/participant/load/random/TypeDayParameters.scala +++ b/src/main/scala/edu/ie3/simona/model/participant/load/random/TypeDayParameters.scala @@ -12,8 +12,8 @@ import edu.ie3.simona.model.participant.load.DayType import edu.ie3.util.TimeUtil /** Stores a slice of random load parameters, that comprises a whole day (96 - * quarter hours). The data describes a typical day, that can unequivocally be - * identified by it's [[DayType]]. + * quarter-hours). The data describes a typical day, that can unequivocally be + * identified by its [[DayType]]. * * @param values * 96 quarter-hour values for this day type @@ -26,8 +26,8 @@ final case class TypeDayParameters( s"You may only instantiate type day parameters with 96 values. Apparent: ${values.length}." ) - /** Returns a value for given time. If time is not a 15 min step, it is - * rounded up to the next 15 min slice. + /** Returns a value for given time. If time is not a 15-min step, it is + * rounded up to the next 15-min slice. * * @param time * the time diff --git a/src/main/scala/edu/ie3/simona/model/system/Characteristic.scala b/src/main/scala/edu/ie3/simona/model/system/Characteristic.scala index 2088ca6cdc..e4b7758b8f 100644 --- a/src/main/scala/edu/ie3/simona/model/system/Characteristic.scala +++ b/src/main/scala/edu/ie3/simona/model/system/Characteristic.scala @@ -14,7 +14,7 @@ import squants.Quantity import scala.collection.SortedSet import scala.reflect.ClassTag -/** Describes a mapping of a x-y-pairs with possibility to interpolate the y +/** Describes a mapping of an x-y-pairs with possibility to interpolate the y * values based on the provided x value */ trait Characteristic[A <: Quantity[A], O <: Quantity[O]] { diff --git a/src/main/scala/edu/ie3/simona/model/thermal/CylindricalThermalStorage.scala b/src/main/scala/edu/ie3/simona/model/thermal/CylindricalThermalStorage.scala index 7640505bb1..e49dde2633 100644 --- a/src/main/scala/edu/ie3/simona/model/thermal/CylindricalThermalStorage.scala +++ b/src/main/scala/edu/ie3/simona/model/thermal/CylindricalThermalStorage.scala @@ -40,7 +40,7 @@ import java.util.UUID * @param uuid * the element's uuid * @param id - * the element's human readable id + * the element's human-readable id * @param operatorInput * Operator input * @param operationTime diff --git a/src/main/scala/edu/ie3/simona/model/thermal/ThermalGrid.scala b/src/main/scala/edu/ie3/simona/model/thermal/ThermalGrid.scala index 747e694243..50f56e1849 100644 --- a/src/main/scala/edu/ie3/simona/model/thermal/ThermalGrid.scala +++ b/src/main/scala/edu/ie3/simona/model/thermal/ThermalGrid.scala @@ -446,7 +446,7 @@ final case class ThermalGrid( case _ => (maybeHouseState, maybeStorageState) } - /** Convert the given state of the thermal grid into result models of it's + /** Convert the given state of the thermal grid into result models of its * constituent models * * @param currentTick diff --git a/src/main/scala/edu/ie3/simona/model/thermal/ThermalHouse.scala b/src/main/scala/edu/ie3/simona/model/thermal/ThermalHouse.scala index aaae60aeab..e0fd7024f7 100644 --- a/src/main/scala/edu/ie3/simona/model/thermal/ThermalHouse.scala +++ b/src/main/scala/edu/ie3/simona/model/thermal/ThermalHouse.scala @@ -37,7 +37,7 @@ import java.util.UUID * @param uuid * the element's uuid * @param id - * the element's human readable id + * the element's human-readable id * @param operatorInput * Operator input * @param operationTime diff --git a/src/main/scala/edu/ie3/simona/model/thermal/ThermalSink.scala b/src/main/scala/edu/ie3/simona/model/thermal/ThermalSink.scala index 97661b0201..2b70983c73 100644 --- a/src/main/scala/edu/ie3/simona/model/thermal/ThermalSink.scala +++ b/src/main/scala/edu/ie3/simona/model/thermal/ThermalSink.scala @@ -17,7 +17,7 @@ import edu.ie3.datamodel.models.input.thermal.ThermalBusInput * @param uuid * the element's uuid * @param id - * the element's human readable id + * the element's human-readable id * @param operatorInput * Operator input * @param operationTime diff --git a/src/main/scala/edu/ie3/simona/model/thermal/ThermalStorage.scala b/src/main/scala/edu/ie3/simona/model/thermal/ThermalStorage.scala index 5886a4e7f8..c7818351b6 100644 --- a/src/main/scala/edu/ie3/simona/model/thermal/ThermalStorage.scala +++ b/src/main/scala/edu/ie3/simona/model/thermal/ThermalStorage.scala @@ -19,7 +19,7 @@ import java.util.UUID * @param uuid * the element's uuid * @param id - * the element's human readable id + * the element's human-readable id * @param operatorInput * Operator input * @param operationTime diff --git a/src/main/scala/edu/ie3/simona/scheduler/Scheduler.scala b/src/main/scala/edu/ie3/simona/scheduler/Scheduler.scala index 7339fbbe61..7cc4174e10 100644 --- a/src/main/scala/edu/ie3/simona/scheduler/Scheduler.scala +++ b/src/main/scala/edu/ie3/simona/scheduler/Scheduler.scala @@ -160,7 +160,7 @@ object Scheduler { stopOnError(ctx, s"Received unexpected message $unexpected when active") } - /** Data that is constant over the life time of a scheduler. + /** Data that is constant over the lifetime of a scheduler. * @param parent * The parent of the scheduler * @param activationAdapter diff --git a/src/main/scala/edu/ie3/simona/service/SimonaService.scala b/src/main/scala/edu/ie3/simona/service/SimonaService.scala index 1b41b30400..310c7f0b32 100644 --- a/src/main/scala/edu/ie3/simona/service/SimonaService.scala +++ b/src/main/scala/edu/ie3/simona/service/SimonaService.scala @@ -30,7 +30,7 @@ object SimonaService { /** Service initialization data can sometimes only be constructed once the * service actor is created (e.g. - * [[edu.ie3.simona.service.ev.ExtEvDataService]]. Thus, we need an extra + * [[edu.ie3.simona.service.ev.ExtEvDataService]]). Thus, we need an extra * initialization message. */ final case class Create[+I <: InitializeServiceStateData]( @@ -182,9 +182,9 @@ abstract class SimonaService[ /** Initialize the concrete service implementation using the provided * initialization data. This method should perform all heavyweight tasks * before the actor becomes ready. The return values are a) the state data of - * the initialized service and b) optional triggers that should be send to + * the initialized service and b) optional triggers that should be sent to * the [[edu.ie3.simona.scheduler.Scheduler]] together with the completion - * message that is send in response to the trigger that is send to start the + * message that is sent in response to the trigger that is sent to start the * initialization process * * @param initServiceData @@ -221,7 +221,7 @@ abstract class SimonaService[ * the current state data of this service * @return * the service stata data that should be used in the next state (normally - * with updated values) together with the completion message that is send + * with updated values) together with the completion message that is sent * in response to the trigger that was sent to start this announcement */ protected def announceInformation(tick: Long)(implicit diff --git a/src/main/scala/edu/ie3/simona/service/ev/ExtEvDataService.scala b/src/main/scala/edu/ie3/simona/service/ev/ExtEvDataService.scala index 66cfaa96f1..680c6050b1 100644 --- a/src/main/scala/edu/ie3/simona/service/ev/ExtEvDataService.scala +++ b/src/main/scala/edu/ie3/simona/service/ev/ExtEvDataService.scala @@ -170,7 +170,7 @@ class ExtEvDataService(override val scheduler: ActorRef) * the current state data of this service * @return * the service stata data that should be used in the next state (normally - * with updated values) together with the completion message that is send + * with updated values) together with the completion message that is sent * in response to the trigger that was sent to start this announcement */ override protected def announceInformation( diff --git a/src/main/scala/edu/ie3/simona/service/primary/PrimaryServiceProxy.scala b/src/main/scala/edu/ie3/simona/service/primary/PrimaryServiceProxy.scala index ca41a11234..838608a514 100644 --- a/src/main/scala/edu/ie3/simona/service/primary/PrimaryServiceProxy.scala +++ b/src/main/scala/edu/ie3/simona/service/primary/PrimaryServiceProxy.scala @@ -126,7 +126,7 @@ case class PrimaryServiceProxy( } /** Prepare the needed state data by building a - * [[edu.ie3.datamodel.io.source.TimeSeriesMappingSource]], obtain it's + * [[edu.ie3.datamodel.io.source.TimeSeriesMappingSource]], obtain its * information and compile them to state data * * @param primaryConfig @@ -269,7 +269,7 @@ case class PrimaryServiceProxy( unhandled(x) } - /** Handle the registration request for a covered model. First, try to get a + /** Handle the registration request for a covered model. First, try to get an * already existing worker for this time series, otherwise spin-off a new * one, remember it and forward the request * diff --git a/src/main/scala/edu/ie3/simona/service/primary/PrimaryServiceWorker.scala b/src/main/scala/edu/ie3/simona/service/primary/PrimaryServiceWorker.scala index 7ff05ccf1a..bd09c0b81b 100644 --- a/src/main/scala/edu/ie3/simona/service/primary/PrimaryServiceWorker.scala +++ b/src/main/scala/edu/ie3/simona/service/primary/PrimaryServiceWorker.scala @@ -198,8 +198,8 @@ final case class PrimaryServiceWorker[V <: Value]( * the current state data of this service * @return * the service stata data that should be used in the next state (normally - * with updated values) together with the completion message that is send - * in response to the trigger that is send to start the initialization + * with updated values) together with the completion message that is sent + * in response to the trigger that is sent to start the initialization * process */ override protected def announceInformation( diff --git a/src/main/scala/edu/ie3/simona/service/weather/SampleWeatherSource.scala b/src/main/scala/edu/ie3/simona/service/weather/SampleWeatherSource.scala index c8045ced59..2e2dd58c7c 100644 --- a/src/main/scala/edu/ie3/simona/service/weather/SampleWeatherSource.scala +++ b/src/main/scala/edu/ie3/simona/service/weather/SampleWeatherSource.scala @@ -183,7 +183,7 @@ object SampleWeatherSource { } } - // these lists contain the hourly weather values for each first of the month of 2011 + january of + // these lists contain the hourly weather values for each first of the month of 2011 + january // 2012 at coordinate id 213089 val diffuseRadiation: Vector[Double] = Vector(0, 0, 0, 0, 0, 1.18179e-12, 4.42315e-11, 0.0585938, 1.94141, 15.1172, 74.8438, 89.0469, 104.062, diff --git a/src/main/scala/edu/ie3/simona/service/weather/WeatherService.scala b/src/main/scala/edu/ie3/simona/service/weather/WeatherService.scala index a75b0c38fd..a31a217eb0 100644 --- a/src/main/scala/edu/ie3/simona/service/weather/WeatherService.scala +++ b/src/main/scala/edu/ie3/simona/service/weather/WeatherService.scala @@ -107,9 +107,9 @@ final case class WeatherService( /** Initialize the concrete service implementation using the provided * initialization data. This method should perform all heavyweight tasks * before the actor becomes ready. The return values are a) the state data of - * the initialized service and b) optional triggers that should be send to + * the initialized service and b) optional triggers that should be sent to * the [[edu.ie3.simona.scheduler.Scheduler]] together with the completion - * message that is send in response to the trigger that is send to start the + * message that is sent in response to the trigger that is sent to start the * initialization process * * @param initServiceData @@ -269,7 +269,7 @@ final case class WeatherService( serviceStateData case _ => - // actor is not registered and we don't have data for it + // actor is not registered, and we don't have data for it // inform the agentToBeRegistered that the registration failed as we don't have data for it agentToBeRegistered ! RegistrationFailedMessage(self) serviceStateData @@ -284,7 +284,7 @@ final case class WeatherService( * the current state data of this service * @return * the service stata data that should be used in the next state (normally - * with updated values) together with the completion message that is send + * with updated values) together with the completion message that is sent * in response to the trigger that was sent to start this announcement */ override protected def announceInformation(tick: Long)(implicit @@ -303,7 +303,7 @@ final case class WeatherService( // get the weather and send it to the subscribed agents // no sanity check needed here as we can assume that we always have weather available - // when we announce it. Otherwise the registration would have failed already! + // when we announce it. Otherwise, the registration would have failed already! updatedStateData.weatherSource .getWeather(tick, updatedStateData.weightedWeatherCoordinates) .foreach { case coordinate -> weatherResult => diff --git a/src/main/scala/edu/ie3/simona/service/weather/WeatherSource.scala b/src/main/scala/edu/ie3/simona/service/weather/WeatherSource.scala index 12a26c3f6c..8cf874a885 100644 --- a/src/main/scala/edu/ie3/simona/service/weather/WeatherSource.scala +++ b/src/main/scala/edu/ie3/simona/service/weather/WeatherSource.scala @@ -165,7 +165,7 @@ trait WeatherSource { val weightMap = nearestCoordinates .map(coordinateDistance => { /* Maybe some words on the calculus of the weight here: We intend to have a weight, that linear increases - * from zero to one, the closer the coordinate is to the coordinate in question. Therefore we calculate the + * from zero to one, the closer the coordinate is to the coordinate in question. Therefore, we calculate the * proximity of each node as a linear function between 1 at 0m distance to the questioned coordinate to zero * at the sum of all coordinates' distances (1 - d / d_sum). However, summing up this proximity over all * n coordinates brings n*1 from the left part of the sum and -1 as the sum of all distances shares. @@ -424,7 +424,7 @@ object WeatherSource { * coordinates * * @param weighting - * Mapping from weather coordinate to it's weight in averaging + * Mapping from weather coordinate to its weight in averaging */ private[weather] final case class WeightedCoordinates( weighting: Map[Point, Double] diff --git a/src/main/scala/edu/ie3/simona/sim/setup/SetupHelper.scala b/src/main/scala/edu/ie3/simona/sim/setup/SetupHelper.scala index 535b140798..d5b21a99a7 100644 --- a/src/main/scala/edu/ie3/simona/sim/setup/SetupHelper.scala +++ b/src/main/scala/edu/ie3/simona/sim/setup/SetupHelper.scala @@ -37,7 +37,7 @@ trait SetupHelper extends LazyLogging { /** Build the [[GridAgentInitData]]. This also includes the determination of a * mapping from [[SubGridGate]] to [[ActorRef]] of the representing - * [[edu.ie3.simona.agent.grid.GridAgent]] as well as the look up of the + * [[edu.ie3.simona.agent.grid.GridAgent]] as well as the look-up of the * [[RefSystem]] to use being defined in the config. * * @param subGridContainer @@ -46,7 +46,7 @@ trait SetupHelper extends LazyLogging { * Mapping from sub grid number to [[edu.ie3.simona.agent.grid.GridAgent]] * 's [[ActorRef]] * @param gridGates - * [[Set]] of all [[SubGridGate]] s connecting this sub grid with it's + * [[Set]] of all [[SubGridGate]] s connecting this sub grid with its * ancestors and children * @param configRefSystems * Collection of reference systems defined in config diff --git a/src/main/scala/edu/ie3/simona/sim/setup/SimonaSetup.scala b/src/main/scala/edu/ie3/simona/sim/setup/SimonaSetup.scala index 9c6effa859..4a2d8abd42 100644 --- a/src/main/scala/edu/ie3/simona/sim/setup/SimonaSetup.scala +++ b/src/main/scala/edu/ie3/simona/sim/setup/SimonaSetup.scala @@ -21,11 +21,11 @@ import org.apache.pekko.actor.typed.ActorRef import org.apache.pekko.actor.typed.scaladsl.ActorContext import org.apache.pekko.actor.{ActorRef => ClassicRef} -/** Trait that can be used to setup a customized simona simulation by providing +/** Trait that can be used to set up a customized simona simulation by providing * implementations for all setup information required by a * [[edu.ie3.simona.sim.SimonaSim]]. Most of the time, using or extending - * [[SimonaStandaloneSetup]] might be considered instead of providing a your - * own implementation for all methods. + * [[SimonaStandaloneSetup]] might be considered instead of providing your own + * implementation for all methods. * * @version 0.1 * @since 01.07.20 diff --git a/src/main/scala/edu/ie3/simona/util/CollectionUtils.scala b/src/main/scala/edu/ie3/simona/util/CollectionUtils.scala index 6402ea7b2a..c5e2b45beb 100644 --- a/src/main/scala/edu/ie3/simona/util/CollectionUtils.scala +++ b/src/main/scala/edu/ie3/simona/util/CollectionUtils.scala @@ -98,7 +98,7 @@ object CollectionUtils { * smallest map key is provided. * * @param map - * containing containing the (k,v) pairs (e.g. x,y pairs) + * containing the (k,v) pairs (e.g. x,y pairs) * @param key * the key values are needed for * @return diff --git a/src/main/scala/edu/ie3/simona/util/ConfigUtil.scala b/src/main/scala/edu/ie3/simona/util/ConfigUtil.scala index f32b66ed5f..a91ff99924 100644 --- a/src/main/scala/edu/ie3/simona/util/ConfigUtil.scala +++ b/src/main/scala/edu/ie3/simona/util/ConfigUtil.scala @@ -73,7 +73,7 @@ object ConfigUtil { * participants config for faster access. * * @param subConfig - * Configuration sub tree for the behaviour of system participants + * Configuration subtree for the behaviour of system participants * @return * a matching config utility */ @@ -124,7 +124,7 @@ object ConfigUtil { * @param defaultConfig * Default config to use, when there is no specific one * @param configs - * Mapping from notifier identifier to it's notifier configuration + * Mapping from notifier identifier to its notifier configuration */ final case class OutputConfigUtil( private val defaultConfig: NotifierConfig, diff --git a/src/main/scala/edu/ie3/simona/util/ParsableEnumeration.scala b/src/main/scala/edu/ie3/simona/util/ParsableEnumeration.scala index 6097ac1247..eee647d73f 100644 --- a/src/main/scala/edu/ie3/simona/util/ParsableEnumeration.scala +++ b/src/main/scala/edu/ie3/simona/util/ParsableEnumeration.scala @@ -26,7 +26,7 @@ abstract class ParsableEnumeration extends Enumeration { withName(cleanedInput) } - /** Checks, if the given input is an eligible description of a enum value + /** Checks, if the given input is an eligible description of an enum value * * @param input * Input string diff --git a/src/main/scala/edu/ie3/simona/util/ResultFileHierarchy.scala b/src/main/scala/edu/ie3/simona/util/ResultFileHierarchy.scala index 171c5835a2..3c1028be2b 100644 --- a/src/main/scala/edu/ie3/simona/util/ResultFileHierarchy.scala +++ b/src/main/scala/edu/ie3/simona/util/ResultFileHierarchy.scala @@ -28,7 +28,7 @@ import scala.jdk.OptionConverters.RichOptional /** Represents the output directory where the results will be materialized. If * new directories are added please remember to add them to the dirsToBeCreated - * Vector if they should be created. Otherwise they will not be created! + * Vector if they should be created. Otherwise, they will not be created! * * @version 0.1 * @since 12.01.20 @@ -156,7 +156,7 @@ object ResultFileHierarchy extends LazyLogging { ) /** @param modelClass - * the model class a file path should be build for + * the model class a file path should be built for * @param csvSink * the csv sink type parameters * @param rawOutputDataDir diff --git a/src/main/scala/edu/ie3/util/scala/ReflectionTools.scala b/src/main/scala/edu/ie3/util/scala/ReflectionTools.scala index 6ed62dc580..be6df1b955 100644 --- a/src/main/scala/edu/ie3/util/scala/ReflectionTools.scala +++ b/src/main/scala/edu/ie3/util/scala/ReflectionTools.scala @@ -47,7 +47,7 @@ object ReflectionTools { * @tparam A * type of the object * @return - * a map containing the field method and it's value of the object instance + * a map containing the field method, and it's value of the object instance */ def classFieldToVal[A](a: A)(implicit tt: TypeTag[A], diff --git a/src/main/scala/edu/ie3/util/scala/quantities/Irradiance.scala b/src/main/scala/edu/ie3/util/scala/quantities/Irradiance.scala index 2ad522980e..7476cbe225 100644 --- a/src/main/scala/edu/ie3/util/scala/quantities/Irradiance.scala +++ b/src/main/scala/edu/ie3/util/scala/quantities/Irradiance.scala @@ -31,7 +31,7 @@ final class Irradiance private (val value: Double, val unit: IrradianceUnit) def *(that: Area): Power = Watts( this.toWattsPerSquareMeter * that.toSquareMeters ) - // the Hours(1).toSeconds is to convert watt hours to watt seconds which + // the Hours(1).toSeconds is to convert watt-hours to watt-seconds which // isn't a normal supported type in Squants def *(that: AreaTime): Energy = WattHours( this.toWattsPerSquareMeter * that.toSquareMeterSeconds / Hours(1).toSeconds diff --git a/src/main/scala/edu/ie3/util/scala/quantities/Irradiation.scala b/src/main/scala/edu/ie3/util/scala/quantities/Irradiation.scala index 5b685fde7e..306d2c11f5 100644 --- a/src/main/scala/edu/ie3/util/scala/quantities/Irradiation.scala +++ b/src/main/scala/edu/ie3/util/scala/quantities/Irradiation.scala @@ -22,7 +22,7 @@ final class Irradiation private (val value: Double, val unit: IrradiationUnit) def *(that: Area): Energy = WattHours( this.toWattHoursPerSquareMeter * that.toSquareMeters ) - // the Hours(1).toSeconds is to convert watt hours to watt seconds which + // the Hours(1).toSeconds is to convert watt-hours to watt-seconds which // isn't a normal supported type in Squants def /(that: Time): Irradiance = WattsPerSquareMeter( diff --git a/src/main/scala/edu/ie3/util/scala/quantities/QuantityUtil.scala b/src/main/scala/edu/ie3/util/scala/quantities/QuantityUtil.scala index b55678ef83..7ccc3b7aa2 100644 --- a/src/main/scala/edu/ie3/util/scala/quantities/QuantityUtil.scala +++ b/src/main/scala/edu/ie3/util/scala/quantities/QuantityUtil.scala @@ -21,9 +21,8 @@ object QuantityUtil { /** The [[tech.units.indriya.function.DefaultNumberSystem]] is only covering * java [[Number]] children. As [[BigDecimal]] is not related to * [[java.math.BigDecimal]], this causes issues, why the - * [[tech.units.indriya.spi.NumberSystem]] has to be to be used has to be - * specified to something, that actually is able to handle the scala number - * system. + * [[tech.units.indriya.spi.NumberSystem]] has to be used has to be specified + * to something, that actually is able to handle the scala number system. */ def adjustNumberSystem(): Unit = Calculus.setCurrentNumberSystem( diff --git a/src/main/scala/edu/ie3/util/scala/quantities/ScalaNumberSystem.scala b/src/main/scala/edu/ie3/util/scala/quantities/ScalaNumberSystem.scala index 238668e67a..137e24a2ce 100644 --- a/src/main/scala/edu/ie3/util/scala/quantities/ScalaNumberSystem.scala +++ b/src/main/scala/edu/ie3/util/scala/quantities/ScalaNumberSystem.scala @@ -8,7 +8,7 @@ package edu.ie3.util.scala.quantities import tech.units.indriya.function.DefaultNumberSystem -/** This number system simply delegates the method calls to it's parent class. +/** This number system simply delegates the method calls to its parent class. * The only difference is, that [[BigDecimal]] is transferred to * [[java.math.BigDecimal]] and back upon necessity. Due to its functionality * as an extension of the [[DefaultNumberSystem]] it CANNOT be an object! diff --git a/src/main/scala/edu/ie3/util/scala/quantities/SpecificHeatCapacity.scala b/src/main/scala/edu/ie3/util/scala/quantities/SpecificHeatCapacity.scala index e63ec421f5..82ed0b58bc 100644 --- a/src/main/scala/edu/ie3/util/scala/quantities/SpecificHeatCapacity.scala +++ b/src/main/scala/edu/ie3/util/scala/quantities/SpecificHeatCapacity.scala @@ -45,7 +45,7 @@ final class SpecificHeatCapacity private ( ) /** Calculates the Energy of a medium with a given specific heat capacity - * based on the temperature delta and it's volume. + * based on the temperature delta, and it's volume. * @param temperatureA * First temperature of the medium (e.g. inlet temperature) * @param temperatureB diff --git a/src/test/scala/edu/ie3/simona/agent/grid/DBFSAlgorithmCenGridSpec.scala b/src/test/scala/edu/ie3/simona/agent/grid/DBFSAlgorithmCenGridSpec.scala index 4da922de62..8d23af9c46 100644 --- a/src/test/scala/edu/ie3/simona/agent/grid/DBFSAlgorithmCenGridSpec.scala +++ b/src/test/scala/edu/ie3/simona/agent/grid/DBFSAlgorithmCenGridSpec.scala @@ -41,8 +41,8 @@ import scala.language.postfixOps * be able to do if the DBFSAlgorithm is used. The scheduler, the weather * service as well as the inferior and superior [[GridAgent]] s are simulated * by the TestKit. By now this test does NOT cover interactions with generation - * or load asset agents due to unavailability during test development. Hence it - * would make sense to extend this test in the future to include asset agent + * or load asset agents due to unavailability during test development. Hence, + * it would make sense to extend this test in the future to include asset agent * interaction or cover this behaviour by another (integration) test! */ class DBFSAlgorithmCenGridSpec @@ -164,7 +164,7 @@ class DBFSAlgorithmCenGridSpec val firstSlackVoltageRequestSender = superiorGridAgent.expectSlackVoltageRequest(firstSweepNo) - // normally the inferior grid agents ask for the slack voltage as well to do their power flow calculations + // normally the inferior grid agents ask for the slack voltage as well to run their power flow calculations // we simulate this behaviour now by doing the same for our three inferior grid agents inferiorGrid11.requestSlackVoltage(centerGridAgent, firstSweepNo) @@ -300,7 +300,7 @@ class DBFSAlgorithmCenGridSpec Kilovolts(374.22694614463d), // 380 kV @ 10° Kilovolts(65.9863075134335d), // 380 kV @ 10° ), - ExchangeVoltage( // this one should currently be ignored anyways + ExchangeVoltage( // this one should currently be ignored anyway supNodeA.getUuid, Kilovolts(380d), Kilovolts(0d), @@ -320,7 +320,7 @@ class DBFSAlgorithmCenGridSpec val secondPowerRequestSender13 = inferiorGrid13.expectGridPowerRequest() - // normally the inferior grid agents ask for the slack voltage as well to do their power flow calculations + // normally the inferior grid agents ask for the slack voltage as well to run their power flow calculations // we simulate this behaviour now by doing the same for our three inferior grid agents inferiorGrid11.requestSlackVoltage(centerGridAgent, secondSweepNo) @@ -424,8 +424,8 @@ class DBFSAlgorithmCenGridSpec // connected inferior grids, because the slack node is just a mock, we imitate this behavior centerGridAgent ! FinishGridSimulationTrigger(3600) - // after a FinishGridSimulationTrigger is send the inferior grids, they themselves will send the - // Trigger forward the trigger to their connected inferior grids. Therefore the inferior grid + // after a FinishGridSimulationTrigger is sent the inferior grids, they themselves will send the + // Trigger forward the trigger to their connected inferior grids. Therefore, the inferior grid // agent should receive a FinishGridSimulationTrigger inferiorGrid11.gaProbe.expectMessage(FinishGridSimulationTrigger(3600)) diff --git a/src/test/scala/edu/ie3/simona/agent/grid/DBFSAlgorithmFailedPowerFlowSpec.scala b/src/test/scala/edu/ie3/simona/agent/grid/DBFSAlgorithmFailedPowerFlowSpec.scala index ce904d0b11..a1047edeff 100644 --- a/src/test/scala/edu/ie3/simona/agent/grid/DBFSAlgorithmFailedPowerFlowSpec.scala +++ b/src/test/scala/edu/ie3/simona/agent/grid/DBFSAlgorithmFailedPowerFlowSpec.scala @@ -145,7 +145,7 @@ class DBFSAlgorithmFailedPowerFlowSpec val slackVoltageRequestSender = superiorGridAgent.expectSlackVoltageRequest(sweepNo) - // normally the inferior grid agents ask for the slack voltage as well to do their power flow calculation + // normally the inferior grid agents ask for the slack voltage as well to run their power flow calculation // we simulate this behaviour now by doing the same for our inferior grid agent inferiorGridAgent.requestSlackVoltage(centerGridAgent, sweepNo) @@ -191,7 +191,7 @@ class DBFSAlgorithmFailedPowerFlowSpec // hence we ask for them and expect a corresponding response superiorGridAgent.requestGridPower(centerGridAgent, sweepNo) - // the requested power is to high for the grid to handle, therefore the superior grid agent + // the requested power is too high for the grid to handle, therefore the superior grid agent // receives a FailedPowerFlow message // wait 30 seconds max for power flow to finish superiorGridAgent.gaProbe.expectMessage(30 seconds, FailedPowerFlow) @@ -200,8 +200,8 @@ class DBFSAlgorithmFailedPowerFlowSpec // connected inferior grids, because the slack node is just a mock, we imitate this behavior centerGridAgent ! FinishGridSimulationTrigger(3600) - // after a FinishGridSimulationTrigger is send to the inferior grids, they themselves will - // forward the trigger to their connected inferior grids. Therefore the inferior grid agent + // after a FinishGridSimulationTrigger is sent to the inferior grids, they themselves will + // forward the trigger to their connected inferior grids. Therefore, the inferior grid agent // should receive a FinishGridSimulationTrigger inferiorGridAgent.gaProbe.expectMessage(FinishGridSimulationTrigger(3600)) @@ -229,7 +229,7 @@ class DBFSAlgorithmFailedPowerFlowSpec val slackVoltageRequestSender = superiorGridAgent.expectSlackVoltageRequest(sweepNo) - // normally the inferior grid agents ask for the slack voltage as well to do their power flow calculation + // normally the inferior grid agents ask for the slack voltage as well to run their power flow calculation // we simulate this behaviour now by doing the same for our inferior grid agent inferiorGridAgent.requestSlackVoltage(centerGridAgent, sweepNo) @@ -272,8 +272,8 @@ class DBFSAlgorithmFailedPowerFlowSpec // connected inferior grids, because the slack node is just a mock, we imitate this behavior centerGridAgent ! FinishGridSimulationTrigger(3600) - // after a FinishGridSimulationTrigger is send to the inferior grids, they themselves will - // forward the trigger to their connected inferior grids. Therefore the inferior grid agent + // after a FinishGridSimulationTrigger is sent to the inferior grids, they themselves will + // forward the trigger to their connected inferior grids. Therefore, the inferior grid agent // should receive a FinishGridSimulationTrigger inferiorGridAgent.gaProbe.expectMessage(FinishGridSimulationTrigger(3600)) @@ -341,7 +341,7 @@ class DBFSAlgorithmFailedPowerFlowSpec val powerRequestSender = hvGridAgent.expectGridPowerRequest() - // normally the inferior grid agents ask for the slack voltage as well to do their power flow calculation + // normally the inferior grid agents ask for the slack voltage as well to run their power flow calculation // we simulate this behaviour now by doing the same for our inferior grid agent hvGridAgent.requestSlackVoltage(slackGridAgent, sweepNo) diff --git a/src/test/scala/edu/ie3/simona/agent/grid/DBFSAlgorithmSupGridSpec.scala b/src/test/scala/edu/ie3/simona/agent/grid/DBFSAlgorithmSupGridSpec.scala index 9c716def88..beb1408270 100644 --- a/src/test/scala/edu/ie3/simona/agent/grid/DBFSAlgorithmSupGridSpec.scala +++ b/src/test/scala/edu/ie3/simona/agent/grid/DBFSAlgorithmSupGridSpec.scala @@ -154,7 +154,7 @@ class DBFSAlgorithmSupGridSpec ) // we expect a completion message here and that the agent goes back to simulate grid - // and waits until the newly scheduled StartGridSimulationTrigger is send + // and waits until the newly scheduled StartGridSimulationTrigger is sent // wait 30 seconds max for power flow to finish scheduler.expectMessageType[Completion](130 seconds) match { case Completion(_, Some(3600)) => @@ -271,7 +271,7 @@ class DBFSAlgorithmSupGridSpec ) // we expect a completion message here and that the agent goes back to simulate grid - // and waits until the newly scheduled StartGridSimulationTrigger is send + // and waits until the newly scheduled StartGridSimulationTrigger is sent // Simulate Grid // wait 30 seconds max for power flow to finish diff --git a/src/test/scala/edu/ie3/simona/agent/participant/ParticipantAgentMock.scala b/src/test/scala/edu/ie3/simona/agent/participant/ParticipantAgentMock.scala index 300bfb7e79..8087993f01 100644 --- a/src/test/scala/edu/ie3/simona/agent/participant/ParticipantAgentMock.scala +++ b/src/test/scala/edu/ie3/simona/agent/participant/ParticipantAgentMock.scala @@ -175,7 +175,7 @@ class ParticipantAgentMock( * @param simulationEndDate * Real world time date time, when the simulation ends * @param resolution - * Agents regular time bin it wants to be triggered e.g one hour + * Agents regular time bin it wants to be triggered e.g. one hour * @param requestVoltageDeviationThreshold * Threshold, after which two nodal voltage magnitudes from participant * power requests for the same tick are considered to be different @@ -311,7 +311,7 @@ class ParticipantAgentMock( FixedRelevantData /** To clean up agent value stores after power flow convergence. This is - * necessary for agents whose results are time dependent e.g. storage agents + * necessary for agents whose results are time-dependent e.g. storage agents * @param baseStateData * Basic state data * @param currentTick diff --git a/src/test/scala/edu/ie3/simona/event/listener/ResultEventListenerSpec.scala b/src/test/scala/edu/ie3/simona/event/listener/ResultEventListenerSpec.scala index f110feca8e..26c3145945 100644 --- a/src/test/scala/edu/ie3/simona/event/listener/ResultEventListenerSpec.scala +++ b/src/test/scala/edu/ie3/simona/event/listener/ResultEventListenerSpec.scala @@ -316,7 +316,7 @@ class ResultEventListenerSpec ), ) ) - /* The result file is created at start up and only contains a head line. */ + /* The result file is created at start up and only contains a headline. */ awaitCond( outputFile.exists(), interval = 500.millis, diff --git a/src/test/scala/edu/ie3/simona/event/listener/RuntimeEventListenerLoggingSpec.scala b/src/test/scala/edu/ie3/simona/event/listener/RuntimeEventListenerLoggingSpec.scala index 4e37001c11..7f77f7ca77 100644 --- a/src/test/scala/edu/ie3/simona/event/listener/RuntimeEventListenerLoggingSpec.scala +++ b/src/test/scala/edu/ie3/simona/event/listener/RuntimeEventListenerLoggingSpec.scala @@ -29,7 +29,7 @@ import org.apache.pekko.actor.testkit.typed.scaladsl.{ import org.slf4j.event.Level /** Logging must be tested in a separate test, since LoggingTestKit can still - * receives logs from test that it was not enabled for + * receive logs from test that it was not enabled for */ class RuntimeEventListenerLoggingSpec extends ScalaTestWithActorTestKit( diff --git a/src/test/scala/edu/ie3/simona/integration/common/IntegrationSpecCommon.scala b/src/test/scala/edu/ie3/simona/integration/common/IntegrationSpecCommon.scala index eeb0804f77..f98abfd663 100644 --- a/src/test/scala/edu/ie3/simona/integration/common/IntegrationSpecCommon.scala +++ b/src/test/scala/edu/ie3/simona/integration/common/IntegrationSpecCommon.scala @@ -10,7 +10,7 @@ trait IntegrationSpecCommon { /* ATTENTION: Do not change this file to a path within "input". If you come to this point because the CI * or some of your tests are failing you very likely have altered the vn_simona.conf. This config although - * is NOT meant to be altered. Instead you should always use a delta config and only override the values and + * is NOT meant to be altered. Instead, you should always use a delta config and only override the values and * files of vn_simona/vn_simona.conf. Delta configs can be created by including the config you want to change * parameters from via include (e.g. include "input/samples/vn_simona/vn_simona.conf") at the * beginning of your config file and then just override the parameters you want to change! */ diff --git a/src/test/scala/edu/ie3/simona/model/em/ProportionalFlexStratSpec.scala b/src/test/scala/edu/ie3/simona/model/em/ProportionalFlexStratSpec.scala index 4a4834fff9..2a90b1432d 100644 --- a/src/test/scala/edu/ie3/simona/model/em/ProportionalFlexStratSpec.scala +++ b/src/test/scala/edu/ie3/simona/model/em/ProportionalFlexStratSpec.scala @@ -43,7 +43,7 @@ class ProportionalFlexStratSpec * * Specifically, we use 40% of the flex potential 2 kW - 1 kW = 1 kW of * the first unit and 40% of the flex potential 4 kW - 0 kW = 4 kW of the - * second unit. Thus we arrive at 1 kW + 40% * 1 kW = 1.4 kW for the + * second unit. Thus, we arrive at 1 kW + 40% * 1 kW = 1.4 kW for the * first unit and 0 kW + 40% * 4 kW = 1.6 kW for the second unit. */ diff --git a/src/test/scala/edu/ie3/simona/model/participant/StorageModelSpec.scala b/src/test/scala/edu/ie3/simona/model/participant/StorageModelSpec.scala index 4d6fff7060..032743fa97 100644 --- a/src/test/scala/edu/ie3/simona/model/participant/StorageModelSpec.scala +++ b/src/test/scala/edu/ie3/simona/model/participant/StorageModelSpec.scala @@ -104,7 +104,7 @@ class StorageModelSpec extends UnitSpec with Matchers { // CHANGED STATE // discharged to empty (10.0, -9.0, 3600, 0.0, 0.0, 10.0), - // almost discharged to lowest allowed charge + // almost discharged to the lowest allowed charge (10.0, -9.0, 3590, 0.0, -10.0, 10.0), // charged to mid-level charge (41.0, 10.0, 3600, 0.0, -10.0, 10.0), diff --git a/src/test/scala/edu/ie3/simona/model/participant/load/LoadProfileStoreSpec.scala b/src/test/scala/edu/ie3/simona/model/participant/load/LoadProfileStoreSpec.scala index 64701fa993..358da83a31 100644 --- a/src/test/scala/edu/ie3/simona/model/participant/load/LoadProfileStoreSpec.scala +++ b/src/test/scala/edu/ie3/simona/model/participant/load/LoadProfileStoreSpec.scala @@ -49,22 +49,22 @@ class LoadProfileStoreSpec "2019-04-01T05:00:00+02:00[Europe/Berlin]", L0, 55.6d, - ), // Weekday, transitional, 20th quarter hour + ), // Weekday, transitional, 20th quarter-hour ( "2019-06-02T00:00:00+02:00[Europe/Berlin]", G0, 68.8d, - ), // Sunday, summer, 0th quarter hour + ), // Sunday, summer, 0th quarter-hour ( "2019-01-05T02:15:00+01:00[Europe/Berlin]", H0, 52.8d, - ), // Saturday, winter, 9th quarter hour, 5th day -> dynamization factor 1.2473 + ), // Saturday, winter, 9th quarter-hour, 5th day -> dynamization factor 1.2473 ( "2019-07-21T01:00:00+02:00[Europe/Berlin]", H0, 58.1d, - ), // Sunday, summer, 4th quarter hour, 202nd day -> dynamization factor 0.7847 + ), // Sunday, summer, 4th quarter-hour, 202nd day -> dynamization factor 0.7847 ) forAll(params) { diff --git a/src/test/scala/edu/ie3/simona/model/participant/load/RandomLoadModelSpec.scala b/src/test/scala/edu/ie3/simona/model/participant/load/RandomLoadModelSpec.scala index 82fa1041e5..08457fc4c8 100644 --- a/src/test/scala/edu/ie3/simona/model/participant/load/RandomLoadModelSpec.scala +++ b/src/test/scala/edu/ie3/simona/model/participant/load/RandomLoadModelSpec.scala @@ -112,7 +112,7 @@ class RandomLoadModelSpec extends UnitSpec with TableDrivenPropertyChecks { loadInput.getCosPhiRated, ActivePower(Watts(268.6)), ) - /* Working day, 61th quarter hour */ + /* Working day, 61st quarter-hour */ val queryDate = TimeUtil.withDefaults.toZonedDateTime("2019-07-19T15:21:00Z") val expectedParams = new RandomLoadParameters( diff --git a/src/test/scala/edu/ie3/simona/test/common/model/grid/BasicGridWithSwitches.scala b/src/test/scala/edu/ie3/simona/test/common/model/grid/BasicGridWithSwitches.scala index bd709daa01..5781848e1b 100644 --- a/src/test/scala/edu/ie3/simona/test/common/model/grid/BasicGridWithSwitches.scala +++ b/src/test/scala/edu/ie3/simona/test/common/model/grid/BasicGridWithSwitches.scala @@ -20,7 +20,7 @@ import tech.units.indriya.quantity.Quantities import java.util.UUID -/** Note: the line parameters are NOT adapted. Instead the line params from +/** Note: the line parameters are NOT adapted. Instead, the line params from * [[FiveLinesWithNodes]] are used instead! * * {{{ diff --git a/src/test/scala/edu/ie3/simona/test/common/model/grid/SubGridGateMokka.scala b/src/test/scala/edu/ie3/simona/test/common/model/grid/SubGridGateMokka.scala index 6cf1b682d4..d3ab3e97b3 100644 --- a/src/test/scala/edu/ie3/simona/test/common/model/grid/SubGridGateMokka.scala +++ b/src/test/scala/edu/ie3/simona/test/common/model/grid/SubGridGateMokka.scala @@ -21,14 +21,14 @@ import org.scalatestplus.mockito.MockitoSugar */ trait SubGridGateMokka extends MockitoSugar { - /** Mocks a node with it's basic needed information + /** Mocks a node with its basic needed information * * @param uuid * Unique identifier of the node * @param subnet * Sub net number * @return - * [[NodeInput]] with these information + * [[NodeInput]] with this information */ protected def mockNode(uuid: UUID, subnet: Int): NodeInput = { val node = mock[NodeInput]