Variable Cost Refactor Part 2: PowerSimulations

docs/src/formulation_library/General.md

@@ -56,38 +56,53 @@ No constraints are created for `DeviceModel(<:DeviceType, FixedOutput)`
 
 ---
 
-## `VariableCost` Options
+## `FunctionData` Options
 
 PowerSimulations can represent variable costs using a variety of different methods depending on the data available in each device. The following describes the objective function terms that are populated for each variable cost option.
 
-### Scalar `VariableCost`
+### `LinearFunctionData`
 
-`variable_cost <: Float64`: creates a fixed marginal cost term in the objective function
+`variable_cost = LinearFunctionData(c)`: creates a fixed marginal cost term in the objective function
 
 ```math
 \begin{aligned}
-&  \text{min} \sum_{t} C * G_t
+&  \text{min} \sum_{t} c * G_t
 \end{aligned}
 ```
 
-### Polynomial `VariableCost`
+### `QuadraticFunctionData` and `PolynomialFunctionData`
 
-`variable_cost <: Tuple{Float64, Float64}`: creates a polynomial cost term in the objective function where
-
-- ``C_g``=`variable_cost[1]`
-- ``C_g^\prime``=`variable_cost[2]`
+`variable_cost::QuadraticFunctionData` and `variable_cost::PolynomialFunctionData`: create a polynomial cost term in the objective function
 
 ```math
 \begin{aligned}
-&  \text{min} \sum_{t} C * G_t + C^\prime * G_t^2
+&  \text{min} \sum_{t} \sum_{n} C_n * G_t^n
 \end{aligned}
 ```
 
-### Piecewise Linear `VariableCost`
+where
+
+- For `QuadraticFunctionData`:
+  - ``C_0`` = `get_constant_term(variable_cost)`
+  - ``C_1`` = `get_proportional_term(variable_cost)`
+  - ``C_2`` = `get_quadratic_term(variable_cost)`
+- For `PolynomialFunctionData`:
+  - ``C_n`` = `get_coefficients(variable_cost)[n]`
+
+### `PiecewiseLinearPointData` and `PiecewiseLinearSlopeData`
+
+`variable_cost::PiecewiseLinearPointData` and `variable_cost::PiecewiseLinearSlopeData`: create a piecewise linear cost term in the objective function
+
+```math
+\begin{aligned}
+&  \text{min} \sum_{t} f(G_t)
+\end{aligned}
+```
 
-`variable_cost <: Vector{Tuple{Float64, Float64}}`: creates a piecewise linear cost term in the objective function
+where
 
-TODO: add formulation
+- For `variable_cost::PiecewiseLinearPointData`, ``f(x)`` is the piecewise linear function obtained by connecting the `(x, y)` points `get_points(variable_cost)` in order.
+- For `variable_cost = PiecewiseLinearSlopeData([x0, x1, x2, ...], y0, [s0, s1, s2, ...])`, ``f(x)`` is the piecewise linear function obtained by starting at `(x0, y0)`, drawing a segment at slope `s0` to `x=x1`, drawing a segment at slope `s1` to `x=x2`, etc.
 
 ___
 

docs/src/formulation_library/Load.md

@@ -89,7 +89,7 @@ mdtable(combo_table, latex = false)
 
 **Objective:**
 
-Creates an objective function term based on the [`VariableCost` Options](@ref) where the quantity term is defined as ``Pg``.
+Creates an objective function term based on the [`FunctionData` Options](@ref) where the quantity term is defined as ``Pg``.
 
 **Expressions:**
 
@@ -143,7 +143,7 @@ mdtable(combo_table, latex = false)
 
 **Objective:**
 
-Creates an objective function term based on the [`VariableCost` Options](@ref) where the quantity term is defined as ``Pg``.
+Creates an objective function term based on the [`FunctionData` Options](@ref) where the quantity term is defined as ``Pg``.
 
 **Expressions:**
 

docs/src/formulation_library/RenewableGen.md

@@ -57,7 +57,7 @@ mdtable(combo_table, latex = false)
 
 **Objective:**
 
-Creates an objective function term based on the [`VariableCost` Options](@ref) where the quantity term is defined as ``- Pg_t`` to incentivize generation from `RenewableGen` devices.
+Creates an objective function term based on the [`FunctionData` Options](@ref) where the quantity term is defined as ``- Pg_t`` to incentivize generation from `RenewableGen` devices.
 
 **Expressions:**
 
@@ -113,7 +113,7 @@ mdtable(combo_table, latex = false)
 
 **Objective:**
 
-Creates an objective function term based on the [`VariableCost` Options](@ref) where the quantity term is defined as ``- Pg_t`` to incentivize generation from `RenewableGen` devices.
+Creates an objective function term based on the [`FunctionData` Options](@ref) where the quantity term is defined as ``- Pg_t`` to incentivize generation from `RenewableGen` devices.
 
 **Expressions:**