BatteryEMS

mutable struct BatteryEMS <: Storage
    name::String
    available::Bool
    bus::Bus
    prime_mover::PrimeMovers
    initial_energy::Float64
    state_of_charge_limits::NamedTuple{(:min, :max), Tuple{Float64, Float64}}
    rating::Float64
    active_power::Float64
    input_active_power_limits::NamedTuple{(:min, :max), Tuple{Float64, Float64}}
    output_active_power_limits::NamedTuple{(:min, :max), Tuple{Float64, Float64}}
    efficiency::NamedTuple{(:in, :out), Tuple{Float64, Float64}}
    reactive_power::Float64
    reactive_power_limits::Union{Nothing, Min_Max}
    base_power::Float64
    operation_cost::Union{Nothing, OperationalCost}
    storage_target::Float64
    services::Vector{Service}
    dynamic_injector::Union{Nothing, DynamicInjection}
    ext::Dict{String, Any}
    time_series_container::InfrastructureSystems.TimeSeriesContainer
    internal::InfrastructureSystemsInternal
end

Data structure for a battery compatible with energy management formulations.

Arguments

• name::String
• available::Bool
• bus::Bus
• prime_mover::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::NamedTuple{(:min, :max), Tuple{Float64, Float64}}: 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::NamedTuple{(:min, :max), Tuple{Float64, Float64}}, validation range: (0, nothing), action if invalid: error
• output_active_power_limits::NamedTuple{(:min, :max), Tuple{Float64, Float64}}, 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, Min_Max}
• base_power::Float64: Base power of the unit in MVA, validation range: (0, nothing), action if invalid: warn
• operation_cost::Union{Nothing, OperationalCost}
• storage_target::Float64: Storage target at the end of simulation as ratio of storage capacity.
• 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::BatteryEMS) -> String

Get BatteryEMS name.

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

Get BatteryEMS time_series_container.

set_name!(value::BatteryEMS, val) -> Any

Set BatteryEMS name.

get_active_power(value::BatteryEMS) -> Any

Get BatteryEMS active_power.

get_available(value::BatteryEMS) -> Bool

Get BatteryEMS available.

get_base_power(value::BatteryEMS) -> Float64

Get BatteryEMS base_power.

get_bus(value::BatteryEMS) -> Bus

Get BatteryEMS bus.

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

Get BatteryEMS dynamic_injector.

get_efficiency(value::BatteryEMS) -> NamedTuple{(:in, :out), Tuple{Float64, Float64}}

Get BatteryEMS efficiency.

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

Get BatteryEMS ext.

get_initial_energy(value::BatteryEMS) -> Any

Get BatteryEMS initial_energy.

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

Get BatteryEMS input_active_power_limits.

get_operation_cost(value::BatteryEMS) -> Union{Nothing, PowerSystems.OperationalCost}

Get BatteryEMS operation_cost.

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

Get BatteryEMS output_active_power_limits.

get_prime_mover(value::BatteryEMS) -> PrimeMovers

Get BatteryEMS prime_mover.

get_rating(value::BatteryEMS) -> Any

Get BatteryEMS rating.

get_reactive_power(value::BatteryEMS) -> Any

Get BatteryEMS reactive_power.

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

Get BatteryEMS reactive_power_limits.

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

Get BatteryEMS services.

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

Get BatteryEMS state_of_charge_limits.

get_storage_target(value::BatteryEMS) -> Float64

Get BatteryEMS storage_target.

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

Set BatteryEMS active_power.

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

Set BatteryEMS available.

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

Set BatteryEMS base_power.

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

Set BatteryEMS bus.

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

Set BatteryEMS efficiency.

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

Set BatteryEMS ext.

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

Set BatteryEMS initial_energy.

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

Set BatteryEMS input_active_power_limits.

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

Set BatteryEMS operation_cost.

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

Set BatteryEMS output_active_power_limits.

set_prime_mover!(value::BatteryEMS, val) -> Any

Set BatteryEMS prime_mover.

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

Set BatteryEMS rating.

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

Set BatteryEMS reactive_power.

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

Set BatteryEMS reactive_power_limits.

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

Set BatteryEMS services.

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

Set BatteryEMS state_of_charge_limits.

set_storage_target!(value::BatteryEMS, val) -> Any

Set BatteryEMS storage_target.

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

Set BatteryEMS time_series_container.