-
Notifications
You must be signed in to change notification settings - Fork 70
/
BatteryEMS.jl
211 lines (202 loc) · 11.2 KB
/
BatteryEMS.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
#=
This file is auto-generated. Do not edit.
=#
#! format: off
"""
mutable struct BatteryEMS <: 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::StorageManagementCost
storage_target::Float64
cycle_limits::Int
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::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::StorageManagementCost`
- `storage_target::Float64`: Storage target at the end of simulation as ratio of storage capacity.
- `cycle_limits::Int`: Storage Maximum number of cycles per year
- `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
"""
mutable struct BatteryEMS <: Storage
name::String
available::Bool
bus::ACBus
"Prime mover technology according to EIA 923"
prime_mover_type::PrimeMovers
"State of Charge of the Battery p.u.-hr"
initial_energy::Float64
"Maximum and Minimum storage capacity in p.u.-hr"
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 of the unit in MVA"
base_power::Float64
operation_cost::StorageManagementCost
"Storage target at the end of simulation as ratio of storage capacity."
storage_target::Float64
"Storage Maximum number of cycles per year"
cycle_limits::Int
"Services that this device contributes to"
services::Vector{Service}
"corresponding dynamic injection device"
dynamic_injector::Union{Nothing, DynamicInjection}
ext::Dict{String, Any}
"internal time_series storage"
time_series_container::InfrastructureSystems.TimeSeriesContainer
"power system internal reference, do not modify"
internal::InfrastructureSystemsInternal
end
function BatteryEMS(name, available, bus, prime_mover_type, initial_energy, state_of_charge_limits, rating, active_power, input_active_power_limits, output_active_power_limits, efficiency, reactive_power, reactive_power_limits, base_power, operation_cost=Union{StorageManagementCost, MarketBidCost}, storage_target=0.0, cycle_limits=1e4, services=Device[], dynamic_injector=nothing, ext=Dict{String, Any}(), time_series_container=InfrastructureSystems.TimeSeriesContainer(), )
BatteryEMS(name, available, bus, prime_mover_type, initial_energy, state_of_charge_limits, rating, active_power, input_active_power_limits, output_active_power_limits, efficiency, reactive_power, reactive_power_limits, base_power, operation_cost, storage_target, cycle_limits, services, dynamic_injector, ext, time_series_container, InfrastructureSystemsInternal(), )
end
function BatteryEMS(; name, available, bus, prime_mover_type, initial_energy, state_of_charge_limits, rating, active_power, input_active_power_limits, output_active_power_limits, efficiency, reactive_power, reactive_power_limits, base_power, operation_cost=Union{StorageManagementCost, MarketBidCost}, storage_target=0.0, cycle_limits=1e4, services=Device[], dynamic_injector=nothing, ext=Dict{String, Any}(), time_series_container=InfrastructureSystems.TimeSeriesContainer(), internal=InfrastructureSystemsInternal(), )
BatteryEMS(name, available, bus, prime_mover_type, initial_energy, state_of_charge_limits, rating, active_power, input_active_power_limits, output_active_power_limits, efficiency, reactive_power, reactive_power_limits, base_power, operation_cost, storage_target, cycle_limits, services, dynamic_injector, ext, time_series_container, internal, )
end
# Constructor for demo purposes; non-functional.
function BatteryEMS(::Nothing)
BatteryEMS(;
name="init",
available=false,
bus=ACBus(nothing),
prime_mover_type=PrimeMovers.BA,
initial_energy=0.0,
state_of_charge_limits=(min=0.0, max=0.0),
rating=0.0,
active_power=0.0,
input_active_power_limits=(min=0.0, max=0.0),
output_active_power_limits=(min=0.0, max=0.0),
efficiency=(in=0.0, out=0.0),
reactive_power=0.0,
reactive_power_limits=(min=0.0, max=0.0),
base_power=0.0,
operation_cost=StorageManagementCost(),
storage_target=0.0,
cycle_limits=0,
services=Device[],
dynamic_injector=nothing,
ext=Dict{String, Any}(),
time_series_container=InfrastructureSystems.TimeSeriesContainer(),
)
end
"""Get [`BatteryEMS`](@ref) `name`."""
get_name(value::BatteryEMS) = value.name
"""Get [`BatteryEMS`](@ref) `available`."""
get_available(value::BatteryEMS) = value.available
"""Get [`BatteryEMS`](@ref) `bus`."""
get_bus(value::BatteryEMS) = value.bus
"""Get [`BatteryEMS`](@ref) `prime_mover_type`."""
get_prime_mover_type(value::BatteryEMS) = value.prime_mover_type
"""Get [`BatteryEMS`](@ref) `initial_energy`."""
get_initial_energy(value::BatteryEMS) = get_value(value, value.initial_energy)
"""Get [`BatteryEMS`](@ref) `state_of_charge_limits`."""
get_state_of_charge_limits(value::BatteryEMS) = get_value(value, value.state_of_charge_limits)
"""Get [`BatteryEMS`](@ref) `rating`."""
get_rating(value::BatteryEMS) = get_value(value, value.rating)
"""Get [`BatteryEMS`](@ref) `active_power`."""
get_active_power(value::BatteryEMS) = get_value(value, value.active_power)
"""Get [`BatteryEMS`](@ref) `input_active_power_limits`."""
get_input_active_power_limits(value::BatteryEMS) = get_value(value, value.input_active_power_limits)
"""Get [`BatteryEMS`](@ref) `output_active_power_limits`."""
get_output_active_power_limits(value::BatteryEMS) = get_value(value, value.output_active_power_limits)
"""Get [`BatteryEMS`](@ref) `efficiency`."""
get_efficiency(value::BatteryEMS) = value.efficiency
"""Get [`BatteryEMS`](@ref) `reactive_power`."""
get_reactive_power(value::BatteryEMS) = get_value(value, value.reactive_power)
"""Get [`BatteryEMS`](@ref) `reactive_power_limits`."""
get_reactive_power_limits(value::BatteryEMS) = get_value(value, value.reactive_power_limits)
"""Get [`BatteryEMS`](@ref) `base_power`."""
get_base_power(value::BatteryEMS) = value.base_power
"""Get [`BatteryEMS`](@ref) `operation_cost`."""
get_operation_cost(value::BatteryEMS) = value.operation_cost
"""Get [`BatteryEMS`](@ref) `storage_target`."""
get_storage_target(value::BatteryEMS) = value.storage_target
"""Get [`BatteryEMS`](@ref) `cycle_limits`."""
get_cycle_limits(value::BatteryEMS) = value.cycle_limits
"""Get [`BatteryEMS`](@ref) `services`."""
get_services(value::BatteryEMS) = value.services
"""Get [`BatteryEMS`](@ref) `dynamic_injector`."""
get_dynamic_injector(value::BatteryEMS) = value.dynamic_injector
"""Get [`BatteryEMS`](@ref) `ext`."""
get_ext(value::BatteryEMS) = value.ext
"""Get [`BatteryEMS`](@ref) `time_series_container`."""
get_time_series_container(value::BatteryEMS) = value.time_series_container
"""Get [`BatteryEMS`](@ref) `internal`."""
get_internal(value::BatteryEMS) = value.internal
"""Set [`BatteryEMS`](@ref) `available`."""
set_available!(value::BatteryEMS, val) = value.available = val
"""Set [`BatteryEMS`](@ref) `bus`."""
set_bus!(value::BatteryEMS, val) = value.bus = val
"""Set [`BatteryEMS`](@ref) `prime_mover_type`."""
set_prime_mover_type!(value::BatteryEMS, val) = value.prime_mover_type = val
"""Set [`BatteryEMS`](@ref) `initial_energy`."""
set_initial_energy!(value::BatteryEMS, val) = value.initial_energy = set_value(value, val)
"""Set [`BatteryEMS`](@ref) `state_of_charge_limits`."""
set_state_of_charge_limits!(value::BatteryEMS, val) = value.state_of_charge_limits = set_value(value, val)
"""Set [`BatteryEMS`](@ref) `rating`."""
set_rating!(value::BatteryEMS, val) = value.rating = set_value(value, val)
"""Set [`BatteryEMS`](@ref) `active_power`."""
set_active_power!(value::BatteryEMS, val) = value.active_power = set_value(value, val)
"""Set [`BatteryEMS`](@ref) `input_active_power_limits`."""
set_input_active_power_limits!(value::BatteryEMS, val) = value.input_active_power_limits = set_value(value, val)
"""Set [`BatteryEMS`](@ref) `output_active_power_limits`."""
set_output_active_power_limits!(value::BatteryEMS, val) = value.output_active_power_limits = set_value(value, val)
"""Set [`BatteryEMS`](@ref) `efficiency`."""
set_efficiency!(value::BatteryEMS, val) = value.efficiency = val
"""Set [`BatteryEMS`](@ref) `reactive_power`."""
set_reactive_power!(value::BatteryEMS, val) = value.reactive_power = set_value(value, val)
"""Set [`BatteryEMS`](@ref) `reactive_power_limits`."""
set_reactive_power_limits!(value::BatteryEMS, val) = value.reactive_power_limits = set_value(value, val)
"""Set [`BatteryEMS`](@ref) `base_power`."""
set_base_power!(value::BatteryEMS, val) = value.base_power = val
"""Set [`BatteryEMS`](@ref) `operation_cost`."""
set_operation_cost!(value::BatteryEMS, val) = value.operation_cost = val
"""Set [`BatteryEMS`](@ref) `storage_target`."""
set_storage_target!(value::BatteryEMS, val) = value.storage_target = val
"""Set [`BatteryEMS`](@ref) `cycle_limits`."""
set_cycle_limits!(value::BatteryEMS, val) = value.cycle_limits = val
"""Set [`BatteryEMS`](@ref) `services`."""
set_services!(value::BatteryEMS, val) = value.services = val
"""Set [`BatteryEMS`](@ref) `ext`."""
set_ext!(value::BatteryEMS, val) = value.ext = val
"""Set [`BatteryEMS`](@ref) `time_series_container`."""
set_time_series_container!(value::BatteryEMS, val) = value.time_series_container = val