energy.calculations

Class AbstractOptionModelCalculation

java.lang.Object

energy.calculations.AbstractOptionModelCalculation

Direct Known Subclasses:

ATestCalculation, EOMCalcElectricVehicle, GroupCalculation

public abstract class AbstractOptionModelCalculation
extends java.lang.Object

The Class AbstractOptionModelCalculation can be extend in order to provide system specific calculations for a Technical System.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractOptionModelCalculation.DurationType The Enumeration DurationType describes the type of a needed Duration.

Field Summary

Fields

Modifier and Type	Field and Description
protected OptionModelController	optionModelController The option model controller that enables access to the TechnicalSystem and features several help functions for it.

Constructor Summary

Constructors

Constructor and Description
AbstractOptionModelCalculation(OptionModelController optionModelController) Instantiates a new abstract option model calculation.

Method Summary

Modifier and Type	Method and Description
abstract Duration	getDuration(AbstractOptionModelCalculation.DurationType durationType, TechnicalSystemStateEvaluation tsse) Returns the specified AbstractOptionModelCalculation.DurationType as Duration.
abstract EnergyFlowInWatt	getEnergyFlowForLosses(TechnicalSystemStateEvaluation tsse) Returns the energy losses as EnergyAmount for the TechnicalInterfaceConfiguration and the State specified within the given TechnicalSystemStateEvaluation.
AbstractInterfaceFlow	getEnergyOrGoodFlow(TechnicalSystemStateEvaluation tsse, TechnicalInterface ti) Returns the EnergyFlowInWatt or the GoodFlow for the specified TechnicalSystemStateEvaluation and its I/O-list settings.
abstract AbstractInterfaceFlow	getEnergyOrGoodFlow(TechnicalSystemStateEvaluation tsse, TechnicalInterface ti, boolean isManualConfiguration) Returns the EnergyFlowInWatt or the GoodFlow for the specified TechnicalSystemStateEvaluation and its I/O-list settings.
AbstractGroupEvaluationStrategy	getGroupEvaluationStrategy() Returns the current group evaluation strategy.
EnergyAmount	getNewEnergyStorageLoad(EnergyAmount storageLoadOld, DomainInterfaceFlows domainInterfaceFlows, long duration) May return the new energy storage load, based on an individual calculation and the specified parameter.
EnergyAmount	getNewEnergyStorageLoad(EnergyAmount storageLoadOld, DomainInterfaceFlows domainInterfaceFlows, long duration, TechnicalSystemStateEvaluation initialTSSE, TechnicalSystemStateEvaluation newTSSE) May return the new energy storage load, based on an individual calculation and the specified parameter.
java.lang.Double	getNewGoodStorageLoad(double storageLoadOld, DomainInterfaceFlows domainInterfaceFlows, long duration) May return the new good storage load based on an individual calculation and the specified parameter.
java.lang.Double	getNewGoodStorageLoad(double storageLoadOld, DomainInterfaceFlows domainInterfaceFlows, long duration, TechnicalSystemStateEvaluation initialTSSE, TechnicalSystemStateEvaluation newTSSE) May return the new good storage load based on an individual calculation and the specified parameter.
NodeStatesResolver	getNodeStateResolver() Gets the node state resolver.
protected FixedVariable	getOrCreateVariable(java.util.List<FixedVariable> fixedVariableList, java.lang.String variableID) Gets or creates the specified variable.
protected TechnicalSystem	getTechnicalSystem() Returns the current TechnicalSystem
protected FixedVariable	getVariable(java.util.List<FixedVariable> fixedVariableList, java.lang.String variableID) Returns the specified FixedVariable out of the list of FixedVariable's.
protected boolean	isEqualTechnicalSystemStateEvaluation(TechnicalSystemStateEvaluation tsse1, TechnicalSystemStateEvaluation tsse2) Checks if two specified TechnicalSystemStateEvaluation instances are equal.
void	setGroupEvaluationStrategy(AbstractGroupEvaluationStrategy abstractGroupEvaluationStrategy) Sets the current group evaluation strategy.
protected void	setVariable(java.util.List<FixedVariable> fixedVariableList, java.lang.String variableID, FixedVariable newValue) Sets a new value for the specified FixedVariable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

optionModelController

protected OptionModelController optionModelController

The option model controller that enables access to the TechnicalSystem and features several help functions for it.

Constructor Detail

AbstractOptionModelCalculation

public AbstractOptionModelCalculation(OptionModelController optionModelController)

Instantiates a new abstract option model calculation.

Parameters:

optionModelController - the option model controller

Method Detail

getNodeStateResolver

public NodeStatesResolver getNodeStateResolver()

Gets the node state resolver.

Returns:

the node state resolver

getDuration

public abstract Duration getDuration(AbstractOptionModelCalculation.DurationType durationType,
                                     TechnicalSystemStateEvaluation tsse)

Returns the specified AbstractOptionModelCalculation.DurationType as Duration.

Parameters:

durationType - the duration type

tsse - the current TechnicalSystemStateEvaluation

Returns:

the calculated Duration

See Also:

AbstractOptionModelCalculation.DurationType, SelectionModel, State, State.getDuration(), StateTransition, StateTransition.getMinDuration(), StateTransition.getMaxDuration(), Duration

getEnergyOrGoodFlow

public AbstractInterfaceFlow getEnergyOrGoodFlow(TechnicalSystemStateEvaluation tsse,
                                                 TechnicalInterface ti)

Returns the EnergyFlowInWatt or the GoodFlow for the specified TechnicalSystemStateEvaluation and its I/O-list settings.

Parameters:

tsse - the current TechnicalSystemStateEvaluation

ti - the EnergyInterface for that an energy flow has to be calculated

Returns:

the energy flow in Watt

getEnergyOrGoodFlow

public abstract AbstractInterfaceFlow getEnergyOrGoodFlow(TechnicalSystemStateEvaluation tsse,
                                                          TechnicalInterface ti,
                                                          boolean isManualConfiguration)

Returns the EnergyFlowInWatt or the GoodFlow for the specified TechnicalSystemStateEvaluation and its I/O-list settings.

Parameters:

tsse - the current TechnicalSystemStateEvaluation

ti - the EnergyInterface for that an energy flow has to be calculated

isManualConfiguration - true, if this method call comes from a manual configuration

Returns:

the energy flow in Watt

getNewEnergyStorageLoad

public EnergyAmount getNewEnergyStorageLoad(EnergyAmount storageLoadOld,
                                            DomainInterfaceFlows domainInterfaceFlows,
                                            long duration)

May return the new energy storage load, based on an individual calculation and the specified parameter.
If further base information are required for calculations, consider to overwrite the method getNewEnergyStorageLoad(EnergyAmount, DomainInterfaceFlows, long, TechnicalSystemStateEvaluation, TechnicalSystemStateEvaluation) instead.

Parameters:

storageLoadOld - the storage load old

domainInterfaceFlows - the domain interface flows

duration - the duration in milliseconds

Returns:

the new storage load

getNewEnergyStorageLoad

public EnergyAmount getNewEnergyStorageLoad(EnergyAmount storageLoadOld,
                                            DomainInterfaceFlows domainInterfaceFlows,
                                            long duration,
                                            TechnicalSystemStateEvaluation initialTSSE,
                                            TechnicalSystemStateEvaluation newTSSE)

May return the new energy storage load, based on an individual calculation and the specified parameter.

Parameters:

storageLoadOld - the storage load old

domainInterfaceFlows - the domain interface flows

duration - the duration in milliseconds

initialTSSE - [contains further optional parameter that might be useful for specific storages and related calculations]
the initial TSSE that represents the system state from which the calculation will be executed. Also contains the old storage load, but provides further information.

newTSSE - [contains further optional parameter that might be useful for specific storages and related calculations]
the new TSSE to which the new storage load will be assigned

Returns:

the new storage load

getNewGoodStorageLoad

public java.lang.Double getNewGoodStorageLoad(double storageLoadOld,
                                              DomainInterfaceFlows domainInterfaceFlows,
                                              long duration)

May return the new good storage load based on an individual calculation and the specified parameter. If further base information are required for calculations, consider to overwrite the method getNewGoodStorageLoad(double, DomainInterfaceFlows, long, TechnicalSystemStateEvaluation, TechnicalSystemStateEvaluation) instead.

Parameters:

storageLoadOld - the storage load old

domainInterfaceFlows - the domain interface flows

duration - the duration in milliseconds

Returns:

the new storage load

getNewGoodStorageLoad

public java.lang.Double getNewGoodStorageLoad(double storageLoadOld,
                                              DomainInterfaceFlows domainInterfaceFlows,
                                              long duration,
                                              TechnicalSystemStateEvaluation initialTSSE,
                                              TechnicalSystemStateEvaluation newTSSE)

May return the new good storage load based on an individual calculation and the specified parameter.

Parameters:

storageLoadOld - the storage load old

domainInterfaceFlows - the domain interface flows

duration - the duration in milliseconds

initialTSSE - [contains further optional parameter that might be useful for specific storages and related calculations]
the initial TSSE that represents the system state from which the calculation will be executed. Also contains the old storage load, but provides further information.

newTSSE - [contains further optional parameter that might be useful for specific storages and related calculations]
the new TSSE to which the new storage load will be assigned

Returns:

the new storage load

getEnergyFlowForLosses

public abstract EnergyFlowInWatt getEnergyFlowForLosses(TechnicalSystemStateEvaluation tsse)

Returns the energy losses as EnergyAmount for the TechnicalInterfaceConfiguration and the State specified within the given TechnicalSystemStateEvaluation.

Parameters:

tsse - the current TechnicalSystemStateEvaluation

Returns:

the energy losses in Watt hours

getTechnicalSystem

protected TechnicalSystem getTechnicalSystem()

Returns the current TechnicalSystem

Returns:

the current TechnicalSystem

isEqualTechnicalSystemStateEvaluation

protected boolean isEqualTechnicalSystemStateEvaluation(TechnicalSystemStateEvaluation tsse1,
                                                        TechnicalSystemStateEvaluation tsse2)

Checks if two specified TechnicalSystemStateEvaluation instances are equal.

Parameters:

tsse1 - the first TechnicalSystemStateEvaluation to compare

tsse2 - the second TechnicalSystemStateEvaluation to compare

Returns:

true, if is equal state and I/O-List

getVariable

protected FixedVariable getVariable(java.util.List<FixedVariable> fixedVariableList,
                                    java.lang.String variableID)

Returns the specified FixedVariable out of the list of FixedVariable's.

Parameters:

fixedVariableList - the list of FixedVariable'

variableID - the ID of the variable

Returns:

the fixed variable found or null

getOrCreateVariable

protected FixedVariable getOrCreateVariable(java.util.List<FixedVariable> fixedVariableList,
                                            java.lang.String variableID)

Gets or creates the specified variable.

Parameters:

fixedVariableList - the fixed variable list

variableID - the variable ID

Returns:

the or create variable

setVariable

protected void setVariable(java.util.List<FixedVariable> fixedVariableList,
                           java.lang.String variableID,
                           FixedVariable newValue)

Sets a new value for the specified FixedVariable.

Parameters:

fixedVariableList - the list of FixedVariable'

variableID - the ID of the variable

newValue - the new value as FixedVariable

setGroupEvaluationStrategy

public void setGroupEvaluationStrategy(AbstractGroupEvaluationStrategy abstractGroupEvaluationStrategy)

Sets the current group evaluation strategy.

Parameters:

abstractGroupEvaluationStrategy - the new group evaluation strategy

getGroupEvaluationStrategy

public AbstractGroupEvaluationStrategy getGroupEvaluationStrategy()

Returns the current group evaluation strategy. In case that no own strategy is defined, the FallBackGroupStrategy will be used, which only summarises the energy flows, without doing any network calculation.

Returns:

the group evaluation strategy as AbstractGroupEvaluationStrategy