ColdStorage (PowerTAC customer models 1.1.0 API)

java.lang.Object
- org.powertac.customer.AbstractCustomer
- - org.powertac.customer.coldstorage.ColdStorage

All Implemented Interfaces:

org.powertac.common.interfaces.CustomerModelAccessor
```
@ConfigurableInstance
public class ColdStorage
extends AbstractCustomer
```
Model of a cold-storage warehouse with multiple refrigeration units. The size of the refrigeration units is specified as stockCapacity. The number is indeterminate - as many as needed will be used, depending on heat loss and current internal temperature. If currentTemp < nominalTemp and falling or steady, then a unit will be de-energized. If currentTemp >= nominalTemp and rising or steady, then another unit will be activated.

Author:

John Collins

Field Summary
- Fields inherited from class org.powertac.customer.AbstractCustomer
  customerInfo, name, randomSeedRepo, tariffRepo, tariffSubscriptionRepo, weatherReportRepo

Constructor Summary

Constructors
Constructor and Description

ColdStorage()
Default constructor, requires manual setting of name

ColdStorage(String name)
Constructor with name

Constructors
Constructor and Description
`ColdStorage()` Default constructor, requires manual setting of name
`ColdStorage(String name)` Constructor with name

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`evaluateTariffs(List<org.powertac.common.Tariff> tariffs)` Called to evaluate tariffs.
`double`	`getBrokerSwitchFactor(boolean isSuperseding)`
`double[]`	`getCapacityProfile(org.powertac.common.Tariff tariff)`
`double`	`getCop()`
`double`	`getCurrentTemp()`
`double`	`getFloorRValue()`
`double`	`getHysteresis()`
`double`	`getInertiaSample()`
`double`	`getInfiltrationRatio()`
`double`	`getMaxTemp()`
`double`	`getMinTemp()`
`double`	`getNewStockTemp()`
`double`	`getNominalTemp()`
`double`	`getNonCoolingUsage()`
`double`	`getRoofArea()`
`double`	`getRoofRValue()`
`double`	`getStockCapacity()`
`double`	`getTariffChoiceSample()`
`double`	`getTurnoverRatio()`
`double`	`getUnitSize()`
`double`	`getWallArea()`
`double`	`getWallRValue()`
`void`	`initialize()` Initializes the instance.
`void`	`step()` Called to run the model forward one step.
`ColdStorage`	`withCop(double value)`
`ColdStorage`	`withFloorRValue(double value)`
`ColdStorage`	`withHysteresis(double value)`
`ColdStorage`	`withInfiltrationRatio(double value)`
`ColdStorage`	`withMaxTemp(double temp)`
`ColdStorage`	`withMinTemp(double temp)`
`ColdStorage`	`withNewStockTemp(double temp)`
`ColdStorage`	`withNominalTemp(double temp)`
`ColdStorage`	`withNonCoolingUsage(double value)`
`ColdStorage`	`withRoofArea(double area)`
`ColdStorage`	`withRoofRValue(double value)`
`ColdStorage`	`withStockCapacity(double value)`
`ColdStorage`	`withTurnoverRatio(double ratio)`
`ColdStorage`	`withUnitSize(double cap)`
`ColdStorage`	`withWallArea(double area)`
`ColdStorage`	`withWallRValue(double value)`

Methods inherited from class org.powertac.customer.AbstractCustomer
getCurrentSubscriptions, getCustomerInfo, getName, setName, setServices

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ColdStorage
```
public ColdStorage()
```
  Default constructor, requires manual setting of name
- ColdStorage
```
public ColdStorage(String name)
```
  Constructor with name

Method Detail

initialize
```
public void initialize()
```
Description copied from class: AbstractCustomer

Initializes the instance. Called after configuration, and after a call to setServices(). Subclasses must call this method to get the CustomerInfo registered.

Overrides:

initialize in class AbstractCustomer

step
```
public void step()
```
Description copied from class: AbstractCustomer

Called to run the model forward one step.

Specified by:

step in class AbstractCustomer

evaluateTariffs
```
public void evaluateTariffs(List<org.powertac.common.Tariff> tariffs)
```
Description copied from class: AbstractCustomer

Called to evaluate tariffs.

Specified by:

evaluateTariffs in class AbstractCustomer

getCapacityProfile

public double[] getCapacityProfile(org.powertac.common.Tariff tariff)

getBrokerSwitchFactor

public double getBrokerSwitchFactor(boolean isSuperseding)

getTariffChoiceSample
```
public double getTariffChoiceSample()
```

getInertiaSample
```
public double getInertiaSample()
```

getCurrentTemp
```
public double getCurrentTemp()
```

getMinTemp
```
public double getMinTemp()
```

withMinTemp

@ConfigurableValue(valueType="Double",
                   description="minimum allowable temperature")
public ColdStorage withMinTemp(double temp)

getMaxTemp
```
public double getMaxTemp()
```

withMaxTemp

@ConfigurableValue(valueType="Double",
                   description="maximum allowable temperature")
public ColdStorage withMaxTemp(double temp)

getNominalTemp
```
public double getNominalTemp()
```

withNominalTemp

@ConfigurableValue(valueType="Double",
                   description="nominal internal temperature")
public ColdStorage withNominalTemp(double temp)

getNewStockTemp
```
public double getNewStockTemp()
```

withNewStockTemp

@ConfigurableValue(valueType="Double",
                   description="Temperature of incoming stock")
public ColdStorage withNewStockTemp(double temp)

getStockCapacity
```
public double getStockCapacity()
```

withStockCapacity

@ConfigurableValue(valueType="Double",
                   description="Typical inventory in tonnes of H2O")
public ColdStorage withStockCapacity(double value)

getTurnoverRatio
```
public double getTurnoverRatio()
```

withTurnoverRatio

@ConfigurableValue(valueType="Double",
                   description="Ratio of stock that gets replaced daily")
public ColdStorage withTurnoverRatio(double ratio)

getRoofArea
```
public double getRoofArea()
```

withRoofArea

@ConfigurableValue(valueType="Double",
                   description="Area of roof")
public ColdStorage withRoofArea(double area)

getRoofRValue
```
public double getRoofRValue()
```

withRoofRValue

@ConfigurableValue(valueType="Double",
                   description="R-value of roof insulation")
public ColdStorage withRoofRValue(double value)

getWallArea
```
public double getWallArea()
```

withWallArea

@ConfigurableValue(valueType="Double",
                   description="Total area of outside walls")
public ColdStorage withWallArea(double area)

getWallRValue
```
public double getWallRValue()
```

withWallRValue

@ConfigurableValue(valueType="Double",
                   description="R-value of wall insulation")
public ColdStorage withWallRValue(double value)

getFloorRValue
```
public double getFloorRValue()
```

withFloorRValue

@ConfigurableValue(valueType="Double",
                   description="R-value of floor insulation")
public ColdStorage withFloorRValue(double value)

getInfiltrationRatio
```
public double getInfiltrationRatio()
```

withInfiltrationRatio

@ConfigurableValue(valueType="Double",
                   description="Infiltration loss as proportion of wall + roof loss")
public ColdStorage withInfiltrationRatio(double value)

getUnitSize
```
public double getUnitSize()
```

withUnitSize

@ConfigurableValue(valueType="Double",
                   description="Thermal capacity in tons of cooling plant")
public ColdStorage withUnitSize(double cap)

getCop
```
public double getCop()
```

withCop

@ConfigurableValue(valueType="Double",
                   description="Coefficient of Performance of refrigeration unit")
public ColdStorage withCop(double value)

getHysteresis
```
public double getHysteresis()
```

withHysteresis

@ConfigurableValue(valueType="Double",
                   description="Control range for refrigeration unit")
public ColdStorage withHysteresis(double value)

getNonCoolingUsage
```
public double getNonCoolingUsage()
```

withNonCoolingUsage

@ConfigurableValue(valueType="Double",
                   description="Mean hourly energy usage for non-cooling purposes")
public ColdStorage withNonCoolingUsage(double value)

Class ColdStorage

Field Summary

Fields inherited from class org.powertac.customer.AbstractCustomer

Constructor Summary

Method Summary

Methods inherited from class org.powertac.customer.AbstractCustomer

Methods inherited from class java.lang.Object

Constructor Detail

ColdStorage

ColdStorage

Method Detail

initialize

step

evaluateTariffs

getCapacityProfile

getBrokerSwitchFactor

getTariffChoiceSample

getInertiaSample

getCurrentTemp

getMinTemp

withMinTemp

getMaxTemp

withMaxTemp

getNominalTemp

withNominalTemp

getNewStockTemp

withNewStockTemp

getStockCapacity

withStockCapacity

getTurnoverRatio

withTurnoverRatio

getRoofArea

withRoofArea

getRoofRValue

withRoofRValue

getWallArea

withWallArea

getWallRValue

withWallRValue

getFloorRValue

withFloorRValue

getInfiltrationRatio

withInfiltrationRatio

getUnitSize

withUnitSize

getCop

withCop

getHysteresis

withHysteresis

getNonCoolingUsage

withNonCoolingUsage