GenericBattery

mutable struct GenericBattery <: Storage
    name::String
    available::Bool
    bus::ACBus
    prime_mover_type::PrimeMovers
    initial_energy::Float64
    state_of_charge_limits::MinMax
    rating::Float64
    active_power::Float64
    input_active_power_limits::MinMax
    output_active_power_limits::MinMax
    efficiency::NamedTuple{(:in, :out), Tuple{Float64, Float64}}
    reactive_power::Float64
    reactive_power_limits::Union{Nothing, MinMax}
    base_power::Float64
    operation_cost::Union{StorageManagementCost, MarketBidCost}
    services::Vector{Service}
    dynamic_injector::Union{Nothing, DynamicInjection}
    ext::Dict{String, Any}
    time_series_container::InfrastructureSystems.TimeSeriesContainer
    internal::InfrastructureSystemsInternal
end

Data structure for a generic battery

Arguments

• name::String
• available::Bool
• bus::ACBus
• prime_mover_type::PrimeMovers: Prime mover technology according to EIA 923
• initial_energy::Float64: State of Charge of the Battery p.u.-hr, validation range: (0, nothing), action if invalid: error
• state_of_charge_limits::MinMax: Maximum and Minimum storage capacity in p.u.-hr, validation range: (0, nothing), action if invalid: error
• rating::Float64
• active_power::Float64
• input_active_power_limits::MinMax, validation range: (0, nothing), action if invalid: error
• output_active_power_limits::MinMax, validation range: (0, nothing), action if invalid: error
• efficiency::NamedTuple{(:in, :out), Tuple{Float64, Float64}}, validation range: (0, 1), action if invalid: warn
• reactive_power::Float64, validation range: reactive_power_limits, action if invalid: warn
• reactive_power_limits::Union{Nothing, MinMax}
• base_power::Float64: Base power of the unit in MVA, validation range: (0, nothing), action if invalid: warn
• operation_cost::Union{StorageManagementCost, MarketBidCost}
• services::Vector{Service}: Services that this device contributes to
• dynamic_injector::Union{Nothing, DynamicInjection}: corresponding dynamic injection device
• ext::Dict{String, Any}
• time_series_container::InfrastructureSystems.TimeSeriesContainer: internal time_series storage
• internal::InfrastructureSystemsInternal: power system internal reference, do not modify

get_name(value::GenericBattery) -> String

Get GenericBattery name.

get_time_series_container(
    value::GenericBattery
) -> InfrastructureSystems.TimeSeriesContainer

Get GenericBattery time_series_container.

get_active_power(value::GenericBattery) -> Any

Get GenericBattery active_power.

get_available(value::GenericBattery) -> Bool

Get GenericBattery available.

get_base_power(value::GenericBattery) -> Float64

Get GenericBattery base_power.

get_bus(value::GenericBattery) -> ACBus

Get GenericBattery bus.

get_dynamic_injector(
    value::GenericBattery
) -> Union{Nothing, DynamicInjection}

Get GenericBattery dynamic_injector.

get_efficiency(
    value::GenericBattery
) -> @NamedTuple{in::Float64, out::Float64}

Get GenericBattery efficiency.

get_ext(value::GenericBattery) -> Dict{String, Any}

Get GenericBattery ext.

get_initial_energy(value::GenericBattery) -> Any

Get GenericBattery initial_energy.

get_input_active_power_limits(
    value::GenericBattery
) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}

Get GenericBattery input_active_power_limits.

get_operation_cost(
    value::GenericBattery
) -> Union{MarketBidCost, StorageManagementCost}

Get GenericBattery operation_cost.

get_output_active_power_limits(
    value::GenericBattery
) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}

Get GenericBattery output_active_power_limits.

get_prime_mover_type(value::GenericBattery) -> PrimeMovers

Get GenericBattery prime_mover_type.

get_rating(value::GenericBattery) -> Any

Get GenericBattery rating.

get_reactive_power(value::GenericBattery) -> Any

Get GenericBattery reactive_power.

get_reactive_power_limits(
    value::GenericBattery
) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}

Get GenericBattery reactive_power_limits.

get_services(value::GenericBattery) -> Vector{Service}

Get GenericBattery services.

get_state_of_charge_limits(
    value::GenericBattery
) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}

Get GenericBattery state_of_charge_limits.

set_active_power!(value::GenericBattery, val) -> Any

Set GenericBattery active_power.

set_available!(value::GenericBattery, val) -> Any

Set GenericBattery available.

set_base_power!(value::GenericBattery, val) -> Any

Set GenericBattery base_power.

set_bus!(value::GenericBattery, val) -> Any

Set GenericBattery bus.

set_efficiency!(value::GenericBattery, val) -> Any

Set GenericBattery efficiency.

set_ext!(value::GenericBattery, val) -> Any

Set GenericBattery ext.

set_initial_energy!(value::GenericBattery, val) -> Any

Set GenericBattery initial_energy.

set_input_active_power_limits!(
    value::GenericBattery,
    val
) -> Any

Set GenericBattery input_active_power_limits.

set_operation_cost!(value::GenericBattery, val) -> Any

Set GenericBattery operation_cost.

set_output_active_power_limits!(
    value::GenericBattery,
    val
) -> Any

Set GenericBattery output_active_power_limits.

set_prime_mover_type!(value::GenericBattery, val) -> Any

Set GenericBattery prime_mover_type.

set_rating!(value::GenericBattery, val) -> Any

Set GenericBattery rating.

set_reactive_power!(value::GenericBattery, val) -> Any

Set GenericBattery reactive_power.

set_reactive_power_limits!(
    value::GenericBattery,
    val
) -> Any

Set GenericBattery reactive_power_limits.

set_services!(value::GenericBattery, val) -> Any

Set GenericBattery services.

set_state_of_charge_limits!(
    value::GenericBattery,
    val
) -> Any

Set GenericBattery state_of_charge_limits.

set_time_series_container!(
    value::GenericBattery,
    val
) -> Any

Set GenericBattery time_series_container.