Start to implement an orchestrator struct that centralizes timestep issues and connector data

Author: Samuel-amap

src/PlantSimEngine.jl

@@ -26,6 +26,7 @@ import Statistics
 import SHA: sha1
 
 using PlantMeteo
+using PlantMeteo.Dates
 
 # UninitializedVar + PreviousTimeStep:
 include("variables_wrappers.jl")
@@ -65,6 +66,9 @@ include("dependencies/printing.jl")
 include("dependencies/dependencies.jl")
 include("dependencies/get_model_in_dependency_graph.jl")
 
+# Timesteps. : 
+include("timestep/timestep_mapping.jl")
+
 # MTG compatibility:
 include("mtg/GraphSimulation.jl")
 include("mtg/mapping/getters.jl")
@@ -103,6 +107,7 @@ include("examples_import.jl")
 export PreviousTimeStep
 export AbstractModel
 export ModelList, MultiScaleModel
+export Orchestrator
 export RMSE, NRMSE, EF, dr
 export Status, TimeStepTable, status
 export init_status!

src/mtg/GraphSimulation.jl

@@ -14,24 +14,23 @@ A type that holds all information for a simulation over a graph.
 - `var_need_init`: a dictionary indicating if a variable needs to be initialized
 - `dependency_graph`: the dependency graph of the models applied to the graph
 - `models`: a dictionary of models
+- `Orchestrator : the structure that handles timestep peculiarities
 - `outputs`: a dictionary of outputs
 """
-struct GraphSimulation{T,S,U,O,V,W}
+struct GraphSimulation{T,S,U,O,V}
     graph::T
     statuses::S
     status_templates::Dict{String,Dict{Symbol,Any}}
     reverse_multiscale_mapping::Dict{String,Dict{String,Dict{Symbol,Any}}}
     var_need_init::Dict{String,V}
     dependency_graph::DependencyGraph
     models::Dict{String,U}
+    orchestrator::Orchestrator
     outputs::Dict{String,O}
-    outputs_index::Dict{String, Int}
-    default_timestep::Int # TODO make it a period ?
-    model_timesteps::Dict{W, Int} #where {W <: AbstractModel}
 end
 
-function GraphSimulation(graph, mapping; nsteps=1, outputs=nothing, type_promotion=nothing, check=true, verbose=false, default_timestep=1, model_timesteps=Dict{String, Int}())
-    GraphSimulation(init_simulation(graph, mapping; nsteps=nsteps, outputs=outputs, type_promotion=type_promotion, check=check, verbose=verbose)..., default_timestep, model_timesteps)
+function GraphSimulation(graph, mapping; nsteps=1, outputs=nothing, type_promotion=nothing, check=true, verbose=false, orchestrator=Orchestrator())
+    GraphSimulation(init_simulation(graph, mapping; nsteps=nsteps, outputs=outputs, type_promotion=type_promotion, check=check, verbose=verbose)..., orchestrator)
 end
 
 dep(g::GraphSimulation) = g.dependency_graph

src/mtg/initialisation.jl

@@ -305,7 +305,7 @@ The value is not a reference to the one in the attribute of the MTG, but a copy
 a value in a Dict. If you need a reference, you can use a `Ref` for your variable in the MTG directly, and it will be 
 automatically passed as is.
 """
-function init_simulation(mtg, mapping; nsteps=1, outputs=nothing, type_promotion=nothing, check=true, verbose=false)
+function init_simulation(mtg, mapping; nsteps=1, outputs=nothing, type_promotion=nothing, check=true, verbose=false, orchestrator=Orchestrator())
 
     # Ensure the user called the model generation function to handle vectors passed into a status
     # before we keep going

src/timestep/timestep_mapping.jl

@@ -0,0 +1,42 @@
+
+# Those names all suck, need to change them
+# Some of them are probably not ideal for new users, too
+
+# Some types can also be constrained a lot more, probably
+
+struct TimestepMapper#{V}
+    variable_from#::V
+    timestep_from::Int
+    mapping_function
+end
+
+struct SimulationTimestepHandler#{W,V}
+    model_timesteps::Dict{Any, Int} # where {W <: AbstractModel} # if a model isn't in there, then it follows the default, todo check if the given timestep respects the model's range
+    timestep_variable_mapping::Dict{Any, TimestepMapper} #where {V}
+end
+
+SimulationTimestepHandler() = SimulationTimestepHandler(Dict(), Dict()) #Dict{W, Int}(), Dict{V, TimestepMapper}()) where {W, V}
+
+mutable struct Orchestrator
+    # This is actually a general simulation parameter, not-scale specific 
+    # todo change to Period
+    default_timestep::Int64
+
+    # This needs to be per-scale : if a model is used at two different scales, 
+    # and the same variable of that model maps to some other timestep to two *different* variables
+    # then I believe we can only rely on the different scale to disambiguate
+    non_default_timestep_data_per_scale::Dict{String, SimulationTimestepHandler}
+
+    function Orchestrator(default::Int64, per_scale::Dict{String, SimulationTimestepHandler})
+        @assert default >= 0 "The default_timestep should be greater than or equal to 0."
+        return new(default, per_scale)
+    end
+end
+
+# TODO have a default constructor take in a meteo or something, and set up the default timestep automagically to be the finest weather timestep
+# Other options are possible
+Orchestrator() = Orchestrator(1, Dict{String, SimulationTimestepHandler}())
+
+
+#o = Orchestrator()
+#oo = Orchestrator(1, Dict{String, SimulationTimestepHandler}())