Minor updates (#75)

Author: JulStraus

src/checks.jl

@@ -857,7 +857,7 @@ a [`Sink`](@ref) node.
 - The values of the dictionary `input` are required to be non-negative.
 - The dictionary `penalty` is required to have the keys `:deficit` and `:surplus`.
 - The sum of the values `:deficit` and `:surplus` in the dictionary `penalty` has to be
-    non-negative to avoid an infeasible model.
+  non-negative to avoid an infeasible model.
 """
 function check_node_default(n::Sink, 𝒯, modeltype::EnergyModel, check_timeprofiles::Bool)
     @assert_or_log(
@@ -870,11 +870,10 @@ function check_node_default(n::Sink, 𝒯, modeltype::EnergyModel, check_timepro
     )
     @assert_or_log(
         :surplus ∈ keys(n.penalty) && :deficit ∈ keys(n.penalty),
-        "The entries :surplus and :deficit are required in the field `penalty`"
+        "The entries `:surplus` and `:deficit` are required in the field `penalty`."
     )
 
     if :surplus ∈ keys(n.penalty) && :deficit ∈ keys(n.penalty)
-        # The if-condition was checked above.
         @assert_or_log(
             all(surplus_penalty(n, t) + deficit_penalty(n, t) ≥ 0 for t ∈ 𝒯),
             "An inconsistent combination of `:surplus` and `:deficit` leads to an infeasible model."

src/constraint_functions.jl

@@ -176,10 +176,9 @@ end
 function constraints_flow_out(m, n::Storage, 𝒯::TimeStructure, modeltype::EnergyModel)
     # Declaration of the required subsets
     p_stor = storage_resource(n)
-    𝒫ᵒᵘᵗ = res_not(outputs(n), co2_instance(modeltype))
 
     # Constraint for the individual output stream connections
-    @constraint(m, [t ∈ 𝒯, p ∈ 𝒫ᵒᵘᵗ],
+    @constraint(m, [t ∈ 𝒯],
         m[:stor_discharge_use][n, t] == m[:flow_out][n, t, p_stor]
     )
 end

src/structures/data.jl

@@ -11,7 +11,7 @@ Data = ExtensionData
 struct EmptyData <: ExtensionData end
 
 """
-    EmissionsData{T<:Union{TimeProfile,Float64}} <: ExtensionData
+    abstract type EmissionsData{T<:Union{TimeProfile,Float64}} <: ExtensionData
 
 Abstract type for `EmissionsData` can be used to dispatch on different types of
 capture configurations.
@@ -35,9 +35,17 @@ In general, the different types require the following input:
 """
 abstract type EmissionsData{T<:Union{TimeProfile,Float64}} <: ExtensionData end
 """
-    CaptureData{T} <: EmissionsData{T}
+    abstract type CaptureData{T} <: EmissionsData{T}
 
 Supertype for all `EmissionsData` that include CO₂ capture.
+
+# Types
+- **[`CaptureProcessEnergyEmissions`](@ref)**: Capture both the process emissions and the
+  energy usage related emissions.
+- **[`CaptureProcessEmissions`](@ref)**: Capture the process emissions, but not the
+  energy usage related emissions.
+- **[`CaptureEnergyEmissions`](@ref)**: Capture the energy usage related emissions, but not
+  the process emissions. Does not require `emissions` as input.
 """
 abstract type CaptureData{T} <: EmissionsData{T} end
 
@@ -172,14 +180,14 @@ process_emissions(data::EmissionsEnergy{T}, p::ResourceEmit, t) where {T} =
     the function `process_emissions`.")
 
 """
-    InvestmentData <: ExtensionData
+    abstract type InvestmentData <: ExtensionData
 
 Abstract type for the extra data for investing in technologies.
 """
 abstract type InvestmentData <: ExtensionData end
 
 """
-    StorageInvData <: InvestmentData
+    struct StorageInvData <: InvestmentData
 
 Extra investment data for storage investments. The extra investment data for storage
 investments can, but does not require investment data for the charge capacity of the storage
@@ -198,7 +206,7 @@ Hence, the names of the parameters have to be specified.
 abstract type StorageInvData <: InvestmentData end
 
 """
-    SingleInvData <: InvestmentData
+    struct SingleInvData <: InvestmentData
 
 Extra investment data for type investments. The extra investment data has only a single
 field in which `AbstractInvData` has to be added.

src/structures/link.jl

@@ -1,13 +1,22 @@
-""" Declaration of the general type for formulation of links."""
+"""
+    abstract type Formulation
+
+Declaration of the general type for formulation of [`Link`](@ref)s. Formulations can be
+utilized to provide specific constraint functions for a [`Link`](@ref) while keeping other
+constraints unchanged. These subfunctions can be then utlized for several types of `Link`.
+"""
 abstract type Formulation end
 
-""" Linear `Formulation`, that is input equals output."""
+"""
+    struct Linear <: Formulation
+
+Linear `Formulation`, that is input equals output."""
 struct Linear <: Formulation end
 
 """
     abstract type Link <: AbstractElement
 
-Declaration of the general type for links connecting nodes.
+General supertype for links connecting [`Node`](@ref)s.
 """
 abstract type Link <: AbstractElement end
 Base.show(io::IO, l::Link) = print(io, "l_$(l.from)-$(l.to)")

src/structures/misc.jl

@@ -6,7 +6,7 @@ limiting the potential entries to the fields of [`PreviousPeriods`](@ref) and
 NothingPeriod = Union{Nothing,TS.TimePeriod,TS.TimeStructure{T}} where {T}
 
 """
-    PreviousPeriods{S<:NothingPeriod, T<:NothingPeriod, U<:NothingPeriod}
+    struct PreviousPeriods{S<:NothingPeriod, T<:NothingPeriod, U<:NothingPeriod}
 
 Contains the previous strategic, representative, and operational period used through the
 application of the `with_prev` iterator developed in `TimeStruct`.
@@ -42,7 +42,7 @@ Extracts the previous operational period (field `op`) from a [`PreviousPeriods`]
 op_per(prev_periods::PreviousPeriods) = prev_periods.op
 
 """
-    CyclicPeriods{S<:NothingPeriod}
+    struct CyclicPeriods{S<:NothingPeriod}
 
 Contains information for calculating the cyclic constraints. The parameter `S` should be
 either an `AbstractStrategicPeriod` or `AbstractRepresentativePeriod`.

src/structures/model.jl

@@ -1,10 +1,16 @@
-""" Abstract type for differentation between types of models (investment, operational, ...)."""
+"""
+    abstract type EnergyModel
+
+A supertype for differentation between types of models (investment, operational, ...). Its
+main functionality is to provide new methods to the function [`objective`](@ref) and to
+provide global data required in several technologies.
+"""
 abstract type EnergyModel end
 
 """
-    OperationalModel <: EnergyModel
+    struct OperationalModel <: EnergyModel
 
-Operational Energy Model without investments.
+Operational Energy Model without investments. The model does not discount the costs.
 
 # Fields
 - **`emission_limit::Dict{<:ResourceEmit, <:TimeProfile}`** is a dictionary with
@@ -56,7 +62,7 @@ Returns the CO₂ instance used in modelling.
 co2_instance(modeltype::EnergyModel) = modeltype.co2_instance
 
 """
-    AbstractInvestmentModel <: EnergyModel
+    abstract type AbstractInvestmentModel <: EnergyModel
 
 An abstract investment model type.
 
@@ -72,7 +78,7 @@ An example for additional types is given by the inclusion of, *e.g.*, `SDDP`.
 abstract type AbstractInvestmentModel <: EnergyModel end
 
 """
-    InvestmentModel <: AbstractInvestmentModel
+    struct InvestmentModel <: AbstractInvestmentModel
 
 A concrete basic investment model type based on the standard [`OperationalModel`](@ref).
 The concrete basic investment model is similar to an `OperationalModel`, but allows for

src/structures/node.jl

@@ -1,4 +1,8 @@
-""" `Node` as supertype for all technologies."""
+"""
+    abstract type Node <: AbstractElement
+
+A supertype for all technologies that convert a stream to another.
+"""
 abstract type Node <: AbstractElement end
 Base.show(io::IO, n::Node) = print(io, "n_$(n.id)")
 

src/structures/resource.jl

@@ -1,11 +1,13 @@
 """
+    abstract type Resource
+
 General resource supertype to be used for the declaration of subtypes.
 """
 abstract type Resource end
 Base.show(io::IO, r::Resource) = print(io, "$(r.id)")
 
 """
-    ResourceEmit{T<:Real} <: Resource
+    struct ResourceEmit{T<:Real} <: Resource
 
 Resources that can be emitted (*e.g.*, CO₂, CH₄, NOₓ).
 
@@ -22,7 +24,7 @@ struct ResourceEmit{T<:Real} <: Resource
 end
 
 """
-    ResourceCarrier{T<:Real} <: Resource
+    struct ResourceCarrier{T<:Real} <: Resource
 
 Resources that can be transported and converted.
 These resources **cannot** be included as resources that are emitted, *e.g*, in the variable

test/test_deprecation.jl

@@ -1,4 +1,3 @@
-
 @testset "create_model" begin
     """
         simple_graph()

test/test_modeltype.jl

@@ -1,4 +1,3 @@
-
 @testset "Test OperationalModel" begin
 
     # Resources used in the analysis