SimpleEpEnergyStorage

Package: inet.power.storage

SimpleEpEnergyStorage

simple module

C++ definition

This energy storage model maintains a residual energy capacity by integrating the difference between the total consumed power and the total generated power over time. It initiates node crash when the residual energy capacity reaches zero. This model does not have various properties such as self-discharge, memory effect, overcharging, temperature-dependence, etc. that real-world batteries have. See the base module for signals and statistics.

<b>See also:</b> ~SimpleEpEnergyManagement

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends

Name Type Description
EpEnergyStorageBase simple module

This is an abstract base module for power-based energy storage models. It defines shared signals and statistics.

Parameters

Name Type Default value Description
displayStringTextFormat string "%c (%p)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

nominalCapacity double

The maximum amount of energy stored

initialCapacity double nominalCapacity

The initially stored amount of energy

printCapacityStep double 0.01 * nominalCapacity

Displays residual capacity changes in the log

Properties

Name Value Description
class SimpleEpEnergyStorage
display i=block/plug

Signals

Name Type Unit Description
residualEnergyCapacityChanged
powerConsumptionChanged
powerGenerationChanged

Statistics

Name Title Source Record Unit Interpolation Mode Description
residualEnergyCapacity Residual energy capacity residualEnergyCapacityChanged vector, last J linear
powerConsumption Power consumption powerConsumptionChanged vector W sample-hold
powerGeneration Power generation powerGenerationChanged vector W sample-hold

Source code

//
// This energy storage model maintains a residual energy capacity by integrating
// the difference between the total consumed power and the total generated power
// over time. It initiates node crash when the residual energy capacity reaches
// zero. This model does not have various properties such as self-discharge, memory
// effect, overcharging, temperature-dependence, etc. that real-world batteries
// have. See the base module for signals and statistics.
//
// @see ~SimpleEpEnergyManagement
//
simple SimpleEpEnergyStorage extends EpEnergyStorageBase
{
    parameters:
        double nominalCapacity @unit(J); // The maximum amount of energy stored
        double initialCapacity @unit(J) = default(nominalCapacity); // The initially stored amount of energy
        double printCapacityStep @unit(J) = default(0.01 * nominalCapacity); // Displays residual capacity changes in the log
        displayStringTextFormat = default("%c (%p)");
        @class(SimpleEpEnergyStorage);
}

File: src/inet/power/storage/SimpleEpEnergyStorage.ned